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.
 
 
 
 
 
 

43572 lines
2.1 MiB

  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>NPOI</name>
  5. </assembly>
  6. <members>
  7. <member name="T:NPOI.DDF.AbstractEscherOptRecord">
  8. Common abstract class for {@link EscherOptRecord} and
  9. {@link EscherTertiaryOptRecord}
  10. @author Sergey Vladimirov (vlsergey {at} gmail {dot} com)
  11. @author Glen Stampoultzis
  12. </member>
  13. <member name="T:NPOI.DDF.EscherRecord">
  14. <summary>
  15. The base abstract record from which all escher records are defined. Subclasses will need
  16. to define methods for serialization/deserialization and for determining the record size.
  17. @author Glen Stampoultzis
  18. </summary>
  19. </member>
  20. <member name="M:NPOI.DDF.EscherRecord.#ctor">
  21. <summary>
  22. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherRecord"/> class.
  23. </summary>
  24. </member>
  25. <member name="M:NPOI.DDF.EscherRecord.FillFields(System.Byte[],NPOI.DDF.IEscherRecordFactory)">
  26. <summary>
  27. Delegates to FillFields(byte[], int, EscherRecordFactory)
  28. </summary>
  29. <param name="data">The data.</param>
  30. <param name="f">The f.</param>
  31. <returns></returns>
  32. </member>
  33. <member name="M:NPOI.DDF.EscherRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  34. <summary>
  35. The contract of this method is to deSerialize an escher record including
  36. it's children.
  37. </summary>
  38. <param name="data">The byte array containing the Serialized escher
  39. records.</param>
  40. <param name="offset">The offset into the byte array.</param>
  41. <param name="recordFactory">A factory for creating new escher records.</param>
  42. <returns>The number of bytes written.</returns>
  43. </member>
  44. <member name="M:NPOI.DDF.EscherRecord.ReadHeader(System.Byte[],System.Int32)">
  45. <summary>
  46. Reads the 8 byte header information and populates the
  47. <c>options</c>
  48. and
  49. <c>recordId</c>
  50. records.
  51. </summary>
  52. <param name="data">the byte array to Read from</param>
  53. <param name="offset">the offset to start Reading from</param>
  54. <returns>the number of bytes remaining in this record. This</returns>
  55. </member>
  56. <member name="M:NPOI.DDF.EscherRecord.ReadInstance(System.Byte[],System.Int32)">
  57. <summary>
  58. Read the options field from header and return instance part of it.
  59. </summary>
  60. <param name="data">the byte array to read from</param>
  61. <param name="offset">the offset to start reading from</param>
  62. <returns>value of instance part of options field</returns>
  63. </member>
  64. <member name="M:NPOI.DDF.EscherRecord.Serialize">
  65. <summary>
  66. Serializes to a new byte array. This is done by delegating to
  67. Serialize(int, byte[]);
  68. </summary>
  69. <returns>the Serialized record.</returns>
  70. </member>
  71. <member name="M:NPOI.DDF.EscherRecord.Serialize(System.Int32,System.Byte[])">
  72. <summary>
  73. Serializes to an existing byte array without serialization listener.
  74. This is done by delegating to Serialize(int, byte[], EscherSerializationListener).
  75. </summary>
  76. <param name="offset">the offset within the data byte array.</param>
  77. <param name="data">the data array to Serialize to.</param>
  78. <returns>The number of bytes written.</returns>
  79. </member>
  80. <member name="M:NPOI.DDF.EscherRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  81. <summary>
  82. Serializes the record to an existing byte array.
  83. </summary>
  84. <param name="offset">the offset within the byte array.</param>
  85. <param name="data">the offset within the byte array</param>
  86. <param name="listener">a listener for begin and end serialization events. This.
  87. is useful because the serialization is
  88. hierarchical/recursive and sometimes you need to be able
  89. break into that.
  90. </param>
  91. <returns></returns>
  92. </member>
  93. <member name="M:NPOI.DDF.EscherRecord.Clone">
  94. <summary>
  95. Creates a new object that is a copy of the current instance.
  96. </summary>
  97. <returns>
  98. A new object that is a copy of this instance.
  99. </returns>
  100. </member>
  101. <member name="M:NPOI.DDF.EscherRecord.GetChild(System.Int32)">
  102. <summary>
  103. Returns the indexed child record.
  104. </summary>
  105. <param name="index">The index.</param>
  106. <returns></returns>
  107. </member>
  108. <member name="M:NPOI.DDF.EscherRecord.Display(System.Int32)">
  109. <summary>
  110. The display methods allows escher variables to print the record names
  111. according to their hierarchy.
  112. </summary>
  113. <param name="indent">The current indent level.</param>
  114. </member>
  115. <member name="M:NPOI.DDF.EscherRecord.ToXml(System.String)">
  116. @param tab - each children must be a right of his parent
  117. @return xml representation of this record
  118. </member>
  119. <member name="P:NPOI.DDF.EscherRecord.IsContainerRecord">
  120. <summary>
  121. Determine whether this is a container record by inspecting the option
  122. field.
  123. </summary>
  124. <value>
  125. <c>true</c> if this instance is container record; otherwise, <c>false</c>.
  126. </value>
  127. </member>
  128. <member name="P:NPOI.DDF.EscherRecord.Options">
  129. <summary>
  130. Gets or sets the options field for this record. All records have one
  131. </summary>
  132. <value>The options.</value>
  133. </member>
  134. <member name="P:NPOI.DDF.EscherRecord.RecordSize">
  135. <summary>
  136. Subclasses should effeciently return the number of bytes required to
  137. Serialize the record.
  138. </summary>
  139. <value>number of bytes</value>
  140. </member>
  141. <member name="P:NPOI.DDF.EscherRecord.RecordId">
  142. <summary>
  143. Return the current record id.
  144. </summary>
  145. <value>The 16 bit record id.</value>
  146. </member>
  147. <member name="P:NPOI.DDF.EscherRecord.ChildRecords">
  148. <summary>
  149. Gets or sets the child records.
  150. </summary>
  151. <value>Returns the children of this record. By default this will
  152. be an empty list. EscherCotainerRecord is the only record that may contain children.</value>
  153. </member>
  154. <member name="P:NPOI.DDF.EscherRecord.RecordName">
  155. <summary>
  156. Gets the name of the record.
  157. </summary>
  158. <value>The name of the record.</value>
  159. </member>
  160. <member name="P:NPOI.DDF.EscherRecord.Instance">
  161. <summary>
  162. Get or set the instance part of the option record.
  163. </summary>
  164. </member>
  165. <member name="P:NPOI.DDF.EscherRecord.Version">
  166. <summary>
  167. Get or set the version part of the option record.
  168. </summary>
  169. </member>
  170. <member name="T:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader">
  171. <summary>
  172. This class Reads the standard escher header.
  173. </summary>
  174. </member>
  175. <member name="M:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.ReadHeader(System.Byte[],System.Int32)">
  176. <summary>
  177. Reads the header.
  178. </summary>
  179. <param name="data">The data.</param>
  180. <param name="offset">The off set.</param>
  181. <returns></returns>
  182. </member>
  183. <member name="M:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.ToString">
  184. <summary>
  185. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  186. </summary>
  187. <returns>
  188. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  189. </returns>
  190. </member>
  191. <member name="P:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.Options">
  192. <summary>
  193. Gets the options.
  194. </summary>
  195. <value>The options.</value>
  196. </member>
  197. <member name="P:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.RecordId">
  198. <summary>
  199. Gets the record id.
  200. </summary>
  201. <value>The record id.</value>
  202. </member>
  203. <member name="P:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.RemainingBytes">
  204. <summary>
  205. Gets the remaining bytes.
  206. </summary>
  207. <value>The remaining bytes.</value>
  208. </member>
  209. <member name="M:NPOI.DDF.AbstractEscherOptRecord.AddEscherProperty(NPOI.DDF.EscherProperty)">
  210. Add a property to this record.
  211. </member>
  212. <member name="M:NPOI.DDF.AbstractEscherOptRecord.GetEscherProperty(System.Int32)">
  213. The list of properties stored by this record.
  214. </member>
  215. <member name="M:NPOI.DDF.AbstractEscherOptRecord.SortProperties">
  216. Records should be sorted by property number before being stored.
  217. </member>
  218. <member name="M:NPOI.DDF.AbstractEscherOptRecord.SetEscherProperty(NPOI.DDF.EscherProperty)">
  219. * Set an escher property. If a property with given propId already
  220. exists it is replaced.
  221. *
  222. * @param value the property to set.
  223. </member>
  224. <member name="M:NPOI.DDF.AbstractEscherOptRecord.ToString">
  225. Retrieve the string representation of this record.
  226. </member>
  227. <member name="P:NPOI.DDF.AbstractEscherOptRecord.EscherProperties">
  228. The list of properties stored by this record.
  229. </member>
  230. <member name="T:NPOI.DDF.SysIndexProcedure">
  231. The following enum specifies values that indicate special procedural properties that
  232. are used to modify the color components of another color. These values are combined with
  233. those of the {@link SysIndexSource} enum or with a user-specified color.
  234. The first six values are mutually exclusive.
  235. </member>
  236. <member name="T:NPOI.DDF.EscherColorRef">
  237. An OfficeArtCOLORREF structure entry which also handles color extension opid data
  238. </member>
  239. <member name="M:NPOI.DDF.EscherColorRef.GetSysIndexSource">
  240. @return {@link SysIndexSource} if {@link #hasSysIndexFlag()} is {@code true}, otherwise null
  241. </member>
  242. <member name="M:NPOI.DDF.EscherColorRef.GetSysIndexProcedure">
  243. Return the {@link SysIndexProcedure} - for invert flag use {@link #getSysIndexInvert()}
  244. @return {@link SysIndexProcedure} if {@link #hasSysIndexFlag()} is {@code true}, otherwise null
  245. </member>
  246. <member name="M:NPOI.DDF.EscherColorRef.GetSysIndexInvert">
  247. @return 0 for no invert flag, 1 for {@link SysIndexProcedure#INVERT_AFTER} and
  248. 2 for {@link SysIndexProcedure#INVERT_HIGHBIT_AFTER}
  249. </member>
  250. <member name="M:NPOI.DDF.EscherColorRef.GetSchemeIndex">
  251. @return index of the scheme color or -1 if {@link #hasSchemeIndexFlag()} is {@code false}
  252. @see NPOI.HSLF.Record.ColorSchemeAtom#getColor(int)
  253. </member>
  254. <member name="M:NPOI.DDF.EscherColorRef.GetPaletteIndex">
  255. @return index of current palette (color) or -1 if {@link #hasPaletteIndexFlag()} is {@code false}
  256. </member>
  257. <member name="T:NPOI.DDF.EscherTertiaryOptRecord">
  258. "The OfficeArtTertiaryFOPT record specifies a table of OfficeArtRGFOPTE properties, as defined in section 2.3.1."
  259. -- [MS-ODRAW] -- v20110608; Office Drawing Binary File Format
  260. @author Sergey Vladimirov (vlsergey {at} gmail {dot} com)
  261. </member>
  262. <member name="T:NPOI.HPSF.HPSFPropertiesOnlyDocument">
  263. A version of {@link POIDocument} which allows access to the
  264. HPSF Properties, but no other document contents.
  265. Normally used when you want to read or alter the Document Properties,
  266. without affecting the rest of the file
  267. </member>
  268. <member name="T:NPOI.POIDocument">
  269. <summary>
  270. This holds the common functionality for all POI
  271. Document classes.
  272. Currently, this relates to Document Information Properties
  273. </summary>
  274. <remarks>@author Nick Burch</remarks>
  275. </member>
  276. <member name="F:NPOI.POIDocument.sInf">
  277. Holds metadata on our document
  278. </member>
  279. <member name="F:NPOI.POIDocument.dsInf">
  280. Holds further metadata on our document
  281. </member>
  282. <member name="F:NPOI.POIDocument.directory">
  283. The directory that our document lives in
  284. </member>
  285. <member name="F:NPOI.POIDocument.initialized">
  286. For our own logging use
  287. </member>
  288. <member name="M:NPOI.POIDocument.#ctor(NPOI.POIFS.FileSystem.DirectoryNode,NPOI.POIFS.FileSystem.POIFSFileSystem)">
  289. <summary>
  290. Initializes a new instance of the <see cref="T:NPOI.POIDocument"/> class.
  291. </summary>
  292. <param name="dir">The dir.</param>
  293. <param name="fs">The fs.</param>
  294. </member>
  295. <member name="M:NPOI.POIDocument.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  296. <summary>
  297. Initializes a new instance of the <see cref="T:NPOI.POIDocument"/> class.
  298. </summary>
  299. <param name="fs">The fs.</param>
  300. </member>
  301. <member name="M:NPOI.POIDocument.CreateInformationProperties">
  302. Will create whichever of SummaryInformation
  303. and DocumentSummaryInformation (HPSF) properties
  304. are not already part of your document.
  305. This is normally useful when creating a new
  306. document from scratch.
  307. If the information properties are already there,
  308. then nothing will happen.
  309. </member>
  310. <member name="M:NPOI.POIDocument.ReadProperties">
  311. <summary>
  312. Find, and Create objects for, the standard
  313. Documment Information Properties (HPSF).
  314. If a given property Set is missing or corrupt,
  315. it will remain null;
  316. </summary>
  317. </member>
  318. <member name="M:NPOI.POIDocument.GetPropertySet(System.String)">
  319. <summary>
  320. For a given named property entry, either return it or null if
  321. if it wasn't found
  322. </summary>
  323. <param name="setName">Name of the set.</param>
  324. <returns></returns>
  325. </member>
  326. <member name="M:NPOI.POIDocument.WriteProperties(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  327. <summary>
  328. Writes out the standard Documment Information Properties (HPSF)
  329. </summary>
  330. <param name="outFS">the POIFSFileSystem to Write the properties into</param>
  331. </member>
  332. <member name="M:NPOI.POIDocument.WriteProperties(NPOI.POIFS.FileSystem.POIFSFileSystem,System.Collections.IList)">
  333. <summary>
  334. Writes out the standard Documment Information Properties (HPSF)
  335. </summary>
  336. <param name="outFS">the POIFSFileSystem to Write the properties into.</param>
  337. <param name="writtenEntries">a list of POIFS entries to Add the property names too.</param>
  338. </member>
  339. <member name="M:NPOI.POIDocument.WritePropertySet(System.String,NPOI.HPSF.PropertySet,NPOI.POIFS.FileSystem.POIFSFileSystem)">
  340. <summary>
  341. Writes out a given ProperySet
  342. </summary>
  343. <param name="name">the (POIFS Level) name of the property to Write.</param>
  344. <param name="Set">the PropertySet to Write out.</param>
  345. <param name="outFS">the POIFSFileSystem to Write the property into.</param>
  346. </member>
  347. <member name="M:NPOI.POIDocument.Write(System.IO.Stream)">
  348. <summary>
  349. Writes the document out to the specified output stream
  350. </summary>
  351. <param name="out1">The out1.</param>
  352. </member>
  353. <member name="M:NPOI.POIDocument.CopyNodes(NPOI.POIFS.FileSystem.POIFSFileSystem,NPOI.POIFS.FileSystem.POIFSFileSystem,System.Collections.Generic.List{System.String})">
  354. <summary>
  355. Copies nodes from one POIFS to the other minus the excepts
  356. </summary>
  357. <param name="source">the source POIFS to copy from.</param>
  358. <param name="target">the target POIFS to copy to</param>
  359. <param name="excepts">a list of Strings specifying what nodes NOT to copy</param>
  360. </member>
  361. <member name="M:NPOI.POIDocument.CopyNodes(NPOI.POIFS.FileSystem.DirectoryNode,NPOI.POIFS.FileSystem.DirectoryNode,System.Collections.Generic.List{System.String})">
  362. <summary>
  363. Copies nodes from one POIFS to the other minus the excepts
  364. </summary>
  365. <param name="sourceRoot">the source POIFS to copy from.</param>
  366. <param name="targetRoot">the target POIFS to copy to</param>
  367. <param name="excepts">a list of Strings specifying what nodes NOT to copy</param>
  368. </member>
  369. <member name="M:NPOI.POIDocument.isInList(System.String,System.Collections.IList)">
  370. <summary>
  371. Checks to see if the String is in the list, used when copying
  372. nodes between one POIFS and another
  373. </summary>
  374. <param name="entry">The entry.</param>
  375. <param name="list">The list.</param>
  376. <returns>
  377. <c>true</c> if [is in list] [the specified entry]; otherwise, <c>false</c>.
  378. </returns>
  379. </member>
  380. <member name="M:NPOI.POIDocument.CopyNodeRecursively(NPOI.POIFS.FileSystem.Entry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  381. <summary>
  382. Copies an Entry into a target POIFS directory, recursively
  383. </summary>
  384. <param name="entry">The entry.</param>
  385. <param name="target">The target.</param>
  386. </member>
  387. <member name="P:NPOI.POIDocument.DocumentSummaryInformation">
  388. <summary>
  389. Fetch the Document Summary Information of the document
  390. </summary>
  391. <value>The document summary information.</value>
  392. </member>
  393. <member name="P:NPOI.POIDocument.SummaryInformation">
  394. <summary>
  395. Fetch the Summary Information of the document
  396. </summary>
  397. <value>The summary information.</value>
  398. </member>
  399. <member name="M:NPOI.HPSF.HPSFPropertiesOnlyDocument.Write(System.IO.Stream)">
  400. Write out, with any properties changes, but nothing else
  401. </member>
  402. <member name="M:NPOI.HPSF.UnicodeString.validLength(System.Int32,System.Byte[],System.Int32)">
  403. Checks to see if the specified length seems valid,
  404. given the amount of data available still to read,
  405. and the requirement that the string be NULL-terminated
  406. </member>
  407. <member name="T:NPOI.HPSF.UnsupportedEncodingException">
  408. The Character Encoding is not supported.
  409. @author Asmus Freytag
  410. @since JDK1.1
  411. </member>
  412. <member name="M:NPOI.HPSF.UnsupportedEncodingException.#ctor">
  413. Constructs an UnsupportedEncodingException without a detail message.
  414. </member>
  415. <member name="M:NPOI.HPSF.UnsupportedEncodingException.#ctor(System.String)">
  416. Constructs an UnsupportedEncodingException with a detail message.
  417. @param s Describes the reason for the exception.
  418. </member>
  419. <member name="T:NPOI.HSSF.Extractor.OldExcelExtractor">
  420. A text extractor for old Excel files, which are too old for
  421. HSSFWorkbook to handle. This includes Excel 95, and very old
  422. (pre-OLE2) Excel files, such as Excel 4 files.
  423. <p>
  424. Returns much (but not all) of the textual content of the file,
  425. suitable for indexing by something like Apache Lucene, or used
  426. by Apache Tika, but not really intended for display to the user.
  427. </p>
  428. </member>
  429. <member name="P:NPOI.HSSF.Extractor.OldExcelExtractor.BiffVersion">
  430. The Biff version, largely corresponding to the Excel version
  431. </member>
  432. <member name="P:NPOI.HSSF.Extractor.OldExcelExtractor.FileType">
  433. The kind of the file, one of {@link BOFRecord#TYPE_WORKSHEET},
  434. {@link BOFRecord#TYPE_CHART}, {@link BOFRecord#TYPE_EXCEL_4_MACRO}
  435. or {@link BOFRecord#TYPE_WORKSPACE_FILE}
  436. </member>
  437. <member name="P:NPOI.HSSF.Extractor.OldExcelExtractor.Text">
  438. Retrieves the text contents of the file, as best we can
  439. for these old file formats
  440. </member>
  441. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AttachedLabelAggregate">
  442. <summary>
  443. ATTACHEDLABEL = Text Begin Pos [FontX] [AlRuns] AI [FRAME] [ObjectLink] [DataLabExtContents] [CrtLayout12] [TEXTPROPS] [CRTMLFRT] End
  444. AI = BRAI [SeriesText]
  445. </summary>
  446. </member>
  447. <member name="T:NPOI.HSSF.Record.Aggregates.RecordAggregate">
  448. <c>RecordAggregate</c>s are groups of of BIFF <c>Record</c>s that are typically stored
  449. together and/or updated together. Workbook / Sheet records are typically stored in a sequential
  450. list, which does not provide much structure to coordinate updates.
  451. @author Josh Micich
  452. </member>
  453. <member name="T:NPOI.HSSF.Record.RecordBase">
  454. Common base class of {@link Record} and {@link RecordAggregate}
  455. @author Josh Micich
  456. </member>
  457. <member name="M:NPOI.HSSF.Record.RecordBase.Serialize(System.Int32,System.Byte[])">
  458. called by the class that is responsible for writing this sucker.
  459. Subclasses should implement this so that their data is passed back in a
  460. byte array.
  461. @param offset to begin writing at
  462. @param data byte array containing instance data
  463. @return number of bytes written
  464. </member>
  465. <member name="P:NPOI.HSSF.Record.RecordBase.RecordSize">
  466. gives the current serialized size of the record. Should include the sid
  467. and reclength (4 bytes).
  468. </member>
  469. <member name="M:NPOI.HSSF.Record.Aggregates.RecordAggregate.VisitContainedRecords(NPOI.HSSF.Record.Aggregates.RecordVisitor)">
  470. Visit each of the atomic BIFF records contained in this {@link RecordAggregate} in the order
  471. that they should be written to file. Implementors may or may not return the actual
  472. {@link Record}s being used to manage POI's internal implementation. Callers should not
  473. assume either way, and therefore only attempt to modify those {@link Record}s after cloning
  474. </member>
  475. <member name="M:NPOI.HSSF.Record.Aggregates.RecordVisitor.VisitRecord(NPOI.HSSF.Record.Record)">
  476. Implementors may call non-mutating methods on Record r.
  477. @param r must not be <c>null</c>
  478. </member>
  479. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AxesAggregate">
  480. <summary>
  481. AXES = [IVAXIS DVAXIS [SERIESAXIS] / DVAXIS DVAXIS] *3ATTACHEDLABEL [PlotArea FRAME]
  482. </summary>
  483. </member>
  484. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AxisParentAggregate">
  485. <summary>
  486. AXISPARENT = AxisParent Begin Pos [AXES] 1*4CRT End
  487. </summary>
  488. </member>
  489. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AXMAggregate">
  490. <summary>
  491. AXM = YMult StartObject ATTACHEDLABEL EndObject
  492. </summary>
  493. </member>
  494. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AXSAggregate">
  495. <summary>
  496. AXS = [IFmtRecord] [Tick] [FontX] *4(AxisLine LineFormat) [AreaFormat]
  497. [GELFRAME] *4SHAPEPROPS [TextPropsStream *ContinueFrt12]
  498. </summary>
  499. </member>
  500. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.ChartFormatsAggregate">
  501. <summary>
  502. CHARTFOMATS = Chart Begin *2FONTLIST Scl PlotGrowth [FRAME] *SERIESFORMAT *SS ShtProps
  503. *2DFTTEXT AxesUsed 1*2AXISPARENT [CrtLayout12A] [DAT] *ATTACHEDLABEL [CRTMLFRT]
  504. *([DataLabExt StartObject] ATTACHEDLABEL [EndObject]) [TEXTPROPS] *2CRTMLFRT End
  505. </summary>
  506. </member>
  507. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.ChartSheetAggregate">
  508. <summary>
  509. CHARTSHEET = BOF CHARTSHEETCONTENT
  510. CHARTSHEETCONTENT = [WriteProtect] [SheetExt] [WebPub] *HFPicture PAGESETUP PrintSize
  511. [HeaderFooter] [BACKGROUND] *Fbi *Fbi2 [ClrtClient] [PROTECTION] [Palette] [SXViewLink]
  512. [PivotChartBits] [SBaseRef] [MsoDrawingGroup] OBJECTS Units CHARTFOMATS SERIESDATA
  513. *WINDOW *CUSTOMVIEW [CodeName] [CRTMLFRT] EOF
  514. </summary>
  515. </member>
  516. <member name="F:NPOI.HSSF.Record.Aggregates.Chart.ChartSheetAggregate._recs">
  517. All the records between BOF and EOF
  518. </member>
  519. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.CRTAggregate">
  520. <summary>
  521. CRT = ChartFormat Begin (Bar / Line / (BopPop [BopPopCustom]) / Pie / Area / Scatter / Radar /
  522. RadarArea / Surf) CrtLink [SeriesList] [Chart3d] [LD] [2DROPBAR] *4(CrtLine LineFormat)
  523. *2DFTTEXT [DataLabExtContents] [SS] *4SHAPEPROPS End
  524. </summary>
  525. </member>
  526. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.CrtMlFrtAggregate">
  527. <summary>
  528. CRTMLFRT = CrtMlFrt *CrtMlFrtContinue
  529. </summary>
  530. </member>
  531. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.DatAggregate">
  532. <summary>
  533. DAT = Dat Begin LD End
  534. </summary>
  535. </member>
  536. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.DFTTextAggregate">
  537. <summary>
  538. DFTTEXT = [DataLabExt StartObject] DefaultText ATTACHEDLABEL [EndObject]
  539. </summary>
  540. </member>
  541. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.DropBarAggregate">
  542. <summary>
  543. DROPBAR = DropBar Begin LineFormat AreaFormat [GELFRAME] [SHAPEPROPS] End
  544. </summary>
  545. </member>
  546. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.DVAxisAggregate">
  547. <summary>
  548. DVAXIS = Axis Begin [ValueRange] [AXM] AXS [CRTMLFRT] End
  549. </summary>
  550. </member>
  551. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.FontListAggregate">
  552. <summary>
  553. FONTLIST = FrtFontList StartObject *(Font [Fbi]) EndObject
  554. </summary>
  555. </member>
  556. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.FrameAggregate">
  557. <summary>
  558. FRAME = Frame Begin LineFormat AreaFormat [GELFRAME] [SHAPEPROPS] End
  559. </summary>
  560. </member>
  561. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.GelFrameAggregate">
  562. <summary>
  563. GELFRAME = 1*2GelFrame *Continue [PICF]
  564. PICF = Begin PicF End
  565. </summary>
  566. </member>
  567. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.IVAxisAggregate">
  568. <summary>
  569. IVAXIS = Axis Begin [CatSerRange] AxcExt [CatLab] AXS [CRTMLFRT] End
  570. </summary>
  571. </member>
  572. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.LDAggregate">
  573. <summary>
  574. LD = Legend Begin Pos ATTACHEDLABEL [FRAME] [CrtLayout12] [TEXTPROPS] [CRTMLFRT] End
  575. </summary>
  576. </member>
  577. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SeriesAxisAggregate">
  578. <summary>
  579. SERIESAXIS = Axis Begin [CatSerRange] AXS [CRTMLFRT] End
  580. </summary>
  581. </member>
  582. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SeriesDataAggregate">
  583. <summary>
  584. SERIESDATA = Dimensions 3(SIIndex *(Number / BoolErr / Blank / Label))
  585. </summary>
  586. </member>
  587. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SeriesFormatAggregate">
  588. <summary>
  589. SERIESFORMAT = Series Begin 4AI *SS (SerToCrt / (SerParent (SerAuxTrend / SerAuxErrBar)))
  590. *(LegendException [Begin ATTACHEDLABEL [TEXTPROPS] End]) End
  591. </summary>
  592. </member>
  593. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SeriesFormatAggregate.LegendExceptionAggregate">
  594. <summary>
  595. LegendException [Begin ATTACHEDLABEL [TEXTPROPS] End]
  596. </summary>
  597. </member>
  598. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.ShapePropsAggregate">
  599. <summary>
  600. SHAPEPROPS = ShapePropsStream *ContinueFrt12
  601. </summary>
  602. </member>
  603. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SSAggregate">
  604. <summary>
  605. SS = DataFormat Begin [Chart3DBarShape] [LineFormat AreaFormat PieFormat] [SerFmt]
  606. [GELFRAME] [MarkerFormat] [AttachedLabel] *2SHAPEPROPS [CRTMLFRT] End
  607. </summary>
  608. </member>
  609. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.TextPropsAggregate">
  610. <summary>
  611. TEXTPROPS = (RichTextStream / TextPropsStream) *ContinueFrt12
  612. </summary>
  613. </member>
  614. <member name="T:NPOI.HSSF.Record.Chart.AlRunsRecord">
  615. <summary>
  616. The AlRuns record specifies Rich Text Formatting within chart
  617. titles (section 2.2.3.3), trendline (section 2.2.3.12), and
  618. data labels (section 2.2.3.11).
  619. </summary>
  620. </member>
  621. <member name="T:NPOI.HSSF.Record.StandardRecord">
  622. Subclasses of this class (the majority of BIFF records) are non-continuable. This allows for
  623. some simplification of serialization logic
  624. @author Josh Micich
  625. </member>
  626. <member name="T:NPOI.HSSF.Record.Record">
  627. Title: Record
  628. Description: All HSSF Records inherit from this class. It
  629. populates the fields common to all records (id, size and data).
  630. Subclasses should be sure to validate the id,
  631. Company:
  632. @author Andrew C. Oliver
  633. @author Marc Johnson (mjohnson at apache dot org)
  634. @author Jason Height (jheight at chariot dot net dot au)
  635. @version 2.0-pre
  636. </member>
  637. <member name="M:NPOI.HSSF.Record.Record.#ctor">
  638. instantiates a blank record strictly for ID matching
  639. </member>
  640. <member name="M:NPOI.HSSF.Record.Record.Serialize">
  641. called by the class that is responsible for writing this sucker.
  642. Subclasses should implement this so that their data is passed back in a
  643. byte array.
  644. @return byte array containing instance data
  645. </member>
  646. <member name="P:NPOI.HSSF.Record.Record.Sid">
  647. return the non static version of the id for this record.
  648. </member>
  649. <member name="M:NPOI.HSSF.Record.StandardRecord.Serialize(System.Int32,System.Byte[])">
  650. <summary>
  651. Write the data content of this BIFF record including the sid and record length.
  652. The subclass must write the exact number of bytes as reported by Record#getRecordSize()
  653. </summary>
  654. <param name="offset">offset</param>
  655. <param name="data">data</param>
  656. <returns></returns>
  657. </member>
  658. <member name="M:NPOI.HSSF.Record.StandardRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  659. Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields
  660. have already been written by the superclass.<br/>
  661. The number of bytes written must equal the record size reported by
  662. {@link Record#getDataSize()} minus four
  663. ( record header consiting of a 'ushort sid' and 'ushort reclength' has already been written
  664. by thye superclass).
  665. </member>
  666. <member name="T:NPOI.HSSF.Record.Chart.AttachedLabelRecord">
  667. * The series label record defines the type of label associated with the data format record.
  668. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  669. * Remove the record in src/records/definitions.
  670. * @author Glen Stampoultzis (glens at apache.org)
  671. </member>
  672. <member name="M:NPOI.HSSF.Record.Chart.AttachedLabelRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  673. Constructs a SeriesLabels record and Sets its fields appropriately.
  674. @param in the RecordInputstream to Read the record from
  675. </member>
  676. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.DataSize">
  677. Size of record (exluding 4 byte header)
  678. </member>
  679. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.FormatFlags">
  680. Get the format flags field for the SeriesLabels record.
  681. </member>
  682. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsShowActual">
  683. show actual value of the data point
  684. @return the show actual field value.
  685. </member>
  686. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsShowPercent">
  687. show value as percentage of total (pie charts only)
  688. @return the show percent field value.
  689. </member>
  690. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsLabelAsPercentage">
  691. show category label/value as percentage (pie charts only)
  692. @return the label as percentage field value.
  693. </member>
  694. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsSmoothedLine">
  695. show smooth line
  696. @return the smoothed line field value.
  697. </member>
  698. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsShowLabel">
  699. Display category label
  700. @return the show label field value.
  701. </member>
  702. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsShowBubbleSizes">
  703. ??
  704. @return the show bubble sizes field value.
  705. </member>
  706. <member name="T:NPOI.HSSF.Record.Chart.AxcExtRecord">
  707. <summary>
  708. The AxcExt record specifies additional extension properties of a date axis (section 2.2.3.6),
  709. along with a CatSerRange record (section 2.4.39).
  710. </summary>
  711. </member>
  712. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.MajorInterval">
  713. <summary>
  714. specifies the interval at which the major tick marks are displayed on the axis (section 2.2.3.6),
  715. in the unit defined by duMajor.
  716. </summary>
  717. </member>
  718. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.MajorUnit">
  719. <summary>
  720. specifies the unit of time to use for catMajor when the axis (section 2.2.3.6) is a date axis (section 2.2.3.6).
  721. If fDateAxis is set to 0, MUST be ignored.
  722. </summary>
  723. </member>
  724. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.MinorInterval">
  725. <summary>
  726. specifies the interval at which the minor tick marks are displayed on the axis (section 2.2.3.6),
  727. in a unit defined by duMinor.
  728. </summary>
  729. </member>
  730. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.BaseUnit">
  731. <summary>
  732. specifies the smallest unit of time used by the axis (section 2.2.3.6).
  733. </summary>
  734. </member>
  735. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.CrossDate">
  736. <summary>
  737. specifies at which date, as a date in the date system specified by the Date1904 record (section 2.4.77),
  738. in the units defined by duBase, the value axis (section 2.2.3.6) crosses this axis (section 2.2.3.6).
  739. </summary>
  740. </member>
  741. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.IsAutoMin">
  742. <summary>
  743. specifies whether MinimumDate is calculated automatically.
  744. </summary>
  745. </member>
  746. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.IsAutoMax">
  747. <summary>
  748. specifies whether MaximumDate is calculated automatically.
  749. </summary>
  750. </member>
  751. <member name="T:NPOI.HSSF.Record.Chart.AxesUsedRecord">
  752. * The number of axes used on a chart.
  753. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  754. * Remove the record in src/records/definitions.
  755. * @author Glen Stampoultzis (glens at apache.org)
  756. </member>
  757. <member name="M:NPOI.HSSF.Record.Chart.AxesUsedRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  758. Constructs a AxisUsed record and Sets its fields appropriately.
  759. @param in the RecordInputstream to Read the record from
  760. </member>
  761. <member name="P:NPOI.HSSF.Record.Chart.AxesUsedRecord.DataSize">
  762. Size of record (exluding 4 byte header)
  763. </member>
  764. <member name="P:NPOI.HSSF.Record.Chart.AxesUsedRecord.NumAxis">
  765. Get the num axis field for the AxisUsed record.
  766. </member>
  767. <member name="F:NPOI.HSSF.Record.Chart.AxisLineType.AxisLine">
  768. <summary>
  769. The axis (section 2.2.3.6) line itself.
  770. </summary>
  771. </member>
  772. <member name="F:NPOI.HSSF.Record.Chart.AxisLineType.MajorGridLine">
  773. <summary>
  774. The major gridlines along the axis
  775. </summary>
  776. </member>
  777. <member name="F:NPOI.HSSF.Record.Chart.AxisLineType.MinorGridLine">
  778. <summary>
  779. The minor gridlines along the axis
  780. </summary>
  781. </member>
  782. <member name="F:NPOI.HSSF.Record.Chart.AxisLineType.WallsOrFloorOf3D">
  783. <summary>
  784. The walls or floor of a 3-D chart
  785. </summary>
  786. </member>
  787. <member name="T:NPOI.HSSF.Record.Chart.AxisLineRecord">
  788. <summary>
  789. The AxisLine record specifies which part of the axis (section 2.2.3.6) is
  790. specified by the LineFormat record (section 2.4.156) that follows.
  791. Excel Binary File Format (.xls) Structure Specification
  792. </summary>
  793. </member>
  794. <member name="M:NPOI.HSSF.Record.Chart.AxisLineRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  795. Constructs a AxisLineFormat record and Sets its fields appropriately.
  796. @param in the RecordInputstream to Read the record from
  797. </member>
  798. <member name="P:NPOI.HSSF.Record.Chart.AxisLineRecord.DataSize">
  799. Size of record (exluding 4 byte header)
  800. </member>
  801. <member name="P:NPOI.HSSF.Record.Chart.AxisLineRecord.AxisType">
  802. <summary>
  803. </summary>
  804. </member>
  805. <member name="T:NPOI.HSSF.Record.Chart.BopPopCustomRecord">
  806. <summary>
  807. The BopPopCustom record specifies which data points in the series are contained
  808. in the secondary bar/pie instead of the primary pie. MUST follow a BopPop record
  809. that has its split field set to Custom (0x0003).
  810. </summary>
  811. <remarks>
  812. author: Antony liu (antony.apollo at gmail.com)
  813. </remarks>
  814. </member>
  815. <member name="T:NPOI.HSSF.Record.RowDataRecord">
  816. <summary>
  817. this record only used for record that has name and not implemented.
  818. </summary>
  819. </member>
  820. <member name="T:NPOI.HSSF.Record.Chart.BopPopRecord">
  821. <summary>
  822. The BopPop record specifies that the chart group is a bar of pie chart group or
  823. a pie of pie chart group and specifies the chart group attributes.
  824. </summary>
  825. <remarks>
  826. author: Antony liu (antony.apollo at gmail.com)
  827. </remarks>
  828. </member>
  829. <member name="T:NPOI.HSSF.Record.Chart.BRAIRecord">
  830. <summary>
  831. The BRAI record specifies a reference to data in a sheet (1) that is used by a part of a series,
  832. legend entry, trendline or error bars.
  833. </summary>
  834. </member>
  835. <member name="F:NPOI.HSSF.Record.Chart.BRAIRecord.field_5_formulaOfLink">
  836. <summary>
  837. A ChartParsedFormula structure that specifies the formula (section 2.2.2) that specifies the reference.
  838. </summary>
  839. </member>
  840. <member name="M:NPOI.HSSF.Record.Chart.BRAIRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  841. Constructs a LinkedData record and Sets its fields appropriately.
  842. @param in the RecordInputstream to Read the record from
  843. </member>
  844. <member name="P:NPOI.HSSF.Record.Chart.BRAIRecord.DataSize">
  845. Size of record (exluding 4 byte header)
  846. </member>
  847. <member name="P:NPOI.HSSF.Record.Chart.BRAIRecord.LinkType">
  848. <summary>
  849. specifies the part of the series, trendline, or error bars the referenced data specifies.
  850. </summary>
  851. </member>
  852. <member name="P:NPOI.HSSF.Record.Chart.BRAIRecord.IndexNumberFmtRecord">
  853. <summary>
  854. specifies the number format to use for the data.
  855. </summary>
  856. </member>
  857. <member name="T:NPOI.HSSF.Record.Chart.CatSerRangeRecord">
  858. <summary>
  859. specifies the properties of a category (3) axis, a date axis, or a series axis.
  860. </summary>
  861. </member>
  862. <member name="M:NPOI.HSSF.Record.Chart.CatSerRangeRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  863. Constructs a CategorySeriesAxis record and Sets its fields appropriately.
  864. @param in the RecordInputstream to Read the record from
  865. </member>
  866. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.DataSize">
  867. Size of record (exluding 4 byte header)
  868. </member>
  869. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.CrossPoint">
  870. <summary>
  871. specifies where the value axis crosses this axis, based on the following table.
  872. If fMaxCross is set to 1, the value this field MUST be ignored.
  873. Category (3) axis This field specifies the category (3) at which the value axis crosses.
  874. For example, if this field is 2, the value axis crosses this axis at the second category (3)
  875. on this axis. MUST be greater than or equal to 1 and less than or equal to 31999.
  876. Series axis MUST be 0.
  877. Date axis catCross MUST be equal to the value given by the following formula:
  878. catCross = catCrossDate – catMin + 1
  879. Where catCrossDate is the catCrossDate field of the AxcExt record
  880. and catMin is the catMin field of the AxcExt record.
  881. </summary>
  882. </member>
  883. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.LabelInterval">
  884. <summary>
  885. specifies the interval between axis labels on this axis. MUST be greater than or equal to 1 and
  886. less than or equal to 31999. MUST be ignored for a date axis.
  887. </summary>
  888. </member>
  889. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.MarkInterval">
  890. <summary>
  891. specifies the interval at which major tick marks and minor tick marks are displayed on the axis.
  892. Major tick marks and minor tick marks that would have been visible are hidden unless they are
  893. located at a multiple of this field.
  894. </summary>
  895. </member>
  896. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.IsBetween">
  897. <summary>
  898. specifies whether the value axis crosses this axis between major tick marks. MUST be a value from to following table:
  899. 0 The value axis crosses this axis on a major tick mark.
  900. 1 The value axis crosses this axis between major tick marks.
  901. </summary>
  902. </member>
  903. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.IsMaxCross">
  904. <summary>
  905. specifies whether the value axis crosses this axis at the last category (3), the last series,
  906. or the maximum date. MUST be a value from the following table:
  907. 0 The value axis crosses this axis at the value specified by catCross.
  908. 1 The value axis crosses this axis at the last category (3), the last series, or the maximum date.
  909. </summary>
  910. </member>
  911. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.IsReverse">
  912. <summary>
  913. specifies whether the axis is displayed in reverse order. MUST be a value from the following table:
  914. 0 The axis is displayed in order.
  915. 1 The axis is display in reverse order.
  916. </summary>
  917. </member>
  918. <member name="P:NPOI.HSSF.Record.Chart.Chart3DBarShapeRecord.Riser">
  919. <summary>
  920. the shape of the base of the data points in a bar or column chart group.
  921. MUST be a value from the following table
  922. 0x00 The base of the data point is a rectangle.
  923. 0x01 The base of the data point is an ellipse.
  924. </summary>
  925. </member>
  926. <member name="P:NPOI.HSSF.Record.Chart.Chart3DBarShapeRecord.Taper">
  927. <summary>
  928. how the data points in a bar or column chart group taper from base to tip.
  929. MUST be a value from the following
  930. 0x00 The data points of the bar or column chart group do not taper.
  931. The shape at the maximum value of the data point is the same as the shape at the base.:
  932. 0x01 The data points of the bar or column chart group taper to a point at the maximum value of each data point.
  933. 0x02 The data points of the bar or column chart group taper towards a projected point at the position of
  934. the maximum value of all of the data points in the chart group, but are clipped at the value of each data point.
  935. </summary>
  936. </member>
  937. <member name="T:NPOI.HSSF.Record.Chart.CrtLineRecord">
  938. <summary>
  939. The CrtLine record specifies the presence of drop lines, high-low lines, series lines
  940. or leader lines on the chart group. This record is followed by a LineFormat record
  941. which specifies the format of the lines.
  942. </summary>
  943. <remarks>
  944. author: Antony liu (antony.apollo at gmail.com)
  945. </remarks>
  946. </member>
  947. <member name="T:NPOI.HSSF.Record.Chart.CrtMlFrtContinueRecord">
  948. <summary>
  949. The CrtMlFrtContinue record specifies additional data for a CrtMlFrt record, as specified in the CrtMlFrt record.
  950. </summary>
  951. <remarks>
  952. author: Antony liu (antony.apollo at gmail.com)
  953. </remarks>
  954. </member>
  955. <member name="T:NPOI.HSSF.Record.Chart.DataLabExtContentsRecord">
  956. <summary>
  957. The DataLabExtContents record specifies the contents of an extended data label.
  958. </summary>
  959. </member>
  960. <member name="T:NPOI.HSSF.Record.Chart.DataLabExtRecord">
  961. DATALABEXT - Chart Data Label Extension (0x086A) <br/>
  962. @author Patrick Cheng
  963. </member>
  964. <member name="T:NPOI.HSSF.Record.Chart.TextFormatInfo">
  965. <summary>
  966. specifies the text elements that are formatted using the position and appearance information
  967. specified by the Text record immediately following this record.
  968. </summary>
  969. </member>
  970. <member name="F:NPOI.HSSF.Record.Chart.TextFormatInfo.ShowPercentOrValueNotSet">
  971. <summary>
  972. Format all Text records in the chart group where fShowPercent is equal to 0 or fShowValue is equal to 0.
  973. </summary>
  974. </member>
  975. <member name="F:NPOI.HSSF.Record.Chart.TextFormatInfo.ShowPercentOrValueSet">
  976. <summary>
  977. Format all Text records in the chart group where fShowPercent is equal to 1 or fShowValue is equal to 1.
  978. </summary>
  979. </member>
  980. <member name="F:NPOI.HSSF.Record.Chart.TextFormatInfo.FontScaleNotSet">
  981. <summary>
  982. Format all Text records in the chart where the value of fScaled of the associated FontInfo structure is equal to 0.
  983. </summary>
  984. </member>
  985. <member name="F:NPOI.HSSF.Record.Chart.TextFormatInfo.FontScaleSet">
  986. <summary>
  987. Format all Text records in the chart where the value of fScaled of the associated FontInfo structure is equal to 1.
  988. </summary>
  989. </member>
  990. <member name="T:NPOI.HSSF.Record.Chart.DefaultTextRecord">
  991. <summary>
  992. specifies the text elements that are formatted using the information specified by
  993. the Text record immediately following this record.
  994. </summary>
  995. </member>
  996. <member name="M:NPOI.HSSF.Record.Chart.DefaultTextRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  997. Constructs a DefaultDataLabelTextProperties record and Sets its fields appropriately.
  998. @param in the RecordInputstream to Read the record from
  999. </member>
  1000. <member name="P:NPOI.HSSF.Record.Chart.DefaultTextRecord.DataSize">
  1001. Size of record (exluding 4 byte header)
  1002. </member>
  1003. <member name="P:NPOI.HSSF.Record.Chart.DefaultTextRecord.FormatType">
  1004. <summary>
  1005. specifies the text elements that are formatted using the position and appearance
  1006. information specified by the Text record immediately following this record.
  1007. </summary>
  1008. </member>
  1009. <member name="T:NPOI.HSSF.Record.Chart.DropBarRecord">
  1010. <summary>
  1011. The DropBar record specifies the attributes of the up bars or the down bars between multiple
  1012. series of a line chart group and specifies the beginning of a collection of records as
  1013. defined by the Chart Sheet Substream ABNF. The first of these collections in the line chart
  1014. group specifies the attributes of the up bars. The second specifies the attributes of the
  1015. down bars. If this record exists, then the chart group type MUST be line and the field cSer
  1016. in the record SeriesList MUST be greater than 1.
  1017. </summary>
  1018. <remarks>
  1019. author: Antony liu (antony.apollo at gmail.com)
  1020. </remarks>
  1021. </member>
  1022. <member name="T:NPOI.HSSF.Record.Chart.EndBlockRecord">
  1023. ENDBLOCK - Chart Future Record Type End Block (0x0853)<br/>
  1024. @author Patrick Cheng
  1025. </member>
  1026. <member name="T:NPOI.HSSF.Record.Chart.Fbi2Record">
  1027. <summary>
  1028. The Fbi2 record specifies the font information at the time the scalable font is added to the chart.
  1029. </summary>
  1030. <remarks>
  1031. author: Antony liu (antony.apollo at gmail.com)
  1032. </remarks>
  1033. </member>
  1034. <member name="T:NPOI.HSSF.Record.Chart.FbiRecord">
  1035. <summary>
  1036. The Fbi record specifies the font information at the time the scalable font is added to the chart.
  1037. </summary>
  1038. </member>
  1039. <member name="M:NPOI.HSSF.Record.Chart.FbiRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  1040. Constructs a FontBasis record and Sets its fields appropriately.
  1041. @param in the RecordInputstream to Read the record from
  1042. </member>
  1043. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.DataSize">
  1044. Size of record (exluding 4 byte header)
  1045. </member>
  1046. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.XBasis">
  1047. Get the x Basis field for the FontBasis record.
  1048. </member>
  1049. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.YBasis">
  1050. Get the y Basis field for the FontBasis record.
  1051. </member>
  1052. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.HeightBasis">
  1053. Get the height basis field for the FontBasis record.
  1054. </member>
  1055. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.Scale">
  1056. Get the scale field for the FontBasis record.
  1057. </member>
  1058. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.IndexToFontTable">
  1059. Get the index to font table field for the FontBasis record.
  1060. </member>
  1061. <member name="T:NPOI.HSSF.Record.Chart.FontXRecord">
  1062. <summary>
  1063. The FontX record specifies the font for a given text element.
  1064. The Font record referenced by iFont can exist in this chart sheet substream or the workbook.
  1065. </summary>
  1066. </member>
  1067. <member name="M:NPOI.HSSF.Record.Chart.FontXRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  1068. Constructs a FontIndex record and Sets its fields appropriately.
  1069. @param in the RecordInputstream to Read the record from
  1070. </member>
  1071. <member name="P:NPOI.HSSF.Record.Chart.FontXRecord.DataSize">
  1072. Size of record (exluding 4 byte header)
  1073. </member>
  1074. <member name="P:NPOI.HSSF.Record.Chart.FontXRecord.FontIndex">
  1075. <summary>
  1076. specifies the font to use for subsequent records.
  1077. This font can either be the default font of the chart, part of the collection of Font records following
  1078. the FrtFontList record, or part of the collection of Font records in the globals substream.
  1079. If iFont is 0x0000, this record specifies the default font of the chart.
  1080. If iFont is less than or equal to the number of Font records in the globals substream,
  1081. iFont is a one-based index to a Font record in the globals substream.
  1082. Otherwise iFont is a one-based index into the collection of Font records in this chart sheet substream
  1083. where the index is equal to iFont – n, where n is the number of Font records in the globals substream.
  1084. </summary>
  1085. </member>
  1086. <member name="T:NPOI.HSSF.Record.Chart.FrtFontListRecord">
  1087. <summary>
  1088. The FrtFontList record specifies font information used on the chart and specifies the
  1089. beginning of a collection of Font records as defined by the Chart Sheet Substream ABNF.
  1090. </summary>
  1091. <remarks>
  1092. author: Antony liu (antony.apollo at gmail.com)
  1093. </remarks>
  1094. </member>
  1095. <member name="T:NPOI.HSSF.Record.Chart.GelFrameRecord">
  1096. <summary>
  1097. specifies the properties of a fill pattern for parts of a chart.
  1098. </summary>
  1099. <remarks>
  1100. author: Antony liu (antony.apollo at gmail.com)
  1101. </remarks>
  1102. </member>
  1103. <member name="T:NPOI.HSSF.Record.Chart.IFmtRecordRecord">
  1104. <summary>
  1105. The IFmtRecord record specifies the number format to use for the text on an axis.
  1106. </summary>
  1107. </member>
  1108. <member name="M:NPOI.HSSF.Record.Chart.IFmtRecordRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  1109. Constructs a NumberFormatIndex record and Sets its fields appropriately.
  1110. @param in the RecordInputstream to Read the record from
  1111. </member>
  1112. <member name="P:NPOI.HSSF.Record.Chart.IFmtRecordRecord.DataSize">
  1113. Size of record (exluding 4 byte header)
  1114. </member>
  1115. <member name="P:NPOI.HSSF.Record.Chart.IFmtRecordRecord.FormatIndex">
  1116. Get the format index field for the NumberFormatIndex record.
  1117. </member>
  1118. <member name="T:NPOI.HSSF.Record.Chart.LegendExceptionRecord">
  1119. <summary>
  1120. The LegendException record specifies information about a legend entry which was
  1121. changed from the default legend entry settings, and specifies the beginning of
  1122. a collection of records as defined by the Chart Sheet Substream ABNF.
  1123. The collection of records specifies legend entry formatting. On a chart where
  1124. the legend contains legend entries for the series and trendlines, as defined
  1125. in the legend overview, there MUST be zero instances or one instance of this
  1126. record in the sequence of records that conform to the SERIESFORMAT rule.
  1127. </summary>
  1128. <remarks>
  1129. author: Antony liu (antony.apollo at gmail.com)
  1130. </remarks>
  1131. </member>
  1132. <member name="T:NPOI.HSSF.Record.Chart.PicFRecord">
  1133. <summary>
  1134. The PicF record specifies the layout of a picture that is attached to a picture-filled chart element.
  1135. </summary>
  1136. <remarks>
  1137. author: Antony liu (antony.apollo at gmail.com)
  1138. </remarks>
  1139. </member>
  1140. <member name="T:NPOI.HSSF.Record.Chart.RadarAreaRecord">
  1141. <summary>
  1142. The RadarArea record specifies that the chart group is a filled radar chart group and specifies the chart group attributes.
  1143. </summary>
  1144. <remarks>
  1145. author: Antony liu (antony.apollo at gmail.com)
  1146. </remarks>
  1147. </member>
  1148. <member name="T:NPOI.HSSF.Record.Chart.RadarRecord">
  1149. <summary>
  1150. The Radar record specifies that the chart group is a radar chart group and specifies the chart group attributes.
  1151. </summary>
  1152. <remarks>
  1153. author: Antony liu (antony.apollo at gmail.com)
  1154. </remarks>
  1155. </member>
  1156. <member name="T:NPOI.HSSF.Record.Chart.RichTextStreamRecord">
  1157. <summary>
  1158. The RichTextStream record specifies additional text properties for the text in
  1159. the entire chart, text in the current legend, text in the current legend entry,
  1160. or text in the attached label. These text properties are a superset of the
  1161. properties stored in the Text, Font, FontX, BRAI, and ObjectLink records based
  1162. on the following table, as specified by the Chart Sheet Substream ABNF. In each
  1163. case, the associated Font record is specified by the associated FontX record.
  1164. </summary>
  1165. <remarks>
  1166. author: Antony liu (antony.apollo at gmail.com)
  1167. </remarks>
  1168. </member>
  1169. <member name="T:NPOI.HSSF.Record.Chart.ScatterRecord">
  1170. <summary>
  1171. The Scatter record specifies that the chart group is a scatter chart group or
  1172. a bubble chart group, and specifies the chart group attributes.
  1173. </summary>
  1174. <remarks>
  1175. author: Antony liu (antony.apollo at gmail.com)
  1176. </remarks>
  1177. </member>
  1178. <member name="T:NPOI.HSSF.Record.Chart.SerAuxErrBarRecord">
  1179. <summary>
  1180. The SerAuxErrBar record specifies properties of an error bar.
  1181. </summary>
  1182. <remarks>
  1183. author: Antony liu (antony.apollo at gmail.com)
  1184. </remarks>
  1185. </member>
  1186. <member name="T:NPOI.HSSF.Record.Chart.SerAuxTrendRecord">
  1187. <summary>
  1188. The SerAuxTrend record specifies a trendline.
  1189. </summary>
  1190. <remarks>
  1191. author: Antony liu (antony.apollo at gmail.com)
  1192. </remarks>
  1193. </member>
  1194. <member name="T:NPOI.HSSF.Record.Chart.SerFmtRecord">
  1195. <summary>
  1196. The SerFmt record specifies properties of the associated data points, data markers,
  1197. or lines of the series. The associated data points, data markers, or lines of the
  1198. series are specified by the preceding DataFormat record. If this record is not
  1199. present in the sequence of records that conforms to the SS rule of the Chart Sheet
  1200. Substream ABNF, then the properties of the associated data points, data markers,
  1201. or lines of the series are specified by the default values of the fields of this record.
  1202. </summary>
  1203. <remarks>
  1204. author: Antony liu (antony.apollo at gmail.com)
  1205. </remarks>
  1206. </member>
  1207. <member name="T:NPOI.HSSF.Record.Chart.SerParentRecord">
  1208. <summary>
  1209. The SerParent record specifies the series to which the current trendline or error bar corresponds.
  1210. </summary>
  1211. <remarks>
  1212. author: Antony liu (antony.apollo at gmail.com)
  1213. </remarks>
  1214. </member>
  1215. <member name="T:NPOI.HSSF.Record.Chart.SerToCrtRecord">
  1216. <summary>
  1217. The SerToCrt record specifies the chart group for the current series.
  1218. </summary>
  1219. </member>
  1220. <member name="M:NPOI.HSSF.Record.Chart.SerToCrtRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  1221. Constructs a SeriesChartGroupIndex record and Sets its fields appropriately.
  1222. @param in the RecordInputstream to Read the record from
  1223. </member>
  1224. <member name="P:NPOI.HSSF.Record.Chart.SerToCrtRecord.DataSize">
  1225. Size of record (exluding 4 byte header)
  1226. </member>
  1227. <member name="P:NPOI.HSSF.Record.Chart.SerToCrtRecord.ChartGroupIndex">
  1228. Get the chart Group index field for the SeriesChartGroupIndex record.
  1229. </member>
  1230. <member name="T:NPOI.HSSF.Record.Chart.ShapePropsStreamRecord">
  1231. <summary>
  1232. The ShapePropsStream record specifies the shape formatting properties for chart elements.
  1233. These shape formatting properties are a superset of the properties stored in the LineFormat,
  1234. AreaFormat, MarkerFormat, and GelFrame records. They are stored in the rgb field, which is an
  1235. XML stream (section 2.1.7.22), as defined in [ECMA-376] Part 4, section 5.7.2.198.
  1236. </summary>
  1237. <remarks>
  1238. author: Antony liu (antony.apollo at gmail.com)
  1239. </remarks>
  1240. </member>
  1241. <member name="T:NPOI.HSSF.Record.Chart.ShtPropsRecord">
  1242. * Describes a chart sheet properties record.
  1243. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  1244. * Remove the record in src/records/definitions.
  1245. * @author Glen Stampoultzis (glens at apache.org)
  1246. <summary>
  1247. specifies properties of a chart as defined by the Chart Sheet Substream ABNF
  1248. </summary>
  1249. </member>
  1250. <member name="M:NPOI.HSSF.Record.Chart.ShtPropsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  1251. Constructs a SheetProperties record and Sets its fields appropriately.
  1252. @param in the RecordInputstream to Read the record from
  1253. </member>
  1254. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.DataSize">
  1255. Size of record (exluding 4 byte header)
  1256. </member>
  1257. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.Flags">
  1258. Get the flags field for the SheetProperties record.
  1259. </member>
  1260. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.Blank">
  1261. Get the empty field for the SheetProperties record.
  1262. @return One of
  1263. EMPTY_NOT_PLOTTED
  1264. EMPTY_ZERO
  1265. EMPTY_INTERPOLATED
  1266. <summary>
  1267. specifies how the empty cells are plotted be a value from the following table:
  1268. 0x00 Empty cells are not plotted.
  1269. 0x01 Empty cells are plotted as zero.
  1270. 0x02 Empty cells are plotted as interpolated.
  1271. </summary>
  1272. </member>
  1273. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsManSerAlloc">
  1274. <summary>
  1275. whether series are automatically allocated for the chart.
  1276. </summary>
  1277. </member>
  1278. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsPlotVisibleOnly">
  1279. <summary>
  1280. whether to plot visible cells only.
  1281. </summary>
  1282. </member>
  1283. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsNotSizeWithWindow">
  1284. <summary>
  1285. whether to size the chart with the window.
  1286. </summary>
  1287. </member>
  1288. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsManPlotArea">
  1289. <summary>
  1290. If fAlwaysAutoPlotArea is 1, then this field MUST be 1.
  1291. If fAlwaysAutoPlotArea is 0, then this field MUST be ignored.
  1292. </summary>
  1293. </member>
  1294. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsAlwaysAutoPlotArea">
  1295. <summary>
  1296. specifies whether the default plot area dimension (2) is used.
  1297. 0 Use the default plot area dimension (2) regardless of the Pos record information.
  1298. 1 Use the plot area dimension (2) of the Pos record; and fManPlotArea MUST be 1.
  1299. </summary>
  1300. </member>
  1301. <member name="T:NPOI.HSSF.Record.Chart.StartBlockRecord">
  1302. STARTBLOCK - Chart Future Record Type Start Block (0x0852)<br/>
  1303. @author Patrick Cheng
  1304. </member>
  1305. <member name="T:NPOI.HSSF.Record.Chart.SurfRecord">
  1306. <summary>
  1307. The Surf record specifies that the chart group is a surface chart group and specifies the chart group attributes.
  1308. </summary>
  1309. <remarks>
  1310. author: Antony liu (antony.apollo at gmail.com)
  1311. </remarks>
  1312. </member>
  1313. <member name="T:NPOI.HSSF.Record.Chart.TextPropsStreamRecord">
  1314. <summary>
  1315. The RichTextStream record specifies additional text properties for the text
  1316. in the entire chart, text in the current legend, text in the current legend
  1317. entry, or text in the attached label. These text properties are a superset
  1318. of the properties stored in the Text, Font, FontX, BRAI, and ObjectLink records
  1319. based on the following table, as specified by the Chart Sheet Substream ABNF.
  1320. In each case, the associated Font record is specified by the associated FontX record.
  1321. </summary>
  1322. <remarks>
  1323. author: Antony liu (antony.apollo at gmail.com)
  1324. </remarks>
  1325. </member>
  1326. <member name="T:NPOI.HSSF.Record.Chart.YMultRecord">
  1327. <summary>
  1328. The YMult record specifies properties of the value multiplier for a value axis and
  1329. that specifies the beginning of a collection of records as defined by the Chart Sheet
  1330. substream ABNF. The collection of records specifies a display units label.
  1331. </summary>
  1332. <remarks>
  1333. author: Antony liu (antony.apollo at gmail.com)
  1334. </remarks>
  1335. </member>
  1336. <member name="T:NPOI.HSSF.Record.ContinueFrt12Record">
  1337. <summary>
  1338. The ContinueFrt12 record specifies a continuation of the data in a preceding Future Record
  1339. Type record that has data longer than 8,224 bytes. Such records are split into several records.
  1340. The first section of the data appears in the base record and subsequent sections appear in
  1341. one or more ContinueFrt12 records that appear after the base record. The preceding base record
  1342. MUST contain a FrtRefHeader or a FrtHeader field.
  1343. </summary>
  1344. <remarks>
  1345. author: Antony liu (antony.apollo at gmail.com)
  1346. </remarks>
  1347. </member>
  1348. <member name="T:NPOI.HSSF.Record.DConRefRecord">
  1349. DConRef records specify a range in a workbook (internal or external) that serves as a data source
  1350. for pivot tables or data consolidation.
  1351. Represents a <code>DConRef</code> Structure
  1352. <a href="http://msdn.microsoft.com/en-us/library/dd923854(office.12).aspx">[MS-XLS s.
  1353. 2.4.86]</a>, and the contained <code>DConFile</code> structure
  1354. <a href="http://msdn.microsoft.com/en-us/library/dd950157(office.12).aspx">
  1355. [MS-XLS s. 2.5.69]</a>. This in turn contains a <code>XLUnicodeStringNoCch</code>
  1356. <a href="http://msdn.microsoft.com/en-us/library/dd910585(office.12).aspx">
  1357. [MS-XLS s. 2.5.296]</a>.
  1358. <pre>
  1359. _______________________________
  1360. | DConRef |
  1361. (bytes) +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+
  1362. | ref |cch| stFile | un|
  1363. +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+
  1364. |
  1365. _________|_____________________
  1366. |DConFile / XLUnicodeStringNoCch|
  1367. +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+
  1368. (bits) |h| reserved | rgb |
  1369. +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+
  1370. </pre>
  1371. Where
  1372. <ul>
  1373. <li><code>DConFile.h = 0x00</code> if the characters in<code>rgb</code> are single byte, and
  1374. <code>DConFile.h = 0x01</code> if they are double byte. <br/>
  1375. If they are double byte, then<br/>
  1376. <ul>
  1377. <li> If it exists, the length of <code>DConRef.un = 2</code>. Otherwise it is 1.</li>
  1378. <li> The length of <code>DConFile.rgb = (2 * DConRef.cch)</code>. Otherwise it is equal to
  1379. <code>DConRef.cch</code></li>.
  1380. </ul>
  1381. </li>
  1382. <li><code>DConRef.rgb</code> starts with <code>0x01</code> if it is an external reference,
  1383. and with <code>0x02</code> if it is a self-reference.</li>
  1384. </ul>
  1385. At the moment this class is read-only.
  1386. @author Niklas Rehfeld
  1387. </member>
  1388. <member name="F:NPOI.HSSF.Record.DConRefRecord.sid">
  1389. The id of the record type,
  1390. <code>sid = {@value}</code>
  1391. </member>
  1392. <member name="F:NPOI.HSSF.Record.DConRefRecord.firstRow">
  1393. A RefU structure specifying the range of cells if this record is part of an SXTBL.
  1394. <a href="http://msdn.microsoft.com/en-us/library/dd920420(office.12).aspx">
  1395. [MS XLS s.2.5.211]</a>
  1396. </member>
  1397. <member name="F:NPOI.HSSF.Record.DConRefRecord.lastRow">
  1398. A RefU structure specifying the range of cells if this record is part of an SXTBL.
  1399. <a href="http://msdn.microsoft.com/en-us/library/dd920420(office.12).aspx">
  1400. [MS XLS s.2.5.211]</a>
  1401. </member>
  1402. <member name="F:NPOI.HSSF.Record.DConRefRecord.firstCol">
  1403. A RefU structure specifying the range of cells if this record is part of an SXTBL.
  1404. <a href="http://msdn.microsoft.com/en-us/library/dd920420(office.12).aspx">
  1405. [MS XLS s.2.5.211]</a>
  1406. </member>
  1407. <member name="F:NPOI.HSSF.Record.DConRefRecord.lastCol">
  1408. A RefU structure specifying the range of cells if this record is part of an SXTBL.
  1409. <a href="http://msdn.microsoft.com/en-us/library/dd920420(office.12).aspx">
  1410. [MS XLS s.2.5.211]</a>
  1411. </member>
  1412. <member name="F:NPOI.HSSF.Record.DConRefRecord.charCount">
  1413. the number of chars in the link
  1414. </member>
  1415. <member name="F:NPOI.HSSF.Record.DConRefRecord.charType">
  1416. the type of characters (single or double byte)
  1417. </member>
  1418. <member name="F:NPOI.HSSF.Record.DConRefRecord.path">
  1419. The link's path string. This is the <code>rgb</code> field of a
  1420. <code>XLUnicodeStringNoCch</code>. Therefore it will contain at least one leading special
  1421. character (0x01 or 0x02) and probably other ones.<p/>
  1422. @see <a href="http://msdn.microsoft.com/en-us/library/dd923491(office.12).aspx">
  1423. DConFile [MS-XLS s. 2.5.77]</a> and
  1424. <a href="http://msdn.microsoft.com/en-us/library/dd950157(office.12).aspx">
  1425. VirtualPath [MS-XLS s. 2.5.69]</a>
  1426. <p/>
  1427. </member>
  1428. <member name="F:NPOI.HSSF.Record.DConRefRecord._unused">
  1429. unused bits at the end, must be set to 0.
  1430. </member>
  1431. <member name="M:NPOI.HSSF.Record.DConRefRecord.#ctor(System.Byte[])">
  1432. Read constructor.
  1433. @param data byte array containing a DConRef Record, including the header.
  1434. </member>
  1435. <member name="M:NPOI.HSSF.Record.DConRefRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  1436. Read Constructor.
  1437. @param inStream RecordInputStream containing a DConRefRecord structure.
  1438. </member>
  1439. <member name="M:NPOI.HSSF.Record.DConRefRecord.GetPath">
  1440. @return raw path byte array.
  1441. </member>
  1442. <member name="P:NPOI.HSSF.Record.DConRefRecord.FirstColumn">
  1443. @return The first column of the range.
  1444. </member>
  1445. <member name="P:NPOI.HSSF.Record.DConRefRecord.FirstRow">
  1446. @return The first row of the range.
  1447. </member>
  1448. <member name="P:NPOI.HSSF.Record.DConRefRecord.LastColumn">
  1449. @return The last column of the range.
  1450. </member>
  1451. <member name="P:NPOI.HSSF.Record.DConRefRecord.LastRow">
  1452. @return The last row of the range.
  1453. </member>
  1454. <member name="P:NPOI.HSSF.Record.DConRefRecord.ReadablePath">
  1455. @return the link's path, with the special characters stripped/replaced. May be null.
  1456. See MS-XLS 2.5.277 (VirtualPath)
  1457. </member>
  1458. <member name="P:NPOI.HSSF.Record.DConRefRecord.IsExternalRef">
  1459. Checks if the data source in this reference record is external to this sheet or internal.
  1460. @return true iff this is an external reference.
  1461. </member>
  1462. <member name="T:NPOI.HSSF.Record.FtCfSubRecord">
  1463. The FtCf structure specifies the clipboard format of the picture-type Obj record Containing this FtCf.
  1464. </member>
  1465. <member name="T:NPOI.HSSF.Record.SubRecord">
  1466. Subrecords are part of the OBJ class.
  1467. </member>
  1468. <member name="P:NPOI.HSSF.Record.SubRecord.IsTerminating">
  1469. Wether this record terminates the sub-record stream.
  1470. There are two cases when this method must be overridden and return <c>true</c>
  1471. - EndSubRecord (sid = 0x00)
  1472. - LbsDataSubRecord (sid = 0x12)
  1473. @return whether this record is the last in the sub-record stream
  1474. </member>
  1475. <member name="F:NPOI.HSSF.Record.FtCfSubRecord.METAFILE_BIT">
  1476. Specifies the format of the picture is an enhanced metafile.
  1477. </member>
  1478. <member name="F:NPOI.HSSF.Record.FtCfSubRecord.BITMAP_BIT">
  1479. Specifies the format of the picture is a bitmap.
  1480. </member>
  1481. <member name="F:NPOI.HSSF.Record.FtCfSubRecord.UNSPECIFIED_BIT">
  1482. Specifies the picture is in an unspecified format that is
  1483. neither and enhanced metafile nor a bitmap.
  1484. </member>
  1485. <member name="M:NPOI.HSSF.Record.FtCfSubRecord.#ctor">
  1486. Construct a new <code>FtPioGrbitSubRecord</code> and
  1487. fill its data with the default values
  1488. </member>
  1489. <member name="M:NPOI.HSSF.Record.FtCfSubRecord.ToString">
  1490. Convert this record to string.
  1491. Used by BiffViewer and other utilities.
  1492. </member>
  1493. <member name="M:NPOI.HSSF.Record.FtCfSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  1494. Serialize the record data into the supplied array of bytes
  1495. @param out the stream to serialize into
  1496. </member>
  1497. <member name="P:NPOI.HSSF.Record.FtCfSubRecord.Sid">
  1498. @return id of this record.
  1499. </member>
  1500. <member name="T:NPOI.HSSF.Record.FtPioGrbitSubRecord">
  1501. This structure appears as part of an Obj record that represents image display properties.
  1502. </member>
  1503. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.AUTO_PICT_BIT">
  1504. A bit that specifies whether the picture's aspect ratio is preserved when rendered in
  1505. different views (Normal view, Page Break Preview view, Page Layout view and printing).
  1506. </member>
  1507. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.DDE_BIT">
  1508. A bit that specifies whether the pictFmla field of the Obj record that Contains
  1509. this FtPioGrbit specifies a DDE reference.
  1510. </member>
  1511. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.PRINT_CALC_BIT">
  1512. A bit that specifies whether this object is expected to be updated on print to
  1513. reflect the values in the cell associated with the object.
  1514. </member>
  1515. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.ICON_BIT">
  1516. A bit that specifies whether the picture is displayed as an icon.
  1517. </member>
  1518. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.CTL_BIT">
  1519. A bit that specifies whether this object is an ActiveX control.
  1520. It MUST NOT be the case that both fCtl and fDde are equal to 1.
  1521. </member>
  1522. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.PRSTM_BIT">
  1523. A bit that specifies whether the object data are stored in an
  1524. embedding storage (= 0) or in the controls stream (ctls) (= 1).
  1525. </member>
  1526. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.CAMERA_BIT">
  1527. A bit that specifies whether this is a camera picture.
  1528. </member>
  1529. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.DEFAULT_SIZE_BIT">
  1530. A bit that specifies whether this picture's size has been explicitly Set.
  1531. 0 = picture size has been explicitly Set, 1 = has not been Set
  1532. </member>
  1533. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.AUTO_LOAD_BIT">
  1534. A bit that specifies whether the OLE server for the object is called
  1535. to load the object's data automatically when the parent workbook is opened.
  1536. </member>
  1537. <member name="M:NPOI.HSSF.Record.FtPioGrbitSubRecord.#ctor">
  1538. Construct a new <code>FtPioGrbitSubRecord</code> and
  1539. fill its data with the default values
  1540. </member>
  1541. <member name="M:NPOI.HSSF.Record.FtPioGrbitSubRecord.SetFlagByBit(System.Int32,System.Boolean)">
  1542. Use one of the bitmasks MANUAL_ADVANCE_BIT ... CURSOR_VISIBLE_BIT
  1543. @param bitmask
  1544. @param enabled
  1545. </member>
  1546. <member name="M:NPOI.HSSF.Record.FtPioGrbitSubRecord.ToString">
  1547. Convert this record to string.
  1548. Used by BiffViewer and other utilities.
  1549. </member>
  1550. <member name="M:NPOI.HSSF.Record.FtPioGrbitSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  1551. Serialize the record data into the supplied array of bytes
  1552. @param out the stream to serialize into
  1553. </member>
  1554. <member name="P:NPOI.HSSF.Record.FtPioGrbitSubRecord.Sid">
  1555. @return id of this record.
  1556. </member>
  1557. <member name="T:NPOI.HSSF.Record.OldCellRecord">
  1558. Base class for all old (Biff 2 - Biff 4) cell value records
  1559. (implementors of {@link CellValueRecordInterface}).
  1560. Subclasses are expected to manage the cell data values (of various types).
  1561. </member>
  1562. <member name="M:NPOI.HSSF.Record.OldCellRecord.AppendValueText(System.Text.StringBuilder)">
  1563. Append specific debug info (used by {@link #ToString()} for the value
  1564. Contained in this record. Trailing new-line should not be Appended
  1565. (superclass does that).
  1566. </member>
  1567. <member name="P:NPOI.HSSF.Record.OldCellRecord.XFIndex">
  1568. Get the index to the ExtendedFormat, for non-Biff2
  1569. @see NPOI.HSSF.Record.ExtendedFormatRecord
  1570. @return index to the XF record
  1571. </member>
  1572. <member name="P:NPOI.HSSF.Record.OldCellRecord.IsBiff2">
  1573. Is this a Biff2 record, or newer?
  1574. </member>
  1575. <member name="P:NPOI.HSSF.Record.OldCellRecord.RecordName">
  1576. Gets the debug info BIFF record type name (used by {@link #ToString()}.
  1577. </member>
  1578. <member name="T:NPOI.HSSF.Record.OldFormulaRecord">
  1579. Formula Record (0x0006 / 0x0206 / 0x0406) - holds a formula in
  1580. encoded form, along with the value if a number
  1581. </member>
  1582. <member name="P:NPOI.HSSF.Record.OldFormulaRecord.Value">
  1583. Get the calculated value of the formula
  1584. @return calculated value
  1585. </member>
  1586. <member name="P:NPOI.HSSF.Record.OldFormulaRecord.Options">
  1587. Get the option flags
  1588. @return bitmask
  1589. </member>
  1590. <member name="P:NPOI.HSSF.Record.OldFormulaRecord.ParsedExpression">
  1591. @return the formula tokens. never <code>null</code>
  1592. </member>
  1593. <member name="T:NPOI.HSSF.Record.OldLabelRecord">
  1594. Biff2 - Biff 4 Label Record (0x0004 / 0x0204) - read only support for
  1595. strings stored directly in the cell, from the older file formats that
  1596. didn't use {@link LabelSSTRecord}
  1597. </member>
  1598. <member name="M:NPOI.HSSF.Record.OldLabelRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  1599. @param in the RecordInputstream to read the record from
  1600. </member>
  1601. <member name="M:NPOI.HSSF.Record.OldLabelRecord.Serialize(System.Int32,System.Byte[])">
  1602. Not supported
  1603. </member>
  1604. <member name="P:NPOI.HSSF.Record.OldLabelRecord.StringLength">
  1605. Get the number of characters this string Contains
  1606. @return number of characters
  1607. </member>
  1608. <member name="P:NPOI.HSSF.Record.OldLabelRecord.Value">
  1609. Get the String of the cell
  1610. </member>
  1611. <member name="T:NPOI.HSSF.Record.OldSheetRecord">
  1612. Title: Bound Sheet Record (aka BundleSheet) (0x0085) for BIFF 5<br/>
  1613. Description: Defines a sheet within a workbook. Basically stores the sheet name
  1614. and tells where the Beginning of file record is within the HSSF
  1615. file.
  1616. </member>
  1617. <member name="P:NPOI.HSSF.Record.OldSheetRecord.PositionOfBof">
  1618. Get the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file
  1619. @return offset in bytes
  1620. </member>
  1621. <member name="P:NPOI.HSSF.Record.OldSheetRecord.Sheetname">
  1622. Get the sheetname for this sheet. (this appears in the tabs at the bottom)
  1623. @return sheetname the name of the sheet
  1624. </member>
  1625. <member name="T:NPOI.HSSF.Record.OldStringRecord">
  1626. Biff2 - Biff 4 Label Record (0x0007 / 0x0207) - read only support for
  1627. formula string results.
  1628. </member>
  1629. <member name="M:NPOI.HSSF.Record.OldStringRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  1630. @param in the RecordInputstream to read the record from
  1631. </member>
  1632. <member name="M:NPOI.HSSF.Record.OldStringRecord.GetString">
  1633. @return The string represented by this record.
  1634. </member>
  1635. <member name="T:NPOI.HSSF.UserModel.HSSFSimpleShape">
  1636. <summary>
  1637. Represents a simple shape such as a line, rectangle or oval.
  1638. @author Glen Stampoultzis (glens at apache.org)
  1639. </summary>
  1640. </member>
  1641. <member name="T:NPOI.HSSF.UserModel.HSSFShape">
  1642. <summary>
  1643. An abstract shape.
  1644. Note: Microsoft Excel seems to sometimes disallow
  1645. higher y1 than y2 or higher x1 than x2 in the anchor, you might need to
  1646. reverse them and draw shapes vertically or horizontally flipped!
  1647. </summary>
  1648. </member>
  1649. <member name="M:NPOI.HSSF.UserModel.HSSFShape.#ctor(NPOI.DDF.EscherContainerRecord,NPOI.HSSF.Record.ObjRecord)">
  1650. creates shapes from existing file
  1651. @param spContainer
  1652. @param objRecord
  1653. </member>
  1654. <member name="M:NPOI.HSSF.UserModel.HSSFShape.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  1655. <summary>
  1656. Create a new shape with the specified parent and anchor.
  1657. </summary>
  1658. <param name="parent">The parent.</param>
  1659. <param name="anchor">The anchor.</param>
  1660. </member>
  1661. <member name="M:NPOI.HSSF.UserModel.HSSFShape.SetLineStyleColor(System.Int32,System.Int32,System.Int32)">
  1662. <summary>
  1663. Sets the color applied to the lines of this shape
  1664. </summary>
  1665. <param name="red">The red.</param>
  1666. <param name="green">The green.</param>
  1667. <param name="blue">The blue.</param>
  1668. </member>
  1669. <member name="M:NPOI.HSSF.UserModel.HSSFShape.SetFillColor(System.Int32,System.Int32,System.Int32)">
  1670. <summary>
  1671. Sets the color used to fill this shape.
  1672. </summary>
  1673. <param name="red">The red.</param>
  1674. <param name="green">The green.</param>
  1675. <param name="blue">The blue.</param>
  1676. </member>
  1677. <member name="P:NPOI.HSSF.UserModel.HSSFShape.Parent">
  1678. <summary>
  1679. Gets the parent shape.
  1680. </summary>
  1681. <value>The parent.</value>
  1682. </member>
  1683. <member name="P:NPOI.HSSF.UserModel.HSSFShape.Anchor">
  1684. <summary>
  1685. Gets or sets the anchor that is used by this shape.
  1686. </summary>
  1687. <value>The anchor.</value>
  1688. </member>
  1689. <member name="P:NPOI.HSSF.UserModel.HSSFShape.LineStyleColor">
  1690. <summary>
  1691. The color applied to the lines of this shape.
  1692. </summary>
  1693. <value>The color of the line style.</value>
  1694. </member>
  1695. <member name="P:NPOI.HSSF.UserModel.HSSFShape.FillColor">
  1696. <summary>
  1697. Gets or sets the color used to fill this shape.
  1698. </summary>
  1699. <value>The color of the fill.</value>
  1700. </member>
  1701. <member name="P:NPOI.HSSF.UserModel.HSSFShape.LineWidth">
  1702. <summary>
  1703. Gets or sets with width of the line in EMUs. 12700 = 1 pt.
  1704. </summary>
  1705. <value>The width of the line.</value>
  1706. </member>
  1707. <member name="P:NPOI.HSSF.UserModel.HSSFShape.LineStyle">
  1708. <summary>
  1709. Gets or sets One of the constants in LINESTYLE_*
  1710. </summary>
  1711. <value>The line style.</value>
  1712. </member>
  1713. <member name="P:NPOI.HSSF.UserModel.HSSFShape.IsNoFill">
  1714. <summary>
  1715. Gets or sets a value indicating whether this instance is no fill.
  1716. </summary>
  1717. <value>
  1718. <c>true</c> if this shape Is not filled with a color; otherwise, <c>false</c>.
  1719. </value>
  1720. </member>
  1721. <member name="P:NPOI.HSSF.UserModel.HSSFShape.IsFlipVertical">
  1722. <summary>
  1723. whether this shape is vertically flipped.
  1724. </summary>
  1725. </member>
  1726. <member name="P:NPOI.HSSF.UserModel.HSSFShape.IsFlipHorizontal">
  1727. <summary>
  1728. whether this shape is horizontally flipped.
  1729. </summary>
  1730. </member>
  1731. <member name="P:NPOI.HSSF.UserModel.HSSFShape.RotationDegree">
  1732. <summary>
  1733. get or set the rotation, in degrees, that is applied to a shape.
  1734. Negative values specify rotation in the counterclockwise direction.
  1735. Rotation occurs around the center of the shape.
  1736. The default value for this property is 0x00000000
  1737. </summary>
  1738. </member>
  1739. <member name="P:NPOI.HSSF.UserModel.HSSFShape.CountOfAllChildren">
  1740. <summary>
  1741. Count of all children and their childrens children.
  1742. </summary>
  1743. <value>The count of all children.</value>
  1744. </member>
  1745. <member name="M:NPOI.HSSF.UserModel.HSSFSimpleShape.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  1746. <summary>
  1747. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFSimpleShape"/> class.
  1748. </summary>
  1749. <param name="parent">The parent.</param>
  1750. <param name="anchor">The anchor.</param>
  1751. </member>
  1752. <member name="P:NPOI.HSSF.UserModel.HSSFSimpleShape.ShapeType">
  1753. <summary>
  1754. Gets the shape type.
  1755. </summary>
  1756. <value>One of the OBJECT_TYPE_* constants.</value>
  1757. @see #OBJECT_TYPE_LINE
  1758. @see #OBJECT_TYPE_OVAL
  1759. @see #OBJECT_TYPE_RECTANGLE
  1760. @see #OBJECT_TYPE_PICTURE
  1761. @see #OBJECT_TYPE_COMMENT
  1762. </member>
  1763. <member name="P:NPOI.HSSF.UserModel.HSSFSimpleShape.String">
  1764. <summary>
  1765. Get or set the rich text string used by this object.
  1766. </summary>
  1767. </member>
  1768. <member name="T:NPOI.HSSF.UserModel.HSSFShapeFactory">
  1769. @author Evgeniy Berlog
  1770. date: 05.06.12
  1771. </member>
  1772. <member name="M:NPOI.HSSF.UserModel.HSSFShapeFactory.CreateShapeTree(NPOI.DDF.EscherContainerRecord,NPOI.HSSF.Record.EscherAggregate,NPOI.HSSF.UserModel.HSSFShapeContainer,NPOI.POIFS.FileSystem.DirectoryNode)">
  1773. build shape tree from escher container
  1774. @param container root escher container from which escher records must be taken
  1775. @param agg - EscherAggregate
  1776. @param out - shape container to which shapes must be added
  1777. @param root - node to create HSSFObjectData shapes
  1778. </member>
  1779. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodeRecursively(NPOI.POIFS.FileSystem.Entry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  1780. Copies an Entry into a target POIFS directory, recursively
  1781. </member>
  1782. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.DirectoryEntry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  1783. Copies all the nodes from one POIFS Directory to another
  1784. @param sourceRoot
  1785. is the source Directory to copy from
  1786. @param targetRoot
  1787. is the target Directory to copy to
  1788. </member>
  1789. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.FilteringDirectoryNode,NPOI.POIFS.FileSystem.FilteringDirectoryNode)">
  1790. Copies nodes from one Directory to the other minus the excepts
  1791. @param filteredSource The filtering source Directory to copy from
  1792. @param filteredTarget The filtering target Directory to copy to
  1793. </member>
  1794. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.DirectoryEntry,NPOI.POIFS.FileSystem.DirectoryEntry,System.Collections.Generic.List{System.String})">
  1795. Copies nodes from one Directory to the other minus the excepts
  1796. @param sourceRoot
  1797. is the source Directory to copy from
  1798. @param targetRoot
  1799. is the target Directory to copy to
  1800. @param excepts
  1801. is a list of Strings specifying what nodes NOT to copy
  1802. @deprecated use {@link FilteringDirectoryNode} instead
  1803. </member>
  1804. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.POIFSFileSystem,NPOI.POIFS.FileSystem.POIFSFileSystem)">
  1805. Copies all nodes from one POIFS to the other
  1806. @param source
  1807. is the source POIFS to copy from
  1808. @param target
  1809. is the target POIFS to copy to
  1810. </member>
  1811. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.POIFSFileSystem,NPOI.POIFS.FileSystem.POIFSFileSystem,System.Collections.Generic.List{System.String})">
  1812. Copies nodes from one POIFS to the other, minus the excepts.
  1813. This delegates the filtering work to {@link FilteringDirectoryNode},
  1814. so excepts can be of the form "NodeToExclude" or
  1815. "FilteringDirectory/ExcludedChildNode"
  1816. @param source is the source POIFS to copy from
  1817. @param target is the target POIFS to copy to
  1818. @param excepts is a list of Entry Names to be excluded from the copy
  1819. </member>
  1820. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.AreDirectoriesIdentical(NPOI.POIFS.FileSystem.DirectoryEntry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  1821. Checks to see if the two Directories hold the same contents.
  1822. For this to be true, they must have entries with the same names,
  1823. no entries in one but not the other, and the size+contents
  1824. of each entry must match, and they must share names.
  1825. To exclude certain parts of the Directory from being checked,
  1826. use a {@link FilteringDirectoryNode}
  1827. </member>
  1828. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.AreDocumentsIdentical(NPOI.POIFS.FileSystem.DocumentEntry,NPOI.POIFS.FileSystem.DocumentEntry)">
  1829. Checks to see if two Documents have the same name
  1830. and the same contents. (Their parent directories are
  1831. not checked)
  1832. </member>
  1833. <member name="T:NPOI.POIFS.FileSystem.FilteringDirectoryNode">
  1834. <summary>
  1835. A DirectoryEntry filter, which exposes another DirectoryEntry less certain parts.
  1836. This is typically used when copying or comparing Filesystems.
  1837. </summary>
  1838. </member>
  1839. <member name="T:NPOI.POIFS.FileSystem.DirectoryEntry">
  1840. <summary>
  1841. This interface defines methods specific to Directory objects
  1842. managed by a Filesystem instance.
  1843. @author Marc Johnson (mjohnson at apache dot org)
  1844. </summary>
  1845. </member>
  1846. <member name="T:NPOI.POIFS.FileSystem.Entry">
  1847. <summary>
  1848. This interface provides access to an object managed by a Filesystem
  1849. instance. Entry objects are further divided into DocumentEntry and
  1850. DirectoryEntry instances.
  1851. @author Marc Johnson (mjohnson at apache dot org)
  1852. </summary>
  1853. </member>
  1854. <member name="M:NPOI.POIFS.FileSystem.Entry.Delete">
  1855. <summary>
  1856. Delete this Entry. ThIs operation should succeed, but there are
  1857. special circumstances when it will not:
  1858. If this Entry Is the root of the Entry tree, it cannot be
  1859. deleted, as there Is no way to Create another one.
  1860. If this Entry Is a directory, it cannot be deleted unless it Is
  1861. empty.
  1862. </summary>
  1863. <returns>true if the Entry was successfully deleted, else false</returns>
  1864. </member>
  1865. <member name="M:NPOI.POIFS.FileSystem.Entry.RenameTo(System.String)">
  1866. <summary>
  1867. Rename this Entry. ThIs operation will fail if:
  1868. There Is a sibling Entry (i.e., an Entry whose parent Is the
  1869. same as this Entry's parent) with the same name.
  1870. ThIs Entry Is the root of the Entry tree. Its name Is dictated
  1871. by the Filesystem and many not be Changed.
  1872. </summary>
  1873. <param name="newName">the new name for this Entry</param>
  1874. <returns>true if the operation succeeded, else false</returns>
  1875. </member>
  1876. <member name="P:NPOI.POIFS.FileSystem.Entry.Name">
  1877. <summary>
  1878. Get the name of the Entry
  1879. </summary>
  1880. <value>The name.</value>
  1881. </member>
  1882. <member name="P:NPOI.POIFS.FileSystem.Entry.IsDirectoryEntry">
  1883. <summary>
  1884. Is this a DirectoryEntry?
  1885. </summary>
  1886. <value>
  1887. <c>true</c> if the Entry Is a DirectoryEntry; otherwise, <c>false</c>.
  1888. </value>
  1889. </member>
  1890. <member name="P:NPOI.POIFS.FileSystem.Entry.IsDocumentEntry">
  1891. <summary>
  1892. Is this a DocumentEntry?
  1893. </summary>
  1894. <value>
  1895. <c>true</c> if the Entry Is a DocumentEntry; otherwise, <c>false</c>.
  1896. </value>
  1897. </member>
  1898. <member name="P:NPOI.POIFS.FileSystem.Entry.Parent">
  1899. <summary>
  1900. Get this Entry's parent (the DirectoryEntry that owns this
  1901. Entry). All Entry objects, except the root Entry, has a parent.
  1902. </summary>
  1903. <value>this Entry's parent; null iff this Is the root Entry</value>
  1904. This property is moved to EntryNode
  1905. </member>
  1906. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.GetEntry(System.String)">
  1907. <summary>
  1908. get a specified Entry by name
  1909. </summary>
  1910. <param name="name">the name of the Entry to obtain.</param>
  1911. <returns>the specified Entry, if it is directly contained in
  1912. this DirectoryEntry</returns>
  1913. </member>
  1914. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.CreateDocument(System.String,System.IO.Stream)">
  1915. <summary>
  1916. Create a new DocumentEntry
  1917. </summary>
  1918. <param name="name">the name of the new DocumentEntry</param>
  1919. <param name="stream">the Stream from which to Create the new DocumentEntry</param>
  1920. <returns>the new DocumentEntry</returns>
  1921. </member>
  1922. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.CreateDocument(System.String,System.Int32,NPOI.POIFS.EventFileSystem.POIFSWriterListener)">
  1923. <summary>
  1924. Create a new DocumentEntry; the data will be provided later
  1925. </summary>
  1926. <param name="name">the name of the new DocumentEntry</param>
  1927. <param name="size">the size of the new DocumentEntry</param>
  1928. <param name="writer">BeforeWriting event handler</param>
  1929. <returns>the new DocumentEntry</returns>
  1930. </member>
  1931. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.CreateDirectory(System.String)">
  1932. <summary>
  1933. Create a new DirectoryEntry
  1934. </summary>
  1935. <param name="name">the name of the new DirectoryEntry</param>
  1936. <returns>the name of the new DirectoryEntry</returns>
  1937. </member>
  1938. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.HasEntry(System.String)">
  1939. <summary>
  1940. Checks if entry with specified name present
  1941. </summary>
  1942. <param name="name">entry name</param>
  1943. <returns>true if have</returns>
  1944. </member>
  1945. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.Entries">
  1946. <summary>
  1947. get an iterator of the Entry instances contained directly in
  1948. this instance (in other words, children only; no grandchildren
  1949. etc.)
  1950. </summary>
  1951. <value>The entries.never null, but hasNext() may return false
  1952. immediately (i.e., this DirectoryEntry is empty). All
  1953. objects retrieved by next() are guaranteed to be
  1954. implementations of Entry.</value>
  1955. </member>
  1956. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.EntryNames">
  1957. <summary>
  1958. get the names of all the Entries contained directly in this
  1959. instance (in other words, names of children only; no grandchildren etc).
  1960. </summary>
  1961. <value>the names of all the entries that may be retrieved with
  1962. getEntry(String), which may be empty (if this DirectoryEntry is empty
  1963. </value>
  1964. </member>
  1965. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.IsEmpty">
  1966. <summary>
  1967. is this DirectoryEntry empty?
  1968. </summary>
  1969. <value><c>true</c> if this instance contains no Entry instances; otherwise, <c>false</c>.</value>
  1970. </member>
  1971. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.EntryCount">
  1972. <summary>
  1973. find out how many Entry instances are contained directly within
  1974. this DirectoryEntry
  1975. </summary>
  1976. <value>number of immediately (no grandchildren etc.) contained
  1977. Entry instances</value>
  1978. </member>
  1979. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.StorageClsid">
  1980. <summary>
  1981. Gets or sets the storage ClassID.
  1982. </summary>
  1983. <value>The storage ClassID.</value>
  1984. </member>
  1985. <member name="M:NPOI.POIFS.FileSystem.FilteringDirectoryNode.#ctor(NPOI.POIFS.FileSystem.DirectoryEntry,System.Collections.Generic.ICollection{System.String})">
  1986. <summary>
  1987. Creates a filter round the specified directory, which will exclude entries such as
  1988. "MyNode" and "MyDir/IgnoreNode". The excludes can stretch into children, if they contain a /.
  1989. </summary>
  1990. <param name="directory">The Directory to filter</param>
  1991. <param name="excludes">The Entries to exclude</param>
  1992. </member>
  1993. <member name="T:NPOI.POIFS.FileSystem.NDocumentOutputStream">
  1994. This class provides methods to write a DocumentEntry managed by a
  1995. {@link NPOIFSFileSystem} instance.
  1996. </member>
  1997. <member name="F:NPOI.POIFS.FileSystem.NDocumentOutputStream._document_size">
  1998. the Document's size
  1999. </member>
  2000. <member name="F:NPOI.POIFS.FileSystem.NDocumentOutputStream._closed">
  2001. have we been closed?
  2002. </member>
  2003. <member name="F:NPOI.POIFS.FileSystem.NDocumentOutputStream._document">
  2004. the actual Document
  2005. </member>
  2006. <member name="F:NPOI.POIFS.FileSystem.NDocumentOutputStream._property">
  2007. and its Property
  2008. </member>
  2009. <member name="F:NPOI.POIFS.FileSystem.NDocumentOutputStream._buffer">
  2010. our buffer, when null we're into normal blocks
  2011. </member>
  2012. <member name="F:NPOI.POIFS.FileSystem.NDocumentOutputStream._stream">
  2013. our main block stream, when we're into normal blocks
  2014. </member>
  2015. <member name="M:NPOI.POIFS.FileSystem.NDocumentOutputStream.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  2016. Create an OutputStream from the specified DocumentEntry.
  2017. The specified entry will be emptied.
  2018. @param document the DocumentEntry to be written
  2019. </member>
  2020. <member name="M:NPOI.POIFS.FileSystem.NDocumentOutputStream.#ctor(NPOI.POIFS.FileSystem.DirectoryEntry,System.String)">
  2021. Create an OutputStream to create the specified new Entry
  2022. @param parent Where to create the Entry
  2023. @param name Name of the new entry
  2024. </member>
  2025. <member name="T:NPOI.POIFS.FileSystem.NotOLE2FileException">
  2026. This exception is thrown when we try to open a file that doesn't
  2027. seem to actually be an OLE2 file After all
  2028. </member>
  2029. <member name="M:NPOI.Util.POIUtils.CopyNodeRecursively(NPOI.POIFS.FileSystem.Entry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  2030. Copies an Entry into a target POIFS directory, recursively
  2031. </member>
  2032. <member name="M:NPOI.Util.POIUtils.CopyNodes(NPOI.POIFS.FileSystem.DirectoryEntry,NPOI.POIFS.FileSystem.DirectoryEntry,System.Collections.Generic.List{System.String})">
  2033. Copies nodes from one POIFS to the other minus the excepts
  2034. @param source
  2035. is the source POIFS to copy from
  2036. @param target
  2037. is the target POIFS to copy to
  2038. @param excepts
  2039. is a list of Strings specifying what nodes NOT to copy
  2040. </member>
  2041. <member name="M:NPOI.Util.POIUtils.CopyNodes(NPOI.POIFS.FileSystem.POIFSFileSystem,NPOI.POIFS.FileSystem.POIFSFileSystem,System.Collections.Generic.List{System.String})">
  2042. Copies nodes from one POIFS to the other minus the excepts
  2043. @param source
  2044. is the source POIFS to copy from
  2045. @param target
  2046. is the target POIFS to copy to
  2047. @param excepts
  2048. is a list of Strings specifying what nodes NOT to copy
  2049. </member>
  2050. <member name="T:NPOI.SS.Formula.Atp.ArgumentsEvaluator">
  2051. Evaluator for formula arguments.
  2052. @author jfaenomoto@gmail.com
  2053. </member>
  2054. <member name="M:NPOI.SS.Formula.Atp.ArgumentsEvaluator.EvaluateDateArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  2055. Evaluate a generic {@link ValueEval} argument to a double value that represents a date in POI.
  2056. @param arg {@link ValueEval} an argument.
  2057. @param srcCellRow number cell row.
  2058. @param srcCellCol number cell column.
  2059. @return a double representing a date in POI.
  2060. @throws EvaluationException exception upon argument evaluation.
  2061. </member>
  2062. <member name="M:NPOI.SS.Formula.Atp.ArgumentsEvaluator.EvaluateDatesArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  2063. Evaluate a generic {@link ValueEval} argument to an array of double values that represents dates in POI.
  2064. @param arg {@link ValueEval} an argument.
  2065. @param srcCellRow number cell row.
  2066. @param srcCellCol number cell column.
  2067. @return an array of doubles representing dates in POI.
  2068. @throws EvaluationException exception upon argument evaluation.
  2069. </member>
  2070. <member name="M:NPOI.SS.Formula.Atp.ArgumentsEvaluator.EvaluateNumberArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  2071. Evaluate a generic {@link ValueEval} argument to a double value.
  2072. @param arg {@link ValueEval} an argument.
  2073. @param srcCellRow number cell row.
  2074. @param srcCellCol number cell column.
  2075. @return a double value.
  2076. @throws EvaluationException exception upon argument evaluation.
  2077. </member>
  2078. <member name="T:NPOI.SS.Formula.Atp.DateParser">
  2079. Parser for java dates.
  2080. @author jfaenomoto@gmail.com
  2081. </member>
  2082. <member name="M:NPOI.SS.Formula.Atp.DateParser.ParseDate(System.String)">
  2083. Parses a date from a string.
  2084. @param strVal a string with a date pattern.
  2085. @return a date parsed from argument.
  2086. @throws EvaluationException exception upon parsing.
  2087. </member>
  2088. <member name="M:NPOI.SS.Formula.Atp.DateParser.MakeDate(System.Int32,System.Int32,System.Int32)">
  2089. @param month 1-based
  2090. </member>
  2091. <member name="T:NPOI.SS.Formula.Functions.FreeRefFunction">
  2092. For most Excel functions, involving references ((cell, area), (2d, 3d)), the references are
  2093. passed in as arguments, and the exact location remains fixed. However, a select few Excel
  2094. functions have the ability to access cells that were not part of any reference passed as an
  2095. argument.<br/>
  2096. Two important functions with this feature are <b>INDIRECT</b> and <b>OFFSet</b><p/>
  2097. In POI, the <c>HSSFFormulaEvaluator</c> Evaluates every cell in each reference argument before
  2098. calling the function. This means that functions using fixed references do not need access to
  2099. the rest of the workbook to execute. Hence the <c>Evaluate()</c> method on the common
  2100. interface <c>Function</c> does not take a workbook parameter.
  2101. This interface recognises the requirement of some functions to freely Create and Evaluate
  2102. references beyond those passed in as arguments.
  2103. @author Josh Micich
  2104. </member>
  2105. <member name="M:NPOI.SS.Formula.Functions.FreeRefFunction.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  2106. @param args the pre-Evaluated arguments for this function. args is never <code>null</code>,
  2107. nor are any of its elements.
  2108. @param ec primarily used to identify the source cell Containing the formula being Evaluated.
  2109. may also be used to dynamically create reference evals.
  2110. @return never <code>null</code>. Possibly an instance of <c>ErrorEval</c> in the case of
  2111. a specified Excel error (Exceptions are never thrown to represent Excel errors).
  2112. </member>
  2113. <member name="T:NPOI.SS.Formula.Atp.NetworkdaysFunction">
  2114. Implementation of Excel 'Analysis ToolPak' function NETWORKDAYS()<br/>
  2115. Returns the number of workdays given a starting and an ending date, considering an interval of holidays. A workday is any non
  2116. saturday/sunday date.
  2117. <p/>
  2118. <b>Syntax</b><br/>
  2119. <b>NETWORKDAYS</b>(<b>startDate</b>, <b>endDate</b>, holidays)
  2120. <p/>
  2121. @author jfaenomoto@gmail.com
  2122. </member>
  2123. <member name="M:NPOI.SS.Formula.Atp.NetworkdaysFunction.#ctor(NPOI.SS.Formula.Atp.ArgumentsEvaluator)">
  2124. Constructor.
  2125. @param anEvaluator an injected {@link ArgumentsEvaluator}.
  2126. </member>
  2127. <member name="M:NPOI.SS.Formula.Atp.NetworkdaysFunction.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  2128. Evaluate for NETWORKDAYS. Given two dates and a optional date or interval of holidays, determines how many working days are there
  2129. between those dates.
  2130. @return {@link ValueEval} for the number of days between two dates.
  2131. </member>
  2132. <member name="T:NPOI.SS.Formula.Eval.NotImplementedFunctionException">
  2133. An exception thrown by implementors of {@link FormulaEvaluator} when
  2134. attempting to evaluate a formula which requires a function that POI
  2135. does not (yet) support.
  2136. </member>
  2137. <member name="T:NPOI.SS.Formula.Atp.WorkdayCalculator">
  2138. A calculator for workdays, considering dates as excel representations.
  2139. @author jfaenomoto@gmail.com
  2140. </member>
  2141. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.#ctor">
  2142. Constructor.
  2143. </member>
  2144. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.CalculateWorkdays(System.Double,System.Double,System.Double[])">
  2145. Calculate how many workdays are there between a start and an end date, as excel representations, considering a range of holidays.
  2146. @param start start date.
  2147. @param end end date.
  2148. @param holidays an array of holidays.
  2149. @return number of workdays between start and end dates, including both dates.
  2150. </member>
  2151. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.CalculateWorkdays(System.Double,System.Int32,System.Double[])">
  2152. Calculate the workday past x workdays from a starting date, considering a range of holidays.
  2153. @param start start date.
  2154. @param workdays number of workdays to be past from starting date.
  2155. @param holidays an array of holidays.
  2156. @return date past x workdays.
  2157. </member>
  2158. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.PastDaysOfWeek(System.Double,System.Double,System.DayOfWeek)">
  2159. Calculates how many days of week past between a start and an end date.
  2160. @param start start date.
  2161. @param end end date.
  2162. @param dayOfWeek a day of week as represented by {@link Calendar} constants.
  2163. @return how many days of week past in this interval.
  2164. </member>
  2165. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.CalculateNonWeekendHolidays(System.Double,System.Double,System.Double[])">
  2166. Calculates how many holidays in a list are workdays, considering an interval of dates.
  2167. @param start start date.
  2168. @param end end date.
  2169. @param holidays an array of holidays.
  2170. @return number of holidays that occur in workdays, between start and end dates.
  2171. </member>
  2172. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.IsWeekend(System.Double)">
  2173. @param aDate a given date.
  2174. @return <code>true</code> if date is weekend, <code>false</code> otherwise.
  2175. </member>
  2176. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.IsHoliday(System.Double,System.Double[])">
  2177. @param aDate a given date.
  2178. @param holidays an array of holidays.
  2179. @return <code>true</code> if date is a holiday, <code>false</code> otherwise.
  2180. </member>
  2181. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.IsNonWorkday(System.Double,System.Double[])">
  2182. @param aDate a given date.
  2183. @param holidays an array of holidays.
  2184. @return <code>1</code> is not a workday, <code>0</code> otherwise.
  2185. </member>
  2186. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.IsInARange(System.Double,System.Double,System.Double)">
  2187. @param start start date.
  2188. @param end end date.
  2189. @param aDate a date to be analyzed.
  2190. @return <code>true</code> if aDate is between start and end dates, <code>false</code> otherwise.
  2191. </member>
  2192. <member name="T:NPOI.SS.Formula.Atp.WorkdayFunction">
  2193. Implementation of Excel 'Analysis ToolPak' function WORKDAY()<br/>
  2194. Returns the date past a number of workdays beginning at a start date, considering an interval of holidays. A workday is any non
  2195. saturday/sunday date.
  2196. <p/>
  2197. <b>Syntax</b><br/>
  2198. <b>WORKDAY</b>(<b>startDate</b>, <b>days</b>, holidays)
  2199. <p/>
  2200. @author jfaenomoto@gmail.com
  2201. </member>
  2202. <member name="M:NPOI.SS.Formula.Atp.WorkdayFunction.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  2203. Evaluate for WORKDAY. Given a date, a number of days and a optional date or interval of holidays, determines which date it is past
  2204. number of parametrized workdays.
  2205. @return {@link ValueEval} with date as its value.
  2206. </member>
  2207. <member name="T:NPOI.SS.Formula.Functions.BaseNumberUtils">
  2208. <p>Some utils for Converting from and to any base</p>
  2209. @author cedric dot walter @ gmail dot com
  2210. </member>
  2211. <member name="T:NPOI.SS.Formula.Functions.Bin2Dec">
  2212. Implementation for Excel Bin2Dec() function.<p/>
  2213. <p/>
  2214. <b>Syntax</b>:<br/> <b>Bin2Dec </b>(<b>number</b>)<br/>
  2215. <p/>
  2216. Converts a binary number to decimal.
  2217. <p/>
  2218. Number is the binary number you want to convert. Number cannot contain more than 10 characters (10 bits).
  2219. The most significant bit of number is the sign bit. The remaining 9 bits are magnitude bits.
  2220. Negative numbers are represented using two's-complement notation.
  2221. <p/>
  2222. Remark
  2223. If number is not a valid binary number, or if number contains more than 10 characters (10 bits),
  2224. BIN2DEC returns the #NUM! error value.
  2225. @author cedric dot walter @ gmail dot com
  2226. </member>
  2227. <member name="T:NPOI.SS.Formula.Functions.Fixed1ArgFunction">
  2228. Convenience base class for functions that must take exactly one argument.
  2229. @author Josh Micich
  2230. </member>
  2231. <member name="T:NPOI.SS.Formula.Functions.Function1Arg">
  2232. Implemented by all functions that can be called with one argument
  2233. @author Josh Micich
  2234. </member>
  2235. <member name="T:NPOI.SS.Formula.Functions.Function">
  2236. <summary>
  2237. Function serves as a marker interface.
  2238. </summary>
  2239. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  2240. </member>
  2241. <member name="M:NPOI.SS.Formula.Functions.Function.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],System.Int32,System.Int32)">
  2242. <summary>
  2243. Evaluates the specified args.
  2244. </summary>
  2245. <param name="args">the evaluated function arguments. Empty values are represented with BlankEval or MissingArgEval</param>
  2246. <param name="srcRowIndex">row index of the cell containing the formula under evaluation</param>
  2247. <param name="srcColumnIndex">column index of the cell containing the formula under evaluation</param>
  2248. <returns></returns>
  2249. </member>
  2250. <member name="M:NPOI.SS.Formula.Functions.Function1Arg.Evaluate(System.Int32,System.Int32,NPOI.SS.Formula.Eval.ValueEval)">
  2251. see {@link Function#Evaluate(ValueEval[], int, int)}
  2252. </member>
  2253. <member name="T:NPOI.SS.Formula.Functions.Code">
  2254. Implementation for Excel CODE () function.<p/>
  2255. <p/>
  2256. <b>Syntax</b>:<br/> <b>CODE </b>(<b>text</b> )<br/>
  2257. <p/>
  2258. Returns a numeric code for the first character in a text string. The returned code corresponds to the character set used by your computer.
  2259. <p/>
  2260. text The text for which you want the code of the first character.
  2261. @author cedric dot walter @ gmail dot com
  2262. </member>
  2263. <member name="T:NPOI.SS.Formula.Functions.Complex">
  2264. Implementation for Excel COMPLEX () function.<p/>
  2265. <p/>
  2266. <b>Syntax</b>:<br/> <b>COMPLEX </b>(<b>real_num</b>,<b>i_num</b>,<b>suffix </b> )<br/>
  2267. <p/>
  2268. Converts real and imaginary coefficients into a complex number of the form x + yi or x + yj.
  2269. <p/>
  2270. <p/>
  2271. All complex number functions accept "i" and "j" for suffix, but neither "I" nor "J".
  2272. Using uppercase results in the #VALUE! error value. All functions that accept two
  2273. or more complex numbers require that all suffixes match.
  2274. <p/>
  2275. <b>real_num</b> The real coefficient of the complex number.
  2276. If this argument is nonnumeric, this function returns the #VALUE! error value.
  2277. <p/>
  2278. <p/>
  2279. <b>i_num</b> The imaginary coefficient of the complex number.
  2280. If this argument is nonnumeric, this function returns the #VALUE! error value.
  2281. <p/>
  2282. <p/>
  2283. <b>suffix</b> The suffix for the imaginary component of the complex number.
  2284. <ul>
  2285. <li>If omitted, suffix is assumed to be "i".</li>
  2286. <li>If suffix is neither "i" nor "j", COMPLEX returns the #VALUE! error value.</li>
  2287. </ul>
  2288. @author cedric dot walter @ gmail dot com
  2289. </member>
  2290. <member name="T:NPOI.SS.Formula.Functions.Var2or3ArgFunction">
  2291. Convenience base class for any function which must take two or three
  2292. arguments
  2293. @author Josh Micich
  2294. </member>
  2295. <member name="T:NPOI.SS.Formula.Functions.Function2Arg">
  2296. Implemented by all functions that can be called with two arguments
  2297. @author Josh Micich
  2298. </member>
  2299. <member name="M:NPOI.SS.Formula.Functions.Function2Arg.Evaluate(System.Int32,System.Int32,NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.ValueEval)">
  2300. see {@link Function#Evaluate(ValueEval[], int, int)}
  2301. </member>
  2302. <member name="T:NPOI.SS.Formula.Functions.Function3Arg">
  2303. Implemented by all functions that can be called with three arguments
  2304. @author Josh Micich
  2305. </member>
  2306. <member name="M:NPOI.SS.Formula.Functions.Function3Arg.Evaluate(System.Int32,System.Int32,NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.ValueEval)">
  2307. see {@link Function#Evaluate(ValueEval[], int, int)}
  2308. </member>
  2309. <member name="T:NPOI.SS.Formula.Functions.Countifs">
  2310. Implementation for the function COUNTIFS
  2311. <p>
  2312. Syntax: COUNTIFS(criteria_range1, criteria1, [criteria_range2, criteria2])
  2313. </p>
  2314. </member>
  2315. <member name="T:NPOI.SS.Formula.Functions.Dec2Bin">
  2316. Implementation for Excel Bin2Dec() function.<p/>
  2317. <p/>
  2318. <b>Syntax</b>:<br/> <b>Bin2Dec </b>(<b>number</b>,<b>[places]</b> )<br/>
  2319. <p/>
  2320. Converts a decimal number to binary.
  2321. <p/>
  2322. The DEC2BIN function syntax has the following arguments:
  2323. <ul>
  2324. <li>Number Required. The decimal integer you want to Convert. If number is negative, valid place values are ignored and DEC2BIN returns a 10-character (10-bit) binary number in which the most significant bit is the sign bit. The remaining 9 bits are magnitude bits. Negative numbers are represented using two's-complement notation.</li>
  2325. <li>Places Optional. The number of characters to use. If places is omitted, DEC2BIN uses the minimum number of characters necessary. Places is useful for pAdding the return value with leading 0s (zeros).</li>
  2326. </ul>
  2327. <p/>
  2328. Remarks
  2329. <ul>
  2330. <li>If number &lt; -512 or if number &gt; 511, DEC2BIN returns the #NUM! error value.</li>
  2331. <li>If number is nonnumeric, DEC2BIN returns the #VALUE! error value.</li>
  2332. <li>If DEC2BIN requires more than places characters, it returns the #NUM! error value.</li>
  2333. <li>If places is not an integer, it is tRuncated.</li>
  2334. <li>If places is nonnumeric, DEC2BIN returns the #VALUE! error value.</li>
  2335. <li>If places is zero or negative, DEC2BIN returns the #NUM! error value.</li>
  2336. </ul>
  2337. @author cedric dot walter @ gmail dot com
  2338. </member>
  2339. <member name="T:NPOI.SS.Formula.Functions.Var1or2ArgFunction">
  2340. Convenience base class for any function which must take two or three
  2341. arguments
  2342. @author Josh Micich
  2343. </member>
  2344. <member name="T:NPOI.SS.Formula.Functions.Dec2Hex">
  2345. Implementation for Excel DELTA() function.<p/>
  2346. <p/>
  2347. <b>Syntax</b>:<br/> <b>DEC2HEX </b>(<b>number</b>,<b>places</b> )<br/>
  2348. <p/>
  2349. Converts a decimal number to hexadecimal.
  2350. The decimal integer you want to Convert. If number is negative, places is ignored
  2351. and this function returns a 10-character (40-bit) hexadecimal number in which the
  2352. most significant bit is the sign bit. The remaining 39 bits are magnitude bits.
  2353. Negative numbers are represented using two's-complement notation.
  2354. <ul>
  2355. <li>If number &lt; -549,755,813,888 or if number &gt; 549,755,813,887, this function returns the #NUM! error value.</li>
  2356. <li>If number is nonnumeric, this function returns the #VALUE! error value.</li>
  2357. </ul>
  2358. <h2>places</h2>
  2359. The number of characters to use. The places argument is useful for pAdding the
  2360. return value with leading 0s (zeros).
  2361. <ul>
  2362. <li>If this argument is omitted, this function uses the minimum number of characters necessary.</li>
  2363. <li>If this function requires more than places characters, it returns the #NUM! error value.</li>
  2364. <li>If this argument is nonnumeric, this function returns the #VALUE! error value.</li>
  2365. <li>If this argument is negative, this function returns the #NUM! error value.</li>
  2366. <li>If this argument Contains a decimal value, this function ignores the numbers to the right side of the decimal point.</li>
  2367. </ul>
  2368. @author cedric dot walter @ gmail dot com
  2369. </member>
  2370. <member name="T:NPOI.SS.Formula.Functions.Delta">
  2371. Implementation for Excel DELTA() function.<p/>
  2372. <p/>
  2373. <b>Syntax</b>:<br/> <b>DELTA </b>(<b>number1</b>,<b>number2</b> )<br/>
  2374. <p/>
  2375. Tests whether two values are Equal. Returns 1 if number1 = number2; returns 0 otherwise.
  2376. Use this function to filter a Set of values. For example, by summing several DELTA functions
  2377. you calculate the count of equal pairs. This function is also known as the Kronecker Delta function.
  2378. <ul>
  2379. <li>If number1 is nonnumeric, DELTA returns the #VALUE! error value.</li>
  2380. <li>If number2 is nonnumeric, DELTA returns the #VALUE! error value.</li>
  2381. </ul>
  2382. @author cedric dot walter @ gmail dot com
  2383. </member>
  2384. <member name="T:NPOI.SS.Formula.Functions.Fixed2ArgFunction">
  2385. Convenience base class for functions that must take exactly two arguments.
  2386. @author Josh Micich
  2387. </member>
  2388. <member name="T:NPOI.SS.Formula.Functions.DGet">
  2389. Implementation of the DGet function:
  2390. Finds the value of a column in an area with given conditions.
  2391. TODO:
  2392. - wildcards ? and * in string conditions
  2393. - functions as conditions
  2394. </member>
  2395. <member name="T:NPOI.SS.Formula.Functions.IDStarAlgorithm">
  2396. Interface specifying how an algorithm to be used by {@link DStarRunner} should look like.
  2397. Each implementing class should correspond to one of the D* functions.
  2398. </member>
  2399. <member name="M:NPOI.SS.Formula.Functions.IDStarAlgorithm.Reset">
  2400. Reset the state of this algorithm.
  2401. This is called before each run through a database.
  2402. </member>
  2403. <member name="M:NPOI.SS.Formula.Functions.IDStarAlgorithm.ProcessMatch(NPOI.SS.Formula.Eval.ValueEval)">
  2404. Process a match that is found during a run through a database.
  2405. @param eval ValueEval of the cell in the matching row. References will already be Resolved.
  2406. @return Whether we should continue iterating through the database.
  2407. </member>
  2408. <member name="P:NPOI.SS.Formula.Functions.IDStarAlgorithm.Result">
  2409. Return a result ValueEval that will be the result of the calculation.
  2410. This is always called at the end of a run through the database.
  2411. @return a ValueEval
  2412. </member>
  2413. <member name="T:NPOI.SS.Formula.Functions.DMin">
  2414. Implementation of the DMin function:
  2415. Finds the minimum value of a column in an area with given conditions.
  2416. TODO:
  2417. - wildcards ? and * in string conditions
  2418. - functions as conditions
  2419. </member>
  2420. <member name="T:NPOI.SS.Formula.Functions.DStarRunner">
  2421. This class performs a D* calculation. It takes an {@link IDStarAlgorithm} object and
  2422. uses it for calculating the result value. Iterating a database and Checking the
  2423. entries against the Set of conditions is done here.
  2424. </member>
  2425. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.solveReference(NPOI.SS.Formula.Eval.ValueEval)">
  2426. Resolve reference(-chains) until we have a normal value.
  2427. @param field a ValueEval which can be a RefEval.
  2428. @return a ValueEval which is guaranteed not to be a RefEval
  2429. @If a multi-sheet reference was found along the way.
  2430. </member>
  2431. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.GetColumnForTag(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.TwoDEval)">
  2432. Returns the first column index that matches the given name. The name can either be
  2433. a string or an integer, when it's an integer, then the respective column
  2434. (1 based index) is returned.
  2435. @param nameValueEval
  2436. @param db
  2437. @return the first column index that matches the given name (or int)
  2438. @
  2439. </member>
  2440. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.GetColumnForString(NPOI.SS.Formula.TwoDEval,System.String)">
  2441. For a given database returns the column number for a column heading.
  2442. @param db Database.
  2443. @param name Column heading.
  2444. @return Corresponding column number.
  2445. @If it's not possible to turn all headings into strings.
  2446. </member>
  2447. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.FullFillsConditions(NPOI.SS.Formula.TwoDEval,System.Int32,NPOI.SS.Formula.TwoDEval)">
  2448. Checks a row in a database against a condition database.
  2449. @param db Database.
  2450. @param row The row in the database to Check.
  2451. @param cdb The condition database to use for Checking.
  2452. @return Whether the row matches the conditions.
  2453. @If references could not be Resolved or comparison
  2454. operators and operands didn't match.
  2455. </member>
  2456. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.testNormalCondition(NPOI.SS.Formula.Eval.ValueEval,System.String)">
  2457. Test a value against a simple (&lt; &gt; &lt;= &gt;= = starts-with) condition string.
  2458. @param value The value to Check.
  2459. @param condition The condition to check for.
  2460. @return Whether the condition holds.
  2461. @If comparison operator and operands don't match.
  2462. </member>
  2463. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.testNumericCondition(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Functions.DStarRunner.Operator,System.String)">
  2464. Test whether a value matches a numeric condition.
  2465. @param valueEval Value to Check.
  2466. @param op Comparator to use.
  2467. @param condition Value to check against.
  2468. @return whether the condition holds.
  2469. @If it's impossible to turn the condition into a number.
  2470. </member>
  2471. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.GetStringFromValueEval(NPOI.SS.Formula.Eval.ValueEval)">
  2472. Takes a ValueEval and tries to retrieve a String value from it.
  2473. It tries to resolve references if there are any.
  2474. @param value ValueEval to retrieve the string from.
  2475. @return String corresponding to the given ValueEval.
  2476. @If it's not possible to retrieve a String value.
  2477. </member>
  2478. <member name="T:NPOI.SS.Formula.Functions.EOMonth">
  2479. Implementation for the Excel EOMONTH() function.<p/>
  2480. <p/>
  2481. EOMONTH() returns the date of the last day of a month..<p/>
  2482. <p/>
  2483. <b>Syntax</b>:<br/>
  2484. <b>EOMONTH</b>(<b>start_date</b>,<b>months</b>)<p/>
  2485. <p/>
  2486. <b>start_date</b> is the starting date of the calculation
  2487. <b>months</b> is the number of months to be Added to <b>start_date</b>,
  2488. to give a new date. For this new date, <b>EOMONTH</b> returns the date of
  2489. the last day of the month. <b>months</b> may be positive (in the future),
  2490. zero or negative (in the past).
  2491. </member>
  2492. <member name="T:NPOI.SS.Formula.Functions.Errortype">
  2493. Implementation for the ERROR.TYPE() Excel function.
  2494. <p>
  2495. <b>Syntax:</b><br/>
  2496. <b>ERROR.TYPE</b>(<b>errorValue</b>)</p>
  2497. <p>
  2498. Returns a number corresponding to the error type of the supplied argument.</p>
  2499. <p>
  2500. <table border="1" cellpadding="1" cellspacing="1" summary="Return values for ERROR.TYPE()">
  2501. <tr><td>errorValue</td><td>Return Value</td></tr>
  2502. <tr><td>#NULL!</td><td>1</td></tr>
  2503. <tr><td>#DIV/0!</td><td>2</td></tr>
  2504. <tr><td>#VALUE!</td><td>3</td></tr>
  2505. <tr><td>#REF!</td><td>4</td></tr>
  2506. <tr><td>#NAME?</td><td>5</td></tr>
  2507. <tr><td>#NUM!</td><td>6</td></tr>
  2508. <tr><td>#N/A!</td><td>7</td></tr>
  2509. <tr><td>everything else</td><td>#N/A!</td></tr>
  2510. </table>
  2511. Note - the results of ERROR.TYPE() are different to the constants defined in
  2512. <tt>ErrorConstants</tt>.
  2513. </p>
  2514. @author Josh Micich
  2515. </member>
  2516. <member name="T:NPOI.SS.Formula.Functions.FactDouble">
  2517. Implementation for Excel FACTDOUBLE() function.<p/>
  2518. <p/>
  2519. <b>Syntax</b>:<br/> <b>FACTDOUBLE </b>(<b>number</b>)<br/>
  2520. <p/>
  2521. Returns the double factorial of a number.
  2522. <p/>
  2523. Number is the value for which to return the double factorial. If number is not an integer, it is truncated.
  2524. <p/>
  2525. Remarks
  2526. <ul>
  2527. <li>If number is nonnumeric, FACTDOUBLE returns the #VALUE! error value.</li>
  2528. <li>If number is negative, FACTDOUBLE returns the #NUM! error value.</li>
  2529. </ul>
  2530. Use a cache for more speed of previously calculated factorial
  2531. @author cedric dot walter @ gmail dot com
  2532. </member>
  2533. <member name="T:NPOI.SS.Formula.Functions.Finance">
  2534. Implementation of the financial functions pmt, fv, ppmt, ipmt.
  2535. @author Mike Argyriou micharg@gmail.com
  2536. </member>
  2537. <member name="M:NPOI.SS.Formula.Functions.Finance.PMT(System.Double,System.Int32,System.Double,System.Double,System.Int32)">
  2538. Emulates Excel/Calc's PMT(interest_rate, number_payments, PV, FV, Type)
  2539. function, which calculates the payments for a loan or the future value of an investment
  2540. @param r
  2541. - periodic interest rate represented as a decimal.
  2542. @param nper
  2543. - number of total payments / periods.
  2544. @param pv
  2545. - present value -- borrowed or invested principal.
  2546. @param fv
  2547. - future value of loan or annuity.
  2548. @param type
  2549. - when payment is made: beginning of period is 1; end, 0.
  2550. @return <code>double</code> representing periodic payment amount.
  2551. </member>
  2552. <member name="M:NPOI.SS.Formula.Functions.Finance.PMT(System.Double,System.Int32,System.Double,System.Double)">
  2553. Overloaded pmt() call omitting type, which defaults to 0.
  2554. @see #pmt(double, int, double, double, int)
  2555. </member>
  2556. <member name="M:NPOI.SS.Formula.Functions.Finance.PMT(System.Double,System.Int32,System.Double)">
  2557. Overloaded pmt() call omitting fv and type, which both default to 0.
  2558. @see #pmt(double, int, double, double, int)
  2559. </member>
  2560. <member name="M:NPOI.SS.Formula.Functions.Finance.IPMT(System.Double,System.Int32,System.Int32,System.Double,System.Double,System.Int32)">
  2561. Emulates Excel/Calc's IPMT(interest_rate, period, number_payments, PV,
  2562. FV, Type) function, which calculates the portion of the payment at a
  2563. given period that is the interest on previous balance.
  2564. @param r
  2565. - periodic interest rate represented as a decimal.
  2566. @param per
  2567. - period (payment number) to check value at.
  2568. @param nper
  2569. - number of total payments / periods.
  2570. @param pv
  2571. - present value -- borrowed or invested principal.
  2572. @param fv
  2573. - future value of loan or annuity.
  2574. @param type
  2575. - when payment is made: beginning of period is 1; end, 0.
  2576. @return <code>double</code> representing interest portion of payment.
  2577. @see #pmt(double, int, double, double, int)
  2578. @see #fv(double, int, double, double, int)
  2579. </member>
  2580. <member name="M:NPOI.SS.Formula.Functions.Finance.PPMT(System.Double,System.Int32,System.Int32,System.Double,System.Double,System.Int32)">
  2581. Emulates Excel/Calc's PPMT(interest_rate, period, number_payments, PV,
  2582. FV, Type) function, which calculates the portion of the payment at a
  2583. given period that will apply to principal.
  2584. @param r
  2585. - periodic interest rate represented as a decimal.
  2586. @param per
  2587. - period (payment number) to check value at.
  2588. @param nper
  2589. - number of total payments / periods.
  2590. @param pv
  2591. - present value -- borrowed or invested principal.
  2592. @param fv
  2593. - future value of loan or annuity.
  2594. @param type
  2595. - when payment is made: beginning of period is 1; end, 0.
  2596. @return <code>double</code> representing principal portion of payment.
  2597. @see #pmt(double, int, double, double, int)
  2598. @see #ipmt(double, int, int, double, double, bool)
  2599. </member>
  2600. <member name="M:NPOI.SS.Formula.Functions.Finance.FV(System.Double,System.Int32,System.Double,System.Double,System.Int32)">
  2601. Emulates Excel/Calc's FV(interest_rate, number_payments, payment, PV,
  2602. Type) function, which calculates future value or principal at period N.
  2603. @param r
  2604. - periodic interest rate represented as a decimal.
  2605. @param nper
  2606. - number of total payments / periods.
  2607. @param pmt
  2608. - periodic payment amount.
  2609. @param pv
  2610. - present value -- borrowed or invested principal.
  2611. @param type
  2612. - when payment is made: beginning of period is 1; end, 0.
  2613. @return <code>double</code> representing future principal value.
  2614. </member>
  2615. <member name="M:NPOI.SS.Formula.Functions.Finance.FV(System.Double,System.Int32,System.Double,System.Double)">
  2616. Overloaded fv() call omitting type, which defaults to 0.
  2617. @see #fv(double, int, double, double, int)
  2618. </member>
  2619. <member name="T:NPOI.SS.Formula.Functions.Hex2Dec">
  2620. Implementation for Excel HEX2DEC() function.<p/>
  2621. <p/>
  2622. <b>Syntax</b>:<br/> <b>HEX2DEC </b>(<b>number</b>)<br/>
  2623. <p/>
  2624. Converts a hexadecimal number to decimal.
  2625. <p/>
  2626. Number is the hexadecimal number you want to Convert. Number cannot contain more than 10 characters (40 bits).
  2627. The most significant bit of number is the sign bit.
  2628. The remaining 39 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
  2629. Remark
  2630. If number is not a valid hexadecimal number, HEX2DEC returns the #NUM! error value.
  2631. @author cedric dot walter @ gmail dot com
  2632. </member>
  2633. <member name="T:NPOI.SS.Formula.Functions.Hyperlink">
  2634. Implementation of Excel HYPERLINK function.<p/>
  2635. In Excel this function has special behaviour - it causes the displayed cell value to behave like
  2636. a hyperlink in the GUI. From an evaluation perspective however, it is very simple.<p/>
  2637. <b>Syntax</b>:<br/>
  2638. <b>HYPERLINK</b>(<b>link_location</b>, friendly_name)<p/>
  2639. <b>link_location</b> The URL of the hyperlink <br/>
  2640. <b>friendly_name</b> (optional) the value to display<p/>
  2641. Returns last argument. Leaves type unchanged (does not convert to {@link org.apache.poi.ss.formula.eval.StringEval}).
  2642. @author Wayne Clingingsmith
  2643. </member>
  2644. <member name="T:NPOI.SS.Formula.Functions.Imaginary">
  2645. Implementation for Excel IMAGINARY() function.<p/>
  2646. <p/>
  2647. <b>Syntax</b>:<br/> <b>IMAGINARY </b>(<b>Inumber</b>)<br/>
  2648. <p/>
  2649. Returns the imaginary coefficient of a complex number in x + yi or x + yj text format.
  2650. <p/>
  2651. Inumber is a complex number for which you want the imaginary coefficient.
  2652. <p/>
  2653. Remarks
  2654. <ul>
  2655. <li>Use COMPLEX to convert real and imaginary coefficients into a complex number.</li>
  2656. </ul>
  2657. @author cedric dot walter @ gmail dot com
  2658. </member>
  2659. <member name="T:NPOI.SS.Formula.Functions.ImReal">
  2660. Implementation for Excel ImReal() function.<p/>
  2661. <p/>
  2662. <b>Syntax</b>:<br/> <b>ImReal </b>(<b>Inumber</b>)<br/>
  2663. <p/>
  2664. Returns the real coefficient of a complex number in x + yi or x + yj text format.
  2665. <p/>
  2666. Inumber A complex number for which you want the real coefficient.
  2667. <p/>
  2668. Remarks
  2669. <ul>
  2670. <li>If inumber is not in the form x + yi or x + yj, this function returns the #NUM! error value.</li>
  2671. <li>Use COMPLEX to convert real and imaginary coefficients into a complex number.</li>
  2672. </ul>
  2673. @author cedric dot walter @ gmail dot com
  2674. </member>
  2675. <member name="T:NPOI.SS.Formula.Functions.Intercept">
  2676. Implementation of Excel function INTERCEPT()<p/>
  2677. Calculates the INTERCEPT of the linear regression line that is used to predict y values from x values<br/>
  2678. (http://introcs.cs.princeton.edu/java/97data/LinearRegression.java.html)
  2679. <b>Syntax</b>:<br/>
  2680. <b>INTERCEPT</b>(<b>arrayX</b>, <b>arrayY</b>)<p/>
  2681. @author Johan Karlsteen
  2682. </member>
  2683. <member name="T:NPOI.SS.Formula.Functions.NumericFunction">
  2684. @author Amol S. Deshmukh &lt; amolweb at yahoo dot com &gt;
  2685. </member>
  2686. <member name="T:NPOI.SS.Formula.Functions.LinearRegressionFunction">
  2687. Base class for linear regression functions.
  2688. Calculates the linear regression line that is used to predict y values from x values<br/>
  2689. (http://introcs.cs.princeton.edu/java/97data/LinearRegression.java.html)
  2690. <b>Syntax</b>:<br/>
  2691. <b>INTERCEPT</b>(<b>arrayX</b>, <b>arrayY</b>)<p/>
  2692. or
  2693. <b>SLOPE</b>(<b>arrayX</b>, <b>arrayY</b>)<p/>
  2694. @author Johan Karlsteen
  2695. </member>
  2696. <member name="T:NPOI.SS.Formula.Functions.ValueVector">
  2697. Represents a single row or column within an <c>AreaEval</c>.
  2698. </member>
  2699. <member name="T:NPOI.SS.Formula.Functions.Mirr">
  2700. Calculates Modified internal rate of return. Syntax is MIRR(cash_flow_values, finance_rate, reinvest_rate)
  2701. <p>Returns the modified internal rate of return for a series of periodic cash flows. MIRR considers both the cost
  2702. of the investment and the interest received on reinvestment of cash.</p>
  2703. Values is an array or a reference to cells that contain numbers. These numbers represent a series of payments (negative values) and income (positive values) occurring at regular periods.
  2704. <ul>
  2705. <li>Values must contain at least one positive value and one negative value to calculate the modified internal rate of return. Otherwise, MIRR returns the #DIV/0! error value.</li>
  2706. <li>If an array or reference argument Contains text, logical values, or empty cells, those values are ignored; however, cells with the value zero are included.</li>
  2707. </ul>
  2708. Finance_rate is the interest rate you pay on the money used in the cash flows.
  2709. Reinvest_rate is the interest rate you receive on the cash flows as you reinvest them.
  2710. @author Carlos Delgado (carlos dot del dot est at gmail dot com)
  2711. @author Cédric Walter (cedric dot walter at gmail dot com)
  2712. @see <a href="http://en.wikipedia.org/wiki/MIRR">Wikipedia on MIRR</a>
  2713. @see <a href="http://office.microsoft.com/en-001/excel-help/mirr-HP005209180.aspx">Excel MIRR</a>
  2714. @see {@link Irr}
  2715. </member>
  2716. <member name="T:NPOI.SS.Formula.Functions.MultiOperandNumericFunction">
  2717. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  2718. This Is the base class for all excel function evaluator
  2719. classes that take variable number of operands, and
  2720. where the order of operands does not matter
  2721. </member>
  2722. <member name="M:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.CollectValues(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Functions.MultiOperandNumericFunction.DoubleList)">
  2723. Collects values from a single argument
  2724. </member>
  2725. <member name="M:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.GetNumberArray(NPOI.SS.Formula.Eval.ValueEval[])">
  2726. Returns a double array that contains values for the numeric cells
  2727. from among the list of operands. Blanks and Blank equivalent cells
  2728. are ignored. Error operands or cells containing operands of type
  2729. that are considered invalid and would result in #VALUE! error in
  2730. excel cause this function to return <c>null</c>.
  2731. @return never <c>null</c>
  2732. </member>
  2733. <member name="M:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.AreSubArraysConsistent(System.Double[][])">
  2734. Ensures that a two dimensional array has all sub-arrays present and the same Length
  2735. @return <c>false</c> if any sub-array Is missing, or Is of different Length
  2736. </member>
  2737. <member name="P:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.MaxNumOperands">
  2738. Maximum number of operands accepted by this function.
  2739. Subclasses may override to Change default value.
  2740. </member>
  2741. <member name="P:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.IsSubtotalCounted">
  2742. Whether to count nested subtotals.
  2743. </member>
  2744. <member name="T:NPOI.SS.Formula.Functions.Oct2Dec">
  2745. <p>Implementation for Excel Oct2Dec() function.</p>
  2746. <p>
  2747. Converts an octal number to decimal.
  2748. </p>
  2749. <p>
  2750. <b>Syntax</b>:<br/> <b>Oct2Dec </b>(<b>number</b> )
  2751. </p>
  2752. <p/>
  2753. Number is the octal number you want to Convert. Number may not contain more than 10 octal characters (30 bits).
  2754. The most significant bit of number is the sign bit. The remaining 29 bits are magnitude bits.
  2755. Negative numbers are represented using two's-complement notation..
  2756. <p/>
  2757. If number is not a valid octal number, OCT2DEC returns the #NUM! error value.
  2758. @author cedric dot walter @ gmail dot com
  2759. </member>
  2760. <member name="T:NPOI.SS.Formula.Functions.PPMT">
  2761. Compute the interest portion of a payment.
  2762. @author Mike Argyriou micharg@gmail.com
  2763. </member>
  2764. <member name="T:NPOI.SS.Formula.Functions.Quotient">
  2765. <p>Implementation for Excel QUOTIENT () function.</p>
  2766. <p>
  2767. <b>Syntax</b>:<br/> <b>QUOTIENT</b>(<b>Numerator</b>,<b>Denominator</b>)<br/>
  2768. </p>
  2769. <p>
  2770. Numerator is the dividend.
  2771. Denominator is the divisor.
  2772. Returns the integer portion of a division. Use this function when you want to discard the remainder of a division.
  2773. </p>
  2774. If either enumerator/denominator is non numeric, QUOTIENT returns the #VALUE! error value.
  2775. If denominator is Equals to zero, QUOTIENT returns the #DIV/0! error value.
  2776. @author cedric dot walter @ gmail dot com
  2777. </member>
  2778. <member name="T:NPOI.SS.Formula.Functions.Rank">
  2779. * Returns the rank of a number in a list of numbers. The rank of a number is its size relative to other values in a list.
  2780. * Syntax:
  2781. * RANK(number,ref,order)
  2782. * Number is the number whose rank you want to find.
  2783. * Ref is an array of, or a reference to, a list of numbers. Nonnumeric values in ref are ignored.
  2784. * Order is a number specifying how to rank number.
  2785. * If order is 0 (zero) or omitted, Microsoft Excel ranks number as if ref were a list sorted in descending order.
  2786. * If order is any nonzero value, Microsoft Excel ranks number as if ref were a list sorted in ascending order.
  2787. *
  2788. * @author Rubin Wang
  2789. </member>
  2790. <member name="T:NPOI.SS.Formula.Functions.Rate">
  2791. Implements the Excel Rate function
  2792. </member>
  2793. <member name="M:NPOI.SS.Formula.Functions.Rate.CheckValue(System.Double)">
  2794. Excel does not support infinities and NaNs, rather, it gives a #NUM! error in these cases
  2795. @throws EvaluationException (#NUM!) if result is NaN or Infinity
  2796. </member>
  2797. <member name="T:NPOI.SS.Formula.Functions.Rept">
  2798. Implementation for Excel REPT () function.<p/>
  2799. <p/>
  2800. <b>Syntax</b>:<br/> <b>REPT </b>(<b>text</b>,<b>number_times</b> )<br/>
  2801. <p/>
  2802. Repeats text a given number of times. Use REPT to fill a cell with a number of instances of a text string.
  2803. text : text The text that you want to repeat.
  2804. number_times: A positive number specifying the number of times to repeat text.
  2805. If number_times is 0 (zero), REPT returns "" (empty text).
  2806. If this argument contains a decimal value, this function ignores the numbers to the right side of the decimal point.
  2807. The result of the REPT function cannot be longer than 32,767 characters, or REPT returns #VALUE!.
  2808. @author cedric dot walter @ gmail dot com
  2809. </member>
  2810. <member name="T:NPOI.SS.Formula.Functions.Roman">
  2811. Implementation for Excel WeekNum() function.<p/>
  2812. <p/>
  2813. <b>Syntax</b>:<br/> <b>WeekNum </b>(<b>Serial_num</b>,<b>Return_type</b>)<br/>
  2814. <p/>
  2815. Returns a number that indicates where the week falls numerically within a year.
  2816. <p/>
  2817. <p/>
  2818. Serial_num is a date within the week. Dates should be entered by using the DATE function,
  2819. or as results of other formulas or functions. For example, use DATE(2008,5,23)
  2820. for the 23rd day of May, 2008. Problems can occur if dates are entered as text.
  2821. Return_type is a number that determines on which day the week begins. The default is 1.
  2822. 1 Week begins on Sunday. Weekdays are numbered 1 through 7.
  2823. 2 Week begins on Monday. Weekdays are numbered 1 through 7.
  2824. @author cedric dot walter @ gmail dot com
  2825. </member>
  2826. <member name="M:NPOI.SS.Formula.Functions.Roman.integerToRoman(System.Int32)">
  2827. Classic conversion.
  2828. @param number
  2829. @return
  2830. </member>
  2831. <member name="M:NPOI.SS.Formula.Functions.Roman.MakeConcise(System.String,System.Int32)">
  2832. Use conversion rule to factor some parts and make them more concise
  2833. @param result
  2834. @param form
  2835. @return
  2836. </member>
  2837. <member name="T:NPOI.SS.Formula.Functions.Slope">
  2838. Implementation of Excel function SLOPE()<p/>
  2839. Calculates the SLOPE of the linear regression line that is used to predict y values from x values<br/>
  2840. (http://introcs.cs.princeton.edu/java/97data/LinearRegression.java.html)
  2841. <b>Syntax</b>:<br/>
  2842. <b>SLOPE</b>(<b>arrayX</b>, <b>arrayY</b>)<p/>
  2843. @author Johan Karlsteen
  2844. </member>
  2845. <member name="T:NPOI.SS.Formula.Functions.Sumifs">
  2846. Implementation for the Excel function SUMIFS<br/>
  2847. <p>
  2848. Syntax : <br/>
  2849. SUMIFS ( <b>sum_range</b>, <b>criteria_range1</b>, <b>criteria1</b>,
  2850. [<b>criteria_range2</b>, <b>criteria2</b>], ...) <br/>
  2851. <ul>
  2852. <li><b>sum_range</b> Required. One or more cells to sum, including numbers or names, ranges,
  2853. or cell references that contain numbers. Blank and text values are ignored.</li>
  2854. <li><b>criteria1_range</b> Required. The first range in which
  2855. to evaluate the associated criteria.</li>
  2856. <li><b>criteria1</b> Required. The criteria in the form of a number, expression,
  2857. cell reference, or text that define which cells in the criteria_range1
  2858. argument will be added</li>
  2859. <li><b> criteria_range2, criteria2, ...</b> Optional. Additional ranges and their associated criteria.
  2860. Up to 127 range/criteria pairs are allowed.</li>
  2861. </ul>
  2862. </p>
  2863. @author Yegor Kozlov
  2864. </member>
  2865. <member name="M:NPOI.SS.Formula.Functions.Sumifs.ValidateCriteriaRanges(NPOI.SS.Formula.Eval.AreaEval[],NPOI.SS.Formula.Eval.AreaEval)">
  2866. Verify that each <code>criteriaRanges</code> argument contains the same number of rows and columns
  2867. as the <code>sumRange</code> argument
  2868. @throws EvaluationException if
  2869. </member>
  2870. <member name="M:NPOI.SS.Formula.Functions.Sumifs.SumMatchingCells(NPOI.SS.Formula.Eval.AreaEval[],NPOI.SS.Formula.Functions.IMatchPredicate[],NPOI.SS.Formula.Eval.AreaEval)">
  2871. @param ranges criteria ranges, each range must be of the same dimensions as <code>aeSum</code>
  2872. @param predicates array of predicates, a predicate for each value in <code>ranges</code>
  2873. @param aeSum the range to sum
  2874. @return the computed value
  2875. </member>
  2876. <member name="T:NPOI.SS.Formula.Functions.Proper">
  2877. <summary>
  2878. Implementation of the PROPER function:
  2879. Normalizes all words (separated by non-word characters) by
  2880. making the first letter upper and the rest lower case.
  2881. </summary>
  2882. </member>
  2883. <member name="T:NPOI.SS.Formula.Functions.TextFunction">
  2884. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  2885. </member>
  2886. <member name="F:NPOI.SS.Formula.Functions.TextFunction.TRIM">
  2887. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org &gt;
  2888. <summary>
  2889. An implementation of the TRIM function:
  2890. <para>
  2891. Removes leading and trailing spaces from value if evaluated operand value is string.
  2892. </para>
  2893. </summary>
  2894. </member>
  2895. <member name="F:NPOI.SS.Formula.Functions.TextFunction.MID">
  2896. <summary>
  2897. An implementation of the MID function
  2898. MID returns a specific number of
  2899. characters from a text string, starting at the specified position.
  2900. Syntax: MID(text, start_num, num_chars)
  2901. </summary>
  2902. </member>
  2903. <member name="F:NPOI.SS.Formula.Functions.TextFunction.FIND">
  2904. @author Torstein Tauno Svendsen (torstei@officenet.no)
  2905. <summary>
  2906. Implementation of the FIND() function.
  2907. <para>
  2908. Syntax: FIND(Find_text, within_text, start_num)
  2909. </para>
  2910. <para> FIND returns the character position of the first (case sensitive) occurrence of
  2911. Find_text inside within_text. The third parameter,
  2912. start_num, is optional (default=1) and specifies where to start searching
  2913. from. Character positions are 1-based.</para>
  2914. </summary>
  2915. </member>
  2916. <member name="F:NPOI.SS.Formula.Functions.TextFunction.SEARCH">
  2917. <summary>
  2918. Implementation of the FIND() function. SEARCH is a case-insensitive version of FIND()
  2919. <para>
  2920. Syntax: SEARCH(Find_text, within_text, start_num)
  2921. </para>
  2922. </summary>
  2923. </member>
  2924. <member name="T:NPOI.SS.Formula.Functions.WeekdayFunc">
  2925. Implementation for the Excel function WEEKDAY
  2926. @author Thies Wellpott
  2927. </member>
  2928. <member name="M:NPOI.SS.Formula.Functions.WeekdayFunc.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],System.Int32,System.Int32)">
  2929. * Perform WEEKDAY(date, returnOption) function.
  2930. * Note: Parameter texts are from German EXCEL-2010 help.
  2931. * Parameters in args[]:
  2932. * args[0] serialDate
  2933. * EXCEL-date value
  2934. * Standardmaessig ist der 1. Januar 1900 die fortlaufende Zahl 1 und
  2935. * der 1. Januar 2008 die fortlaufende Zahl 39.448, da dieser Tag nach 39.448 Tagen
  2936. * auf den 01.01.1900 folgt.
  2937. * @return Option (optional)
  2938. * Bestimmt den Rueckgabewert:
  2939. 1 oder nicht angegeben Zahl 1 (Sonntag) bis 7 (Samstag). Verhaelt sich wie fruehere Microsoft Excel-Versionen.
  2940. 2 Zahl 1 (Montag) bis 7 (Sonntag).
  2941. 3 Zahl 0 (Montag) bis 6 (Sonntag).
  2942. 11 Die Zahlen 1 (Montag) bis 7 (Sonntag)
  2943. 12 Die Zahlen 1 (Dienstag) bis 7 (Montag)
  2944. 13 Die Zahlen 1 (Mittwoch) bis 7 (Dienstag)
  2945. 14 Die Zahlen 1 (Donnerstag) bis 7 (Mittwoch)
  2946. 15 Die Zahlen 1 (Freitag) bis 7 (Donnerstag)
  2947. 16 Die Zahlen 1 (Samstag) bis 7 (Freitag)
  2948. 17 Die Zahlen 1 (Sonntag) bis 7 (Samstag)
  2949. </member>
  2950. <member name="T:NPOI.SS.Formula.Functions.WeekNum">
  2951. Implementation for Excel WeekNum() function.<p/>
  2952. <p/>
  2953. <b>Syntax</b>:<br/> <b>WeekNum </b>(<b>Serial_num</b>,<b>Return_type</b>)<br/>
  2954. <p/>
  2955. Returns a number that indicates where the week falls numerically within a year.
  2956. <p/>
  2957. <p/>
  2958. Serial_num is a date within the week. Dates should be entered by using the DATE function,
  2959. or as results of other formulas or functions. For example, use DATE(2008,5,23)
  2960. for the 23rd day of May, 2008. Problems can occur if dates are entered as text.
  2961. Return_type is a number that determines on which day the week begins. The default is 1.
  2962. 1 Week begins on Sunday. Weekdays are numbered 1 through 7.
  2963. 2 Week begins on Monday. Weekdays are numbered 1 through 7.
  2964. @author cedric dot walter @ gmail dot com
  2965. </member>
  2966. <member name="T:NPOI.SS.Formula.PTG.Area3DPxg">
  2967. <p>Title: XSSF Area 3D Reference (Sheet + Area)</p>
  2968. <p>Description: Defined an area in an external or different sheet. </p>
  2969. <p>REFERENCE: </p>
  2970. <p>This is XSSF only, as it stores the sheet / book references
  2971. in String form. The HSSF equivalent using indexes is {@link Area3DPtg}</p>
  2972. </member>
  2973. <member name="T:NPOI.SS.Formula.PTG.AreaPtgBase">
  2974. Specifies a rectangular area of cells A1:A4 for instance.
  2975. @author andy
  2976. @author Jason Height (jheight at chariot dot net dot au)
  2977. </member>
  2978. <member name="T:NPOI.SS.Formula.PTG.OperandPtg">
  2979. @author Josh Micich
  2980. </member>
  2981. <member name="T:NPOI.SS.Formula.PTG.Ptg">
  2982. <c>Ptg</c> represents a syntactic token in a formula. 'PTG' is an acronym for
  2983. '<b>p</b>arse <b>t</b>hin<b>g</b>'. Originally, the name referred to the single
  2984. byte identifier at the start of the token, but in POI, <c>Ptg</c> encapsulates
  2985. the whole formula token (initial byte + value data).
  2986. <c>Ptg</c>s are logically arranged in a tree representing the structure of the
  2987. Parsed formula. However, in BIFF files <c>Ptg</c>s are written/Read in
  2988. <em>Reverse-Polish Notation</em> order. The RPN ordering also simplifies formula
  2989. evaluation logic, so POI mostly accesses <c>Ptg</c>s in the same way.
  2990. @author andy
  2991. @author avik
  2992. @author Jason Height (jheight at chariot dot net dot au)
  2993. </member>
  2994. <member name="M:NPOI.SS.Formula.PTG.Ptg.ReadTokens(System.Int32,NPOI.Util.ILittleEndianInput)">
  2995. Reads <c>size</c> bytes of the input stream, to Create an array of <c>Ptg</c>s.
  2996. Extra data (beyond <c>size</c>) may be Read if and <c>ArrayPtg</c>s are present.
  2997. </member>
  2998. <member name="M:NPOI.SS.Formula.PTG.Ptg.Clone">
  2999. @return a distinct copy of this <c>Ptg</c> if the class is mutable, or the same instance
  3000. if the class is immutable.
  3001. </member>
  3002. <member name="M:NPOI.SS.Formula.PTG.Ptg.GetEncodedSize(NPOI.SS.Formula.PTG.Ptg[])">
  3003. This method will return the same result as {@link #getEncodedSizeWithoutArrayData(Ptg[])}
  3004. if there are no array tokens present.
  3005. @return the full size taken to encode the specified <c>Ptg</c>s
  3006. </member>
  3007. <member name="M:NPOI.SS.Formula.PTG.Ptg.GetEncodedSizeWithoutArrayData(NPOI.SS.Formula.PTG.Ptg[])">
  3008. Used to calculate value that should be encoded at the start of the encoded Ptg token array;
  3009. @return the size of the encoded Ptg tokens not including any trailing array data.
  3010. </member>
  3011. <member name="M:NPOI.SS.Formula.PTG.Ptg.SerializePtgs(NPOI.SS.Formula.PTG.Ptg[],System.Byte[],System.Int32)">
  3012. Writes the ptgs to the data buffer, starting at the specified offset.
  3013. <br/>
  3014. The 2 byte encode Length field is <b>not</b> written by this method.
  3015. @return number of bytes written
  3016. </member>
  3017. <member name="M:NPOI.SS.Formula.PTG.Ptg.Write(NPOI.Util.ILittleEndianOutput)">
  3018. Write this Ptg to a byte array
  3019. </member>
  3020. <member name="M:NPOI.SS.Formula.PTG.Ptg.ToFormulaString">
  3021. return a string representation of this token alone
  3022. </member>
  3023. <member name="M:NPOI.SS.Formula.PTG.Ptg.ToString">
  3024. Overridden toString method to Ensure object hash is not printed.
  3025. This helps Get rid of gratuitous diffs when comparing two dumps
  3026. Subclasses may output more relevant information by overriding this method
  3027. </member>
  3028. <member name="P:NPOI.SS.Formula.PTG.Ptg.Size">
  3029. @return the encoded Length of this Ptg, including the initial Ptg type identifier byte.
  3030. </member>
  3031. <member name="P:NPOI.SS.Formula.PTG.Ptg.IsBaseToken">
  3032. @return <c>false</c> if this token is classified as 'reference', 'value', or 'array'
  3033. </member>
  3034. <member name="P:NPOI.SS.Formula.PTG.Ptg.PtgClass">
  3035. @return the 'operand class' (REF/VALUE/ARRAY) for this Ptg
  3036. </member>
  3037. <member name="P:NPOI.SS.Formula.PTG.Ptg.RVAType">
  3038. Debug / diagnostic method to get this token's 'operand class' type.
  3039. @return 'R' for 'reference', 'V' for 'value', 'A' for 'array' and '.' for base tokens
  3040. </member>
  3041. <member name="P:NPOI.SS.Formula.PTG.OperandPtg.IsBaseToken">
  3042. All Operand <c>Ptg</c>s are classifed ('relative', 'value', 'array')
  3043. </member>
  3044. <member name="T:NPOI.SS.Formula.PTG.AreaI">
  3045. Common interface for AreaPtg and Area3DPtg, and their
  3046. child classes.
  3047. </member>
  3048. <member name="P:NPOI.SS.Formula.PTG.AreaI.FirstRow">
  3049. @return the first row in the area
  3050. </member>
  3051. <member name="P:NPOI.SS.Formula.PTG.AreaI.LastRow">
  3052. @return last row in the range (x2 in x1,y1-x2,y2)
  3053. </member>
  3054. <member name="P:NPOI.SS.Formula.PTG.AreaI.FirstColumn">
  3055. @return the first column number in the area.
  3056. </member>
  3057. <member name="P:NPOI.SS.Formula.PTG.AreaI.LastColumn">
  3058. @return lastcolumn in the area
  3059. </member>
  3060. <member name="M:NPOI.SS.Formula.PTG.AreaPtgBase.NotImplemented">
  3061. TODO - (May-2008) fix subclasses of AreaPtg 'AreaN~' which are used in shared formulas.
  3062. see similar comment in ReferencePtg
  3063. </member>
  3064. <member name="F:NPOI.SS.Formula.PTG.AreaPtgBase.field_1_first_row">
  3065. zero based, Unsigned 16 bit
  3066. </member>
  3067. <member name="F:NPOI.SS.Formula.PTG.AreaPtgBase.field_2_last_row">
  3068. zero based, Unsigned 16 bit
  3069. </member>
  3070. <member name="F:NPOI.SS.Formula.PTG.AreaPtgBase.field_3_first_column">
  3071. zero based, Unsigned 8 bit
  3072. </member>
  3073. <member name="F:NPOI.SS.Formula.PTG.AreaPtgBase.field_4_last_column">
  3074. zero based, Unsigned 8 bit
  3075. </member>
  3076. <member name="M:NPOI.SS.Formula.PTG.AreaPtgBase.SetLastColumnRaw(System.Int16)">
  3077. Set the last column irrespective of the bitmasks
  3078. </member>
  3079. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.FirstRow">
  3080. @return the first row in the area
  3081. </member>
  3082. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.LastRow">
  3083. @return last row in the range (x2 in x1,y1-x2,y2)
  3084. </member>
  3085. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.FirstColumn">
  3086. @return the first column number in the area.
  3087. </member>
  3088. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.IsFirstRowRelative">
  3089. @return whether or not the first row is a relative reference or not.
  3090. </member>
  3091. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.IsFirstColRelative">
  3092. @return Isrelative first column to relative or not
  3093. </member>
  3094. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.LastColumn">
  3095. @return lastcolumn in the area
  3096. </member>
  3097. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.LastColumnRaw">
  3098. @return last column and bitmask (the raw field)
  3099. </member>
  3100. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.IsLastRowRelative">
  3101. @return last row relative or not
  3102. </member>
  3103. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.IsLastColRelative">
  3104. @return lastcol relative or not
  3105. </member>
  3106. <member name="T:NPOI.SS.Formula.PTG.Pxg3D">
  3107. An XSSF only special kind of Ptg, which stores a range of
  3108. sheet / book references in string form.
  3109. </member>
  3110. <member name="T:NPOI.SS.Formula.PTG.Pxg">
  3111. An XSSF only special kind of Ptg, which stores the sheet / book
  3112. reference in string form.
  3113. </member>
  3114. <member name="T:NPOI.SS.Formula.PTG.Deleted3DPxg">
  3115. An XSSF only representation of a reference to a deleted area
  3116. </member>
  3117. <member name="T:NPOI.SS.Formula.PTG.NameXPxg">
  3118. A Name, be that a Named Range or a Function / User Defined
  3119. Function, Addressed in the HSSF External Sheet style.
  3120. <p>This is XSSF only, as it stores the sheet / book references
  3121. in String form. The HSSF equivalent using indexes is {@link NameXPtg}</p>
  3122. </member>
  3123. <member name="T:NPOI.SS.Formula.PTG.Ref3DPxg">
  3124. <p>Title: XSSF 3D Reference</p>
  3125. <p>Description: Defines a cell in an external or different sheet.</p>
  3126. <p>REFERENCE: </p>
  3127. <p>This is XSSF only, as it stores the sheet / book references
  3128. in String form. The HSSF equivalent using indexes is {@link Ref3DPtg}</p>
  3129. </member>
  3130. <member name="T:NPOI.SS.Formula.PTG.RefPtgBase">
  3131. ReferencePtgBase - handles references (such as A1, A2, IA4)
  3132. @author Andrew C. Oliver (acoliver@apache.org)
  3133. @author Jason Height (jheight at chariot dot net dot au)
  3134. </member>
  3135. <member name="F:NPOI.SS.Formula.PTG.RefPtgBase.field_1_row">
  3136. The row index - zero based Unsigned 16 bit value
  3137. </member>
  3138. <member name="F:NPOI.SS.Formula.PTG.RefPtgBase.field_2_col">
  3139. Field 2
  3140. - lower 8 bits is the zero based Unsigned byte column index
  3141. - bit 16 - IsRowRelative
  3142. - bit 15 - IsColumnRelative
  3143. </member>
  3144. <member name="M:NPOI.SS.Formula.PTG.RefPtgBase.#ctor(System.String)">
  3145. Takes in a String representation of a cell reference and Fills out the
  3146. numeric fields.
  3147. </member>
  3148. <member name="P:NPOI.SS.Formula.PTG.RefPtgBase.Row">
  3149. Returns the row number as a short, which will be
  3150. wrapped (negative) for values between 32769 and 65535
  3151. </member>
  3152. <member name="P:NPOI.SS.Formula.PTG.RefPtgBase.RowAsInt">
  3153. Returns the row number as an int, between 0 and 65535
  3154. </member>
  3155. <member name="T:NPOI.SS.Formula.SheetRangeEvaluator">
  3156. Evaluator for returning cells or sheets for a range of sheets
  3157. </member>
  3158. <member name="T:NPOI.SS.Formula.ThreeDEval">
  3159. Optional Extension to the likes of {@link AreaEval} and
  3160. {@link NPOI.SS.Formula.Eval.AreaEvalBase},
  3161. which allows for looking up 3D (sheet+row+column) Evaluations
  3162. </member>
  3163. <member name="T:NPOI.SS.Formula.TwoDEval">
  3164. Common interface of {@link AreaEval} and {@link org.apache.poi.ss.formula.eval.AreaEvalBase},
  3165. for 2D (row+column) evaluations
  3166. </member>
  3167. <member name="T:NPOI.SS.Formula.Eval.ValueEval">
  3168. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  3169. </member>
  3170. <member name="M:NPOI.SS.Formula.TwoDEval.GetValue(System.Int32,System.Int32)">
  3171. @param rowIndex relative row index (zero based)
  3172. @param columnIndex relative column index (zero based)
  3173. @return element at the specified row and column position
  3174. </member>
  3175. <member name="M:NPOI.SS.Formula.TwoDEval.GetRow(System.Int32)">
  3176. @param rowIndex relative row index (zero based)
  3177. @return a single row {@link TwoDEval}
  3178. </member>
  3179. <member name="M:NPOI.SS.Formula.TwoDEval.GetColumn(System.Int32)">
  3180. @param columnIndex relative column index (zero based)
  3181. @return a single column {@link TwoDEval}
  3182. </member>
  3183. <member name="M:NPOI.SS.Formula.TwoDEval.IsSubTotal(System.Int32,System.Int32)">
  3184. @return true if the cell at row and col is a subtotal
  3185. </member>
  3186. <member name="P:NPOI.SS.Formula.TwoDEval.IsRow">
  3187. @return <c>true</c> if the area has just a single row, this also includes
  3188. the trivial case when the area has just a single cell.
  3189. </member>
  3190. <member name="P:NPOI.SS.Formula.TwoDEval.IsColumn">
  3191. @return <c>true</c> if the area has just a single column, this also includes
  3192. the trivial case when the area has just a single cell.
  3193. </member>
  3194. <member name="M:NPOI.SS.Formula.ThreeDEval.GetValue(System.Int32,System.Int32,System.Int32)">
  3195. @param sheetIndex sheet index (zero based)
  3196. @param rowIndex relative row index (zero based)
  3197. @param columnIndex relative column index (zero based)
  3198. @return element at the specified row and column position
  3199. </member>
  3200. <member name="T:NPOI.SS.Formula.Udf.IndexedUDFFinder">
  3201. A UDFFinder that can retrieve functions both by name and by fake index.
  3202. @author Yegor Kozlov
  3203. </member>
  3204. <member name="T:NPOI.SS.Formula.Udf.AggregatingUDFFinder">
  3205. Collects Add-in libraries and VB macro functions toGether into one UDF Finder
  3206. @author PUdalau
  3207. </member>
  3208. <member name="T:NPOI.SS.Formula.Udf.UDFFinder">
  3209. Common interface for "Add-in" libraries and user defined function libraries.
  3210. @author PUdalau
  3211. </member>
  3212. <member name="M:NPOI.SS.Formula.Udf.UDFFinder.FindFunction(System.String)">
  3213. Returns executor by specified name. Returns <code>null</code> if the function name is unknown.
  3214. @param name Name of function.
  3215. @return Function executor.
  3216. </member>
  3217. <member name="M:NPOI.SS.Formula.Udf.AggregatingUDFFinder.FindFunction(System.String)">
  3218. <summary>
  3219. Returns executor by specified name.
  3220. </summary>
  3221. <param name="name">Name of function.</param>
  3222. <returns>Function executor. null if not found</returns>
  3223. </member>
  3224. <member name="M:NPOI.SS.Formula.Udf.AggregatingUDFFinder.Add(NPOI.SS.Formula.Udf.UDFFinder)">
  3225. <summary>
  3226. Add a new toolpack
  3227. </summary>
  3228. <param name="toolPack"></param>
  3229. </member>
  3230. <member name="T:NPOI.SS.Formula.IWorkbookEvaluatorProvider">
  3231. Provides access to a {@link WorkbookEvaluator}, eg for use with
  3232. {@link CollaboratingWorkbooksEnvironment}
  3233. For POI internal use only
  3234. </member>
  3235. <member name="M:NPOI.SS.Formula.IWorkbookEvaluatorProvider.GetWorkbookEvaluator">
  3236. Provide the underlying WorkbookEvaluator
  3237. </member>
  3238. <member name="T:NPOI.HSSF.EventUserModel.DummyRecord.DummyRecordBase">
  3239. </member>
  3240. <member name="T:NPOI.HSSF.Record.Aggregates.ChartSubstreamRecordAggregate">
  3241. Manages the all the records associated with a chart sub-stream.<br/>
  3242. Includes the Initial {@link BOFRecord} and {@link EOFRecord}.
  3243. @author Josh Micich
  3244. </member>
  3245. <member name="F:NPOI.HSSF.Record.Aggregates.ChartSubstreamRecordAggregate._recs">
  3246. All the records between BOF and EOF
  3247. </member>
  3248. <member name="T:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock">
  3249. Groups the sheet protection records for a worksheet.
  3250. <p/>
  3251. See OOO excelfileformat.pdf sec 4.18.2 'Sheet Protection in a Workbook
  3252. (BIFF5-BIFF8)'
  3253. @author Josh Micich
  3254. </member>
  3255. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.#ctor">
  3256. Creates an empty WorksheetProtectionBlock
  3257. </member>
  3258. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.IsComponentRecord(System.Int32)">
  3259. @return <c>true</c> if the specified Record sid is one belonging to
  3260. the 'Page Settings Block'.
  3261. </member>
  3262. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.AddRecords(NPOI.HSSF.Model.RecordStream)">
  3263. This method Reads {@link WorksheetProtectionBlock} records from the supplied RecordStream
  3264. until the first non-WorksheetProtectionBlock record is encountered. As each record is Read,
  3265. it is incorporated into this WorksheetProtectionBlock.
  3266. <p/>
  3267. As per the OOO documentation, the protection block records can be expected to be written
  3268. toGether (with no intervening records), but earlier versions of POI (prior to Jun 2009)
  3269. didn't do this. Workbooks with sheet protection Created by those earlier POI versions
  3270. seemed to be valid (Excel opens them OK). So PO allows continues to support Reading of files
  3271. with non continuous worksheet protection blocks.
  3272. <p/>
  3273. <b>Note</b> - when POI Writes out this WorksheetProtectionBlock, the records will always be
  3274. written in one consolidated block (in the standard ordering) regardless of how scattered the
  3275. records were when they were originally Read.
  3276. </member>
  3277. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.ProtectSheet(System.String,System.Boolean,System.Boolean)">
  3278. <summary>
  3279. protect a spreadsheet with a password (not encrypted, just sets protect flags and the password.)
  3280. </summary>
  3281. <param name="password">password to set;Pass <code>null</code> to remove all protection</param>
  3282. <param name="shouldProtectObjects">shouldProtectObjects are protected</param>
  3283. <param name="shouldProtectScenarios">shouldProtectScenarios are protected</param>
  3284. </member>
  3285. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.CreateObjectProtect">
  3286. <summary>
  3287. Creates an ObjectProtect record with protect set to false.
  3288. </summary>
  3289. <returns></returns>
  3290. </member>
  3291. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.CreateScenarioProtect">
  3292. <summary>
  3293. Creates a ScenarioProtect record with protect set to false.
  3294. </summary>
  3295. <returns></returns>
  3296. </member>
  3297. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.CreatePassword">
  3298. <summary>
  3299. Creates a Password record with password set to 0x0000.
  3300. </summary>
  3301. <returns></returns>
  3302. </member>
  3303. <member name="P:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.Protect">
  3304. <summary>
  3305. the ProtectRecord. If one is not contained in the sheet, then one is created.
  3306. </summary>
  3307. </member>
  3308. <member name="P:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.Password">
  3309. <summary>
  3310. the PasswordRecord. If one is not Contained in the sheet, then one is Created.
  3311. </summary>
  3312. </member>
  3313. <member name="T:NPOI.HSSF.Record.Chart.Chart3dRecord">
  3314. <summary>
  3315. The Chart3d record specifies that the plot area of the chart group is rendered in a 3-D scene
  3316. and also specifies the attributes of the 3-D plot area. The preceding chart group type MUST be
  3317. of type bar, pie, line, area, or surface.
  3318. </summary>
  3319. <remarks>
  3320. author: Antony liu (antony.apollo at gmail.com)
  3321. </remarks>
  3322. </member>
  3323. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Rotation">
  3324. <summary>
  3325. A signed integer that specifies the clockwise rotation, in degrees, of the 3-D plot area
  3326. around a vertical line through the center of the 3-D plot area. MUST be greater than or
  3327. equal to 0 and MUST be less than or equal to 360.
  3328. </summary>
  3329. </member>
  3330. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Elev">
  3331. <summary>
  3332. A signed integer that specifies the rotation, in degrees, of the 3-D plot area around
  3333. a horizontal line through the center of the 3-D plot area.MUST be greater than or equal
  3334. to -90 and MUST be less than or equal to 90.
  3335. </summary>
  3336. </member>
  3337. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Dist">
  3338. <summary>
  3339. A signed integer that specifies the field of view angle for the 3-D plot area.
  3340. MUST be greater than or equal to zero and less than 200.
  3341. </summary>
  3342. </member>
  3343. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Height">
  3344. <summary>
  3345. If fNotPieChart is 0, then this is an unsigned integer that specifies the thickness of the pie for a pie chart group.
  3346. If fNotPieChart is 1, then this is a signed integer that specifies the height of the 3-D plot area as a percentage of its width.
  3347. </summary>
  3348. </member>
  3349. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Depth">
  3350. <summary>
  3351. A signed integer that specifies the depth of the 3-D plot area as a percentage of its width.
  3352. MUST be greater than or equal to 1 and less than or equal to 2000.
  3353. </summary>
  3354. </member>
  3355. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Gap">
  3356. <summary>
  3357. An unsigned integer that specifies the width of the gap between the series and the front and
  3358. back edges of the 3-D plot area as a percentage of the data point depth divided by 2.
  3359. If fCluster is not 1 and chart group type is not a bar then pcGap also specifies distance
  3360. between adjacent series as a percentage of the data point depth. MUST be less than or equal to 500.
  3361. </summary>
  3362. </member>
  3363. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.IsPerspective">
  3364. <summary>
  3365. A bit that specifies whether the 3-D plot area is rendered with a vanishing point.
  3366. If fNotPieChart is 0 the value MUST be 0. If fNotPieChart is 1 then the value
  3367. MUST be a value from the following
  3368. true Perspective vanishing point applied based on value of pcDist.
  3369. false No vanishing point applied.
  3370. </summary>
  3371. </member>
  3372. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.IsCluster">
  3373. <summary>
  3374. specifies whether data points are clustered together in a bar chart group.
  3375. If chart group type is not bar or pie, value MUST be ignored. If chart group type is pie,
  3376. value MUST be 0. If chart group type is bar, then the value MUST be a value from the following
  3377. true Data points are clustered.
  3378. false Data points are not clustered.
  3379. </summary>
  3380. </member>
  3381. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Is3DScaling">
  3382. <summary>
  3383. A bit that specifies whether the height of the 3-D plot area is automatically determined.
  3384. If fNotPieChart is 0 then this MUST be 0. If fNotPieChart is 1 then the value MUST be a value from the following table:
  3385. false The value of pcHeight is used to determine the height of the 3-D plot area
  3386. true The height of the 3-D plot area is automatically determined
  3387. </summary>
  3388. </member>
  3389. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.IsNotPieChart">
  3390. <summary>
  3391. A bit that specifies whether the chart group type is pie. MUST be a value from the following :
  3392. false Chart group type MUST be pie.
  3393. true Chart group type MUST not be pie.
  3394. </summary>
  3395. </member>
  3396. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.IsWalls2D">
  3397. <summary>
  3398. Whether the walls are rendered in 2-D. If fPerspective is 1 then this MUST be ignored.
  3399. If the chart group type is not bar, area or pie this MUST be ignored.
  3400. If the chart group is of type bar and fCluster is 0, then this MUST be ignored.
  3401. If the chart group type is pie this MUST be 0 and MUST be ignored.
  3402. If the chart group type is bar or area, then the value MUST be a value from the following
  3403. false Chart walls and floor are rendered in 3D.
  3404. true Chart walls are rendered in 2D and the chart floor is not rendered.
  3405. </summary>
  3406. </member>
  3407. <member name="T:NPOI.HSSF.Record.Chart.CrtLayout12ARecord">
  3408. <summary>
  3409. The CrtLayout12A record specifies layout information for a plot area.
  3410. </summary>
  3411. <remarks>
  3412. author: Antony liu (antony.apollo at gmail.com)
  3413. </remarks>
  3414. </member>
  3415. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.IsLayoutTargetInner">
  3416. <summary>
  3417. specifies the type of plot area for the layout target.
  3418. false Outer plot area - The bounding rectangle that includes the axis labels, axis titles, data table (2) and plot area of the chart.
  3419. true Inner plot area – The rectangle bounded by the chart axes.
  3420. </summary>
  3421. </member>
  3422. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.CheckSum">
  3423. <summary>
  3424. specifies the checksum
  3425. </summary>
  3426. </member>
  3427. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.XTL">
  3428. <summary>
  3429. specifies the horizontal offset of the plot area’s upper-left corner, relative to the upper-left corner of the chart area
  3430. </summary>
  3431. </member>
  3432. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.YTL">
  3433. <summary>
  3434. specifies the vertical offset of the plot area’s upper-left corner, relative to the upper-left corner of the chart area
  3435. </summary>
  3436. </member>
  3437. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.XBR">
  3438. <summary>
  3439. specifies the width of the plot area
  3440. </summary>
  3441. </member>
  3442. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.YBR">
  3443. <summary>
  3444. specifies the height of the plot area
  3445. </summary>
  3446. </member>
  3447. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.XMode">
  3448. <summary>
  3449. A CrtLayout12Mode structure that specifies the meaning of x.
  3450. </summary>
  3451. </member>
  3452. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.YMode">
  3453. <summary>
  3454. A CrtLayout12Mode structure that specifies the meaning of y.
  3455. </summary>
  3456. </member>
  3457. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.WidthMode">
  3458. <summary>
  3459. A CrtLayout12Mode structure that specifies the meaning of dx.
  3460. </summary>
  3461. </member>
  3462. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.HeightMode">
  3463. <summary>
  3464. A CrtLayout12Mode structure that specifies the meaning of dy.
  3465. </summary>
  3466. </member>
  3467. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.X">
  3468. <summary>
  3469. An Xnum (section 2.5.342) value that specifies a horizontal offset. The meaning is determined by wXMode.
  3470. </summary>
  3471. </member>
  3472. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.Y">
  3473. <summary>
  3474. An Xnum value that specifies a vertical offset. The meaning is determined by wYMode.
  3475. </summary>
  3476. </member>
  3477. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.DX">
  3478. <summary>
  3479. An Xnum value that specifies a width or an horizontal offset. The meaning is determined by wWidthMode.
  3480. </summary>
  3481. </member>
  3482. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.DY">
  3483. <summary>
  3484. An Xnum value that specifies a height or an vertical offset. The meaning is determined by wHeightMode.
  3485. </summary>
  3486. </member>
  3487. <member name="T:NPOI.HSSF.Record.Chart.CrtLayout12Mode">
  3488. <summary>
  3489. The CrtLayout12Mode specifies a layout mode. Each layout mode specifies a different
  3490. meaning of the x, y, dx, and dy fields of CrtLayout12 and CrtLayout12A.
  3491. </summary>
  3492. </member>
  3493. <member name="F:NPOI.HSSF.Record.Chart.CrtLayout12Mode.L12MAUTO">
  3494. <summary>
  3495. Position and dimension (2) are determined by the application. x, y, dx and dy MUST be ignored.
  3496. </summary>
  3497. </member>
  3498. <member name="F:NPOI.HSSF.Record.Chart.CrtLayout12Mode.L12MFACTOR">
  3499. <summary>
  3500. x and y specify the offset of the top left corner, relative to its default position,
  3501. as a fraction of the chart area. MUST be greater than or equal to -1.0 and MUST be
  3502. less than or equal to 1.0. dx and dy specify the width and height, as a fraction of
  3503. the chart area, MUST be greater than or equal to 0.0, and MUST be less than or equal to 1.0.
  3504. </summary>
  3505. </member>
  3506. <member name="F:NPOI.HSSF.Record.Chart.CrtLayout12Mode.L12MEDGE">
  3507. <summary>
  3508. x and y specify the offset of the upper-left corner; dx and dy specify the offset of the bottom-right corner.
  3509. x, y, dx and dy are specified relative to the upper-left corner of the chart area as a fraction of the chart area.
  3510. x, y, dx and dy MUST be greater than or equal to 0.0, and MUST be less than or equal to 1.0.
  3511. </summary>
  3512. </member>
  3513. <member name="T:NPOI.HSSF.Record.Chart.CrtLayout12Record">
  3514. <summary>
  3515. The CrtLayout12 record specifies the layout information for attached label, when contained
  3516. in the sequence of records that conforms to the ATTACHEDLABEL rule,
  3517. or legend, when contained in the sequence of records that conforms to the LD rule.
  3518. </summary>
  3519. </member>
  3520. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.AutoLayoutType">
  3521. <summary>
  3522. automatic layout type of the legend.
  3523. MUST be ignored when this record is in the sequence of records that conforms to the ATTACHEDLABEL rule.
  3524. MUST be a value from the following table:
  3525. 0x0 Align to the bottom
  3526. 0x1 Align to top right corner
  3527. 0x2 Align to the top
  3528. 0x3 Align to the right
  3529. 0x4 Align to the left
  3530. </summary>
  3531. </member>
  3532. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.CheckSum">
  3533. <summary>
  3534. specifies the checksum of the values in the order as follows,
  3535. </summary>
  3536. </member>
  3537. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.XMode">
  3538. <summary>
  3539. A CrtLayout12Mode structure that specifies the meaning of x.
  3540. </summary>
  3541. </member>
  3542. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.YMode">
  3543. <summary>
  3544. A CrtLayout12Mode structure that specifies the meaning of y.
  3545. </summary>
  3546. </member>
  3547. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.WidthMode">
  3548. <summary>
  3549. A CrtLayout12Mode structure that specifies the meaning of dx.
  3550. </summary>
  3551. </member>
  3552. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.HeightMode">
  3553. <summary>
  3554. A CrtLayout12Mode structure that specifies the meaning of dy.
  3555. </summary>
  3556. </member>
  3557. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.X">
  3558. <summary>
  3559. An Xnum (section 2.5.342) value that specifies a horizontal offset. The meaning is determined by wXMode.
  3560. </summary>
  3561. </member>
  3562. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.Y">
  3563. <summary>
  3564. An Xnum value that specifies a vertical offset. The meaning is determined by wYMode.
  3565. </summary>
  3566. </member>
  3567. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.DX">
  3568. <summary>
  3569. An Xnum value that specifies a width or an horizontal offset. The meaning is determined by wWidthMode.
  3570. </summary>
  3571. </member>
  3572. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.DY">
  3573. <summary>
  3574. An Xnum value that specifies a height or an vertical offset. The meaning is determined by wHeightMode.
  3575. </summary>
  3576. </member>
  3577. <member name="T:NPOI.HSSF.Record.Chart.CrtMlFrtRecord">
  3578. <summary>
  3579. The CrtMlFrt record specifies additional properties for chart elements, as specified by
  3580. the Chart Sheet Substream ABNF. These properties complement the record to which they
  3581. correspond, and are stored as a structure chain defined in XmlTkChain. An application
  3582. can ignore this record without loss of functionality, except for the additional properties.
  3583. If this record is longer than 8224 bytes, it MUST be split into several records. The first
  3584. section of the data appears in this record and subsequent sections appear in one or more
  3585. CrtMlFrtContinue records that follow this record.
  3586. </summary>
  3587. <remarks>
  3588. author: Antony liu (antony.apollo at gmail.com)
  3589. </remarks>
  3590. </member>
  3591. <member name="T:NPOI.HSSF.Record.Chart.MarkerFormatRecord">
  3592. <summary>
  3593. specifies the color, size, and shape of the associated data markers that appear on line, radar,
  3594. and scatter chart groups. The associated data markers are specified by the preceding DataFormat record.
  3595. </summary>
  3596. <remarks>
  3597. author: Antony liu (antony.apollo at gmail.com)
  3598. </remarks>
  3599. </member>
  3600. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.RGBFore">
  3601. <summary>
  3602. the border color of the data marker.
  3603. </summary>
  3604. </member>
  3605. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.RGBBack">
  3606. <summary>
  3607. the interior color of the data marker.
  3608. </summary>
  3609. </member>
  3610. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.DataMarkerType">
  3611. <summary>
  3612. the type of data marker.
  3613. </summary>
  3614. </member>
  3615. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.Auto">
  3616. <summary>
  3617. whether the data marker is automatically generated.
  3618. false The data marker is not automatically generated.
  3619. true The data marker type, size, and color are automatically generated and the values are set accordingly in this record.
  3620. </summary>
  3621. </member>
  3622. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.NotShowInt">
  3623. <summary>
  3624. whether to show the data marker interior.
  3625. false The data marker interior is shown.
  3626. true The data marker interior is not shown.
  3627. </summary>
  3628. </member>
  3629. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.NotShowBorder">
  3630. <summary>
  3631. whether to show the data marker border.
  3632. false The data marker border is shown.
  3633. true The data marker border is not shown.
  3634. </summary>
  3635. </member>
  3636. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.IcvFore">
  3637. <summary>
  3638. the border color of the data marker.
  3639. </summary>
  3640. </member>
  3641. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.IcvBack">
  3642. <summary>
  3643. the interior color of the data marker.
  3644. </summary>
  3645. </member>
  3646. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.Size">
  3647. <summary>
  3648. specifies the size in twips of the data marker.
  3649. </summary>
  3650. </member>
  3651. <member name="T:NPOI.HSSF.Record.Chart.PieFormatRecord">
  3652. <summary>
  3653. The PieFormat record specifies the distance of a data point or data points in a series from the center of one of the following:
  3654. The plot area for a doughnut or pie chart group.
  3655. The primary pie in a pie of pie or bar of pie chart group.
  3656. The secondary bar/pie of a pie of pie chart group.
  3657. </summary>
  3658. <remarks>
  3659. author: Antony liu (antony.apollo at gmail.com)
  3660. </remarks>
  3661. </member>
  3662. <member name="P:NPOI.HSSF.Record.Chart.PieFormatRecord.Explode">
  3663. <summary>
  3664. A signed integer that specifies the distance of a data point or data points in a series from the center of one of the following:
  3665. The plot area for a doughnut or pie chart group.
  3666. The primary pie in a pie of pie or bar of pie chart group.
  3667. The secondary bar/pie of a pie of pie chart group.
  3668. </summary>
  3669. </member>
  3670. <member name="T:NPOI.HSSF.Record.Chart.PieRecord">
  3671. <summary>
  3672. The Pie record specifies that the chart group is a pie chart group or
  3673. a doughnut chart group, and specifies the chart group attributes.
  3674. </summary>
  3675. <remarks>
  3676. author: Antony liu (antony.apollo at gmail.com)
  3677. </remarks>
  3678. </member>
  3679. <member name="P:NPOI.HSSF.Record.Chart.PieRecord.Start">
  3680. <summary>
  3681. An unsigned integer that specifies the starting angle of the first data point,
  3682. clockwise from the top of the circle. MUST be less than or equal to 360.
  3683. </summary>
  3684. </member>
  3685. <member name="P:NPOI.HSSF.Record.Chart.PieRecord.Dount">
  3686. <summary>
  3687. An unsigned integer that specifies the size of the center hole in a doughnut chart group
  3688. as a percentage of the plot area size. MUST be a value from the following table:
  3689. 0 Pie chart group.
  3690. 10 to 90 Doughnut chart group.
  3691. </summary>
  3692. </member>
  3693. <member name="P:NPOI.HSSF.Record.Chart.PieRecord.HasShadow">
  3694. <summary>
  3695. A bit that specifies whether one data point or more data points in the chart group have shadows.
  3696. </summary>
  3697. </member>
  3698. <member name="P:NPOI.HSSF.Record.Chart.PieRecord.ShowLdrLines">
  3699. <summary>
  3700. A bit that specifies whether the leader lines to the data labels are shown.
  3701. </summary>
  3702. </member>
  3703. <member name="T:NPOI.HSSF.Record.Common.FeatFormulaErr2">
  3704. FeatFormulaErr2 (Formula Evaluation Shared Feature) common record part
  3705. This record part specifies Formula Evaluation &amp; Error Ignoring data
  3706. for a sheet, stored as part of a Shared Feature. It can be found in
  3707. records such as {@link FeatRecord}.
  3708. For the full meanings of the flags, see pages 669 and 670
  3709. of the Excel binary file format documentation.
  3710. </member>
  3711. <member name="T:NPOI.HSSF.Record.Common.SharedFeature">
  3712. Common Interface for all Shared Features
  3713. </member>
  3714. <member name="F:NPOI.HSSF.Record.Common.FeatFormulaErr2.errorCheck">
  3715. What errors we should ignore
  3716. </member>
  3717. <member name="T:NPOI.HSSF.Record.Common.FeatProtection">
  3718. Title: FeatProtection (Protection Shared Feature) common record part
  3719. This record part specifies Protection data for a sheet, stored
  3720. as part of a Shared Feature. It can be found in records such
  3721. as {@link FeatRecord}
  3722. </member>
  3723. <member name="F:NPOI.HSSF.Record.Common.FeatProtection.passwordVerifier">
  3724. 0 means no password. Otherwise indicates the
  3725. password verifier algorithm (same kind as
  3726. {@link PasswordRecord} and
  3727. {@link PasswordRev4Record})
  3728. </member>
  3729. <member name="T:NPOI.HSSF.Record.Common.FeatSmartTag">
  3730. Title: FeatSmartTag (Smart Tag Shared Feature) common record part
  3731. This record part specifies Smart Tag data for a sheet, stored as part
  3732. of a Shared Feature. It can be found in records such as {@link FeatRecord}.
  3733. It is made up of a hash, and a Set of Factoid Data that Makes up
  3734. the smart tags.
  3735. For more details, see page 669 of the Excel binary file
  3736. format documentation.
  3737. </member>
  3738. <member name="T:NPOI.HSSF.Record.Common.FtrHeader">
  3739. Title: FtrHeader (Future Record Header) common record part
  3740. This record part specifies a header for a Ftr (Future)
  3741. style record, which includes extra attributes above and
  3742. beyond those of a traditional record.
  3743. </member>
  3744. <member name="F:NPOI.HSSF.Record.Common.FtrHeader.recordType">
  3745. This MUST match the type on the Containing record
  3746. </member>
  3747. <member name="F:NPOI.HSSF.Record.Common.FtrHeader.grbitFrt">
  3748. This is a FrtFlags
  3749. </member>
  3750. <member name="F:NPOI.HSSF.Record.Common.FtrHeader.reserved">
  3751. MUST be 8 bytes and all zero
  3752. </member>
  3753. <member name="T:NPOI.HSSF.Record.UnicodeString">
  3754. Title: Unicode String<p/>
  3755. Description: Unicode String - just standard fields that are in several records.
  3756. It is considered more desirable then repeating it in all of them.<p/>
  3757. This is often called a XLUnicodeRichExtendedString in MS documentation.<p/>
  3758. REFERENCE: PG 264 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<p/>
  3759. REFERENCE: PG 951 Excel Binary File Format (.xls) Structure Specification v20091214
  3760. </member>
  3761. <member name="M:NPOI.HSSF.Record.UnicodeString.Equals(System.Object)">
  3762. Our handling of Equals is inconsistent with CompareTo. The trouble is because we don't truely understand
  3763. rich text fields yet it's difficult to make a sound comparison.
  3764. @param o The object to Compare.
  3765. @return true if the object is actually Equal.
  3766. </member>
  3767. <member name="M:NPOI.HSSF.Record.UnicodeString.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  3768. construct a unicode string record and fill its fields, ID is ignored
  3769. @param in the RecordInputstream to read the record from
  3770. </member>
  3771. <member name="M:NPOI.HSSF.Record.UnicodeString.AddFormatRun(NPOI.HSSF.Record.UnicodeString.FormatRun)">
  3772. Adds a font run to the formatted string.
  3773. If a font run exists at the current charcter location, then it is
  3774. Replaced with the font run to be Added.
  3775. </member>
  3776. <member name="M:NPOI.HSSF.Record.UnicodeString.SwapFontUse(System.Int16,System.Int16)">
  3777. Swaps all use in the string of one font index
  3778. for use of a different font index.
  3779. Normally only called when fonts have been
  3780. Removed / re-ordered
  3781. </member>
  3782. <member name="M:NPOI.HSSF.Record.UnicodeString.ToString">
  3783. unlike the real records we return the same as "getString()" rather than debug info
  3784. @see #getDebugInfo()
  3785. @return String value of the record
  3786. </member>
  3787. <member name="M:NPOI.HSSF.Record.UnicodeString.GetDebugInfo">
  3788. return a character representation of the fields of this record
  3789. @return String of output for biffviewer etc.
  3790. </member>
  3791. <member name="M:NPOI.HSSF.Record.UnicodeString.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  3792. Serialises out the String. There are special rules
  3793. about where we can and can't split onto
  3794. Continue records.
  3795. </member>
  3796. <member name="P:NPOI.HSSF.Record.UnicodeString.CharCount">
  3797. get the number of characters in the string,
  3798. as an un-wrapped int
  3799. @return number of characters
  3800. </member>
  3801. <member name="P:NPOI.HSSF.Record.UnicodeString.OptionFlags">
  3802. Get the option flags which among other things return if this is a 16-bit or
  3803. 8 bit string
  3804. @return optionflags bitmask
  3805. </member>
  3806. <member name="P:NPOI.HSSF.Record.UnicodeString.String">
  3807. @return the actual string this Contains as a java String object
  3808. </member>
  3809. <member name="P:NPOI.HSSF.Record.UnicodeString.ExtRst.DataSize">
  3810. Returns our size, excluding our
  3811. 4 byte header
  3812. </member>
  3813. <member name="T:NPOI.HSSF.Record.Cont.ContinuableRecordInput">
  3814. A decorated {@link RecordInputStream} that can read primitive data types
  3815. (short, int, long, etc.) spanned across a {@link ContinueRecord } boundary.
  3816. <p>
  3817. Most records construct themselves from {@link RecordInputStream}.
  3818. This class assumes that a {@link ContinueRecord} record break always occurs at the type boundary,
  3819. however, it is not always so.
  3820. </p>
  3821. Two attachments to <a href="https://issues.apache.org/bugzilla/Show_bug.cgi?id=50779">Bugzilla 50779</a>
  3822. demonstrate that a CONTINUE break can appear right in between two bytes of a unicode character
  3823. or between two bytes of a <code>short</code>. The problematic portion of the data is
  3824. in a Asian Phonetic Settings Block (ExtRst) of a UnicodeString.
  3825. <p>
  3826. {@link RecordInputStream} greedily requests the bytes to be read and stumbles on such files with a
  3827. "Not enough data (1) to read requested (2) bytes" exception. The <code>ContinuableRecordInput</code>
  3828. class circumvents this "type boundary" rule and Reads data byte-by-byte rolling over CONTINUE if necessary.
  3829. </p>
  3830. <p>
  3831. YK: For now (March 2011) this class is only used to read
  3832. @link NPOI.HSSF.Record.Common.UnicodeString.ExtRst} blocks of a UnicodeString.
  3833. </p>
  3834. @author Yegor Kozlov
  3835. </member>
  3836. <member name="T:NPOI.Util.ILittleEndianInput">
  3837. @author Josh Micich
  3838. </member>
  3839. <member name="T:NPOI.HSSF.Record.FeatHdrRecord">
  3840. Title: FeatHdr (Feature Header) Record
  3841. This record specifies common information for Shared Features, and
  3842. specifies the beginning of a collection of records to define them.
  3843. The collection of data (Globals Substream ABNF, macro sheet substream
  3844. ABNF or worksheet substream ABNF) specifies Shared Feature data.
  3845. </member>
  3846. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.SHAREDFEATURES_ISFPROTECTION">
  3847. Specifies the enhanced protection type. Used to protect a
  3848. shared workbook by restricting access to some areas of it
  3849. </member>
  3850. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.SHAREDFEATURES_ISFFEC2">
  3851. Specifies that formula errors should be ignored
  3852. </member>
  3853. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.SHAREDFEATURES_ISFFACTOID">
  3854. Specifies the smart tag type. Recognises certain
  3855. types of entries (proper names, dates/times etc) and
  3856. flags them for action
  3857. </member>
  3858. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.SHAREDFEATURES_ISFLIST">
  3859. Specifies the shared list type. Used for a table
  3860. within a sheet
  3861. </member>
  3862. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.cbHdrData">
  3863. 0x00000000 = rgbHdrData not present
  3864. 0xffffffff = rgbHdrData present
  3865. </member>
  3866. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.rgbHdrData">
  3867. We need a BOFRecord to make sense of this...
  3868. </member>
  3869. <member name="T:NPOI.HSSF.Record.FeatRecord">
  3870. Title: Feat (Feature) Record
  3871. This record specifies Shared Features data. It is normally paired
  3872. up with a {@link FeatHdrRecord}.
  3873. </member>
  3874. <member name="F:NPOI.HSSF.Record.FeatRecord.isf_sharedFeatureType">
  3875. See SHAREDFEATURES_* on {@link FeatHdrRecord}
  3876. </member>
  3877. <member name="F:NPOI.HSSF.Record.FeatRecord.cbFeatData">
  3878. Only matters if type is ISFFEC2
  3879. </member>
  3880. <member name="F:NPOI.HSSF.Record.FeatRecord.sharedFeature">
  3881. Contents depends on isf_sharedFeatureType :
  3882. ISFPROTECTION -> FeatProtection
  3883. ISFFEC2 -> FeatFormulaErr2
  3884. ISFFACTOID -> FeatSmartTag
  3885. </member>
  3886. <member name="M:NPOI.HSSF.Record.FtCblsSubRecord.#ctor">
  3887. Construct a new <code>FtCblsSubRecord</code> and
  3888. fill its data with the default values
  3889. </member>
  3890. <member name="M:NPOI.HSSF.Record.FtCblsSubRecord.ToString">
  3891. Convert this record to string.
  3892. Used by BiffViewer and other utilities.
  3893. </member>
  3894. <member name="M:NPOI.HSSF.Record.FtCblsSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  3895. Serialize the record data into the supplied array of bytes
  3896. @param out the stream to serialize into
  3897. </member>
  3898. <member name="P:NPOI.HSSF.Record.FtCblsSubRecord.Sid">
  3899. @return id of this record.
  3900. </member>
  3901. <member name="T:NPOI.HSSF.Record.SheetExtRecord">
  3902. <summary>
  3903. </summary>
  3904. </member>
  3905. <member name="F:NPOI.HSSF.XmlTkBlob.xtHeader">
  3906. <summary>
  3907. The xtHeader.drType field MUST be equal to 0x07.
  3908. </summary>
  3909. </member>
  3910. <member name="F:NPOI.HSSF.XmlTkBool.xtHeader">
  3911. <summary>
  3912. The xtHeader.drType field MUST be equal to 0x02.
  3913. </summary>
  3914. </member>
  3915. <member name="F:NPOI.HSSF.XmlTkDouble.xtHeader">
  3916. <summary>
  3917. The xtHeader.drType field MUST be equal to 0x03.
  3918. </summary>
  3919. </member>
  3920. <member name="F:NPOI.HSSF.XmlTkDWord.xtHeader">
  3921. <summary>
  3922. The xtHeader.drType field MUST be equal to 0x04.
  3923. </summary>
  3924. </member>
  3925. <member name="F:NPOI.HSSF.XmlTkEnd.xtHeader">
  3926. <summary>
  3927. The xtHeader.drType field MUST be equal to 0x01.
  3928. </summary>
  3929. </member>
  3930. <member name="F:NPOI.HSSF.XmlTkString.xtHeader">
  3931. <summary>
  3932. The xtHeader.drType field MUST be equal to 0x05.
  3933. </summary>
  3934. </member>
  3935. <member name="F:NPOI.HSSF.XmlTkString.rgbValue">
  3936. <summary>
  3937. An array of Unicode characters. The size of the array, in characters, is specified
  3938. by the cchValue field. The size of the field, in bytes, MUST equal the result of
  3939. the following formula:cchValue * 2.
  3940. </summary>
  3941. </member>
  3942. <member name="F:NPOI.HSSF.XmlTkStyle.chartStyle">
  3943. <summary>
  3944. The chartStyle.xtHeader.xmlTkTag MUST be equal to 0x0003.
  3945. </summary>
  3946. </member>
  3947. <member name="F:NPOI.HSSF.XmlTkTickMarkSkipFrt.nInterval">
  3948. <summary>
  3949. The nInterval.xtHeader.xmlTkTag field MUST be equal to 0x0052.
  3950. </summary>
  3951. </member>
  3952. <member name="T:NPOI.HSSF.UserModel.DVConstraint">
  3953. @author Josh Micich
  3954. </member>
  3955. <member name="M:NPOI.SS.UserModel.IDataValidationConstraint.GetValidationType">
  3956. @return data validation type of this constraint
  3957. @see ValidationType
  3958. </member>
  3959. <member name="P:NPOI.SS.UserModel.IDataValidationConstraint.Operator">
  3960. @return the operator used for this constraint
  3961. @see OperatorType
  3962. <summary>
  3963. get or set then comparison operator for this constraint
  3964. </summary>
  3965. </member>
  3966. <member name="P:NPOI.SS.UserModel.IDataValidationConstraint.Formula1">
  3967. <summary>
  3968. get or set the formula for expression 1. May be <code>null</code>
  3969. </summary>
  3970. </member>
  3971. <member name="P:NPOI.SS.UserModel.IDataValidationConstraint.Formula2">
  3972. <summary>
  3973. get or set the formula for expression 2. May be <code>null</code>
  3974. </summary>
  3975. </member>
  3976. <member name="M:NPOI.HSSF.UserModel.DVConstraint.#ctor(System.String,System.String[])">
  3977. Creates a list constraint
  3978. </member>
  3979. <member name="M:NPOI.HSSF.UserModel.DVConstraint.CreateNumericConstraint(System.Int32,System.Int32,System.String,System.String)">
  3980. Creates a number based data validation constraint. The text values entered for expr1 and expr2
  3981. can be either standard Excel formulas or formatted number values. If the expression starts
  3982. with '=' it is Parsed as a formula, otherwise it is Parsed as a formatted number.
  3983. @param validationType one of {@link NPOI.SS.UserModel.DataValidationConstraint.ValidationType#ANY},
  3984. {@link NPOI.SS.UserModel.DataValidationConstraint.ValidationType#DECIMAL},
  3985. {@link NPOI.SS.UserModel.DataValidationConstraint.ValidationType#INTEGER},
  3986. {@link NPOI.SS.UserModel.DataValidationConstraint.ValidationType#TEXT_LENGTH}
  3987. @param comparisonOperator any constant from {@link NPOI.SS.UserModel.DataValidationConstraint.OperatorType} enum
  3988. @param expr1 date formula (when first char is '=') or formatted number value
  3989. @param expr2 date formula (when first char is '=') or formatted number value
  3990. </member>
  3991. <member name="M:NPOI.HSSF.UserModel.DVConstraint.CreateTimeConstraint(System.Int32,System.String,System.String)">
  3992. Creates a time based data validation constraint. The text values entered for expr1 and expr2
  3993. can be either standard Excel formulas or formatted time values. If the expression starts
  3994. with '=' it is Parsed as a formula, otherwise it is Parsed as a formatted time. To parse
  3995. formatted times, two formats are supported: "HH:MM" or "HH:MM:SS". This is contrary to
  3996. Excel which uses the default time format from the OS.
  3997. @param comparisonOperator constant from {@link NPOI.SS.UserModel.DataValidationConstraint.OperatorType} enum
  3998. @param expr1 date formula (when first char is '=') or formatted time value
  3999. @param expr2 date formula (when first char is '=') or formatted time value
  4000. </member>
  4001. <member name="M:NPOI.HSSF.UserModel.DVConstraint.CreateDateConstraint(System.Int32,System.String,System.String,System.String)">
  4002. Creates a date based data validation constraint. The text values entered for expr1 and expr2
  4003. can be either standard Excel formulas or formatted date values. If the expression starts
  4004. with '=' it is Parsed as a formula, otherwise it is Parsed as a formatted date (Excel uses
  4005. the same convention). To parse formatted dates, a date format needs to be specified. This
  4006. is contrary to Excel which uses the default short date format from the OS.
  4007. @param comparisonOperator constant from {@link NPOI.SS.UserModel.DataValidationConstraint.OperatorType} enum
  4008. @param expr1 date formula (when first char is '=') or formatted date value
  4009. @param expr2 date formula (when first char is '=') or formatted date value
  4010. @param dateFormat ignored if both expr1 and expr2 are formulas. Default value is "YYYY/MM/DD"
  4011. otherwise any other valid argument for <c>SimpleDateFormat</c> can be used
  4012. @see <a href='http://java.sun.com/j2se/1.5.0/docs/api/java/text/DateFormat.html'>SimpleDateFormat</a>
  4013. </member>
  4014. <member name="M:NPOI.HSSF.UserModel.DVConstraint.GetFormulaFromTextExpression(System.String)">
  4015. Distinguishes formula expressions from simple value expressions. This logic is only
  4016. required by a few factory methods in this class that create data validation constraints
  4017. from more or less the same parameters that would have been entered in the Excel UI. The
  4018. data validation dialog box uses the convention that formulas begin with '='. Other methods
  4019. in this class follow the POI convention (formulas and values are distinct), so the '='
  4020. convention is not used there.
  4021. @param textExpr a formula or value expression
  4022. @return all text After '=' if textExpr begins with '='. Otherwise <code>null</code> if textExpr does not begin with '='
  4023. </member>
  4024. <member name="M:NPOI.HSSF.UserModel.DVConstraint.ConvertNumber(System.String)">
  4025. @return <code>null</code> if numberStr is <code>null</code>
  4026. </member>
  4027. <member name="M:NPOI.HSSF.UserModel.DVConstraint.ConvertTime(System.String)">
  4028. @return <code>null</code> if timeStr is <code>null</code>
  4029. </member>
  4030. <member name="M:NPOI.HSSF.UserModel.DVConstraint.ConvertDate(System.String,NPOI.SS.Util.SimpleDateFormat)">
  4031. @param dateFormat pass <code>null</code> for default YYYYMMDD
  4032. @return <code>null</code> if timeStr is <code>null</code>
  4033. </member>
  4034. <member name="M:NPOI.HSSF.UserModel.DVConstraint.CreateFormulas(NPOI.HSSF.UserModel.HSSFSheet)">
  4035. @return both Parsed formulas (for expression 1 and 2).
  4036. </member>
  4037. <member name="M:NPOI.HSSF.UserModel.DVConstraint.ConvertDoubleFormula(System.String,System.Double,NPOI.HSSF.UserModel.HSSFSheet)">
  4038. @return The Parsed token array representing the formula or value specified.
  4039. Empty array if both formula and value are <code>null</code>
  4040. </member>
  4041. <member name="P:NPOI.HSSF.UserModel.DVConstraint.IsListValidationType">
  4042. Convenience method
  4043. @return <c>true</c> if this constraint is a 'list' validation
  4044. </member>
  4045. <member name="P:NPOI.HSSF.UserModel.DVConstraint.IsExplicitList">
  4046. Convenience method
  4047. @return <c>true</c> if this constraint is a 'list' validation with explicit values
  4048. </member>
  4049. <member name="P:NPOI.HSSF.UserModel.DVConstraint.Value1">
  4050. @return the numeric value for expression 1. May be <c>null</c>
  4051. </member>
  4052. <member name="P:NPOI.HSSF.UserModel.DVConstraint.Value2">
  4053. @return the numeric value for expression 2. May be <c>null</c>
  4054. </member>
  4055. <member name="T:NPOI.HSSF.UserModel.HSSFDataFormatter">
  4056. HSSFDataFormatter contains methods for formatting the value stored in an
  4057. HSSFCell. This can be useful for reports and GUI presentations when you
  4058. need to display data exactly as it appears in Excel. Supported formats
  4059. include currency, SSN, percentages, decimals, dates, phone numbers, zip
  4060. codes, etc.
  4061. Internally, formats will be implemented using subclasses of <see cref="T:NPOI.SS.Util.FormatBase"/>
  4062. such as <see cref="T:NPOI.SS.Util.DecimalFormat"/> and <see cref="T:NPOI.SS.Util.SimpleDateFormat"/>. Therefore the
  4063. formats used by this class must obey the same pattern rules as these Format
  4064. subclasses. This means that only legal number pattern characters ("0", "#",
  4065. ".", "," etc.) may appear in number formats. Other characters can be
  4066. inserted <em>before</em> or <em>after</em> the number pattern to form a
  4067. prefix or suffix.
  4068. For example the Excel pattern <c>"$#,##0.00 "USD"_);($#,##0.00 "USD")"
  4069. </c> will be correctly formatted as "$1,000.00 USD" or "($1,000.00 USD)".
  4070. However the pattern <c>"00-00-00"</c> is incorrectly formatted by
  4071. DecimalFormat as "000000--". For Excel formats that are not compatible with
  4072. DecimalFormat, you can provide your own custom {@link Format} implementation
  4073. via <c>HSSFDataFormatter.AddFormat(String,Format)</c>. The following
  4074. custom formats are already provided by this class:
  4075. <pre>
  4076. <ul><li>SSN "000-00-0000"</li>
  4077. <li>Phone Number "(###) ###-####"</li>
  4078. <li>Zip plus 4 "00000-0000"</li>
  4079. </ul>
  4080. </pre>
  4081. If the Excel format pattern cannot be parsed successfully, then a default
  4082. format will be used. The default number format will mimic the Excel General
  4083. format: "#" for whole numbers and "#.##########" for decimal numbers. You
  4084. can override the default format pattern with <c>
  4085. HSSFDataFormatter.DefaultNumberFormat=(Format)</c>. <b>Note:</b> the
  4086. default format will only be used when a Format cannot be created from the
  4087. cell's data format string.
  4088. @author James May (james dot may at fmr dot com)
  4089. </member>
  4090. <member name="T:NPOI.SS.UserModel.DataFormatter">
  4091. HSSFDataFormatter contains methods for Formatting the value stored in an
  4092. Cell. This can be useful for reports and GUI presentations when you
  4093. need to display data exactly as it appears in Excel. Supported Formats
  4094. include currency, SSN, percentages, decimals, dates, phone numbers, zip
  4095. codes, etc.
  4096. Internally, Formats will be implemented using subclasses of <see cref="T:NPOI.SS.Util.FormatBase"/>
  4097. such as <see cref="T:NPOI.SS.Util.DecimalFormat"/> and <see cref="T:NPOI.SS.Util.SimpleDateFormat"/>. Therefore the
  4098. Formats used by this class must obey the same pattern rules as these FormatBase
  4099. subclasses. This means that only legal number pattern characters ("0", "#",
  4100. ".", "," etc.) may appear in number formats. Other characters can be
  4101. inserted <em>before</em> or <em> after</em> the number pattern to form a
  4102. prefix or suffix.
  4103. For example the Excel pattern <c>"$#,##0.00 "USD"_);($#,##0.00 "USD")"
  4104. </c> will be correctly Formatted as "$1,000.00 USD" or "($1,000.00 USD)".
  4105. However the pattern <c>"00-00-00"</c> is incorrectly Formatted by
  4106. DecimalFormat as "000000--". For Excel Formats that are not compatible with
  4107. DecimalFormat, you can provide your own custom {@link FormatBase} implementation
  4108. via <c>HSSFDataFormatter.AddFormat(String,FormatBase)</c>. The following
  4109. custom Formats are already provided by this class:
  4110. <pre>
  4111. <ul><li>SSN "000-00-0000"</li>
  4112. <li>Phone Number "(###) ###-####"</li>
  4113. <li>Zip plus 4 "00000-0000"</li>
  4114. </ul>
  4115. </pre>
  4116. If the Excel FormatBase pattern cannot be Parsed successfully, then a default
  4117. FormatBase will be used. The default number FormatBase will mimic the Excel General
  4118. FormatBase: "#" for whole numbers and "#.##########" for decimal numbers. You
  4119. can override the default FormatBase pattern with <c>
  4120. HSSFDataFormatter.setDefaultNumberFormat(FormatBase)</c>. <b>Note:</b> the
  4121. default FormatBase will only be used when a FormatBase cannot be Created from the
  4122. cell's data FormatBase string.
  4123. @author James May (james dot may at fmr dot com)
  4124. </member>
  4125. <member name="F:NPOI.SS.UserModel.DataFormatter.numPattern">
  4126. Pattern to find a number FormatBase: "0" or "#"
  4127. </member>
  4128. <member name="F:NPOI.SS.UserModel.DataFormatter.daysAsText">
  4129. Pattern to find days of week as text "ddd...."
  4130. </member>
  4131. <member name="F:NPOI.SS.UserModel.DataFormatter.amPmPattern">
  4132. Pattern to find "AM/PM" marker
  4133. </member>
  4134. <member name="F:NPOI.SS.UserModel.DataFormatter.localePatternGroup">
  4135. A regex to find patterns like [$$-1009] and [$�-452].
  4136. Note that we don't currently process these into locales
  4137. </member>
  4138. <member name="F:NPOI.SS.UserModel.DataFormatter.fractionPattern">
  4139. A regex to identify a fraction pattern.
  4140. This requires that replaceAll("\\?", "#") has already been called
  4141. </member>
  4142. <member name="F:NPOI.SS.UserModel.DataFormatter.fractionStripper">
  4143. A regex to strip junk out of fraction formats
  4144. </member>
  4145. <member name="F:NPOI.SS.UserModel.DataFormatter.invalidDateTimeString">
  4146. * Cells formatted with a date or time format and which contain invalid date or time values
  4147. * show 255 pound signs ("#").
  4148. </member>
  4149. <member name="F:NPOI.SS.UserModel.DataFormatter.generalWholeNumFormat">
  4150. <em>General</em> FormatBase for whole numbers.
  4151. </member>
  4152. <member name="F:NPOI.SS.UserModel.DataFormatter.generalDecimalNumFormat">
  4153. <em>General</em> FormatBase for decimal numbers.
  4154. </member>
  4155. <member name="F:NPOI.SS.UserModel.DataFormatter.defaultNumFormat">
  4156. A default FormatBase to use when a number pattern cannot be Parsed.
  4157. </member>
  4158. <member name="M:NPOI.SS.UserModel.DataFormatter.#ctor">
  4159. Creates a formatter using the {@link Locale#getDefault() default locale}.
  4160. </member>
  4161. <member name="M:NPOI.SS.UserModel.DataFormatter.#ctor(System.Globalization.CultureInfo)">
  4162. Constructor
  4163. </member>
  4164. <member name="M:NPOI.SS.UserModel.DataFormatter.#ctor(System.Globalization.CultureInfo,System.Boolean)">
  4165. Creates a formatter using the given locale.
  4166. @param emulateCsv whether to emulate CSV output.
  4167. </member>
  4168. <member name="M:NPOI.SS.UserModel.DataFormatter.GetFormat(NPOI.SS.UserModel.ICell)">
  4169. Return a FormatBase for the given cell if one exists, otherwise try to
  4170. Create one. This method will return <c>null</c> if the any of the
  4171. following is true:
  4172. <ul>
  4173. <li>the cell's style is null</li>
  4174. <li>the style's data FormatBase string is null or empty</li>
  4175. <li>the FormatBase string cannot be recognized as either a number or date</li>
  4176. </ul>
  4177. @param cell The cell to retrieve a FormatBase for
  4178. @return A FormatBase for the FormatBase String
  4179. </member>
  4180. <member name="M:NPOI.SS.UserModel.DataFormatter.CreateFormat(NPOI.SS.UserModel.ICell)">
  4181. Create and return a FormatBase based on the FormatBase string from a cell's
  4182. style. If the pattern cannot be Parsed, return a default pattern.
  4183. @param cell The Excel cell
  4184. @return A FormatBase representing the excel FormatBase. May return null.
  4185. </member>
  4186. <member name="M:NPOI.SS.UserModel.DataFormatter.IsWholeNumber(System.Double)">
  4187. Return true if the double value represents a whole number
  4188. @param d the double value to check
  4189. @return <c>true</c> if d is a whole number
  4190. </member>
  4191. <member name="M:NPOI.SS.UserModel.DataFormatter.GetDefaultFormat(NPOI.SS.UserModel.ICell)">
  4192. Returns a default FormatBase for a cell.
  4193. @param cell The cell
  4194. @return a default FormatBase
  4195. </member>
  4196. <member name="M:NPOI.SS.UserModel.DataFormatter.GetFormattedDateString(NPOI.SS.UserModel.ICell)">
  4197. Returns the Formatted value of an Excel date as a <c>String</c> based
  4198. on the cell's <c>DataFormat</c>. i.e. "Thursday, January 02, 2003"
  4199. , "01/02/2003" , "02-Jan" , etc.
  4200. @param cell The cell
  4201. @return a Formatted date string
  4202. </member>
  4203. <member name="M:NPOI.SS.UserModel.DataFormatter.GetFormattedNumberString(NPOI.SS.UserModel.ICell)">
  4204. Returns the Formatted value of an Excel number as a <c>String</c>
  4205. based on the cell's <c>DataFormat</c>. Supported Formats include
  4206. currency, percents, decimals, phone number, SSN, etc.:
  4207. "61.54%", "$100.00", "(800) 555-1234".
  4208. @param cell The cell
  4209. @return a Formatted number string
  4210. </member>
  4211. <member name="M:NPOI.SS.UserModel.DataFormatter.FormatRawCellContents(System.Double,System.Int32,System.String)">
  4212. Formats the given raw cell value, based on the supplied
  4213. FormatBase index and string, according to excel style rules.
  4214. @see #FormatCellValue(Cell)
  4215. </member>
  4216. <member name="M:NPOI.SS.UserModel.DataFormatter.PerformDateFormatting(System.DateTime,NPOI.SS.Util.FormatBase)">
  4217. Performs Excel-style date formatting, using the
  4218. supplied Date and format
  4219. </member>
  4220. <member name="M:NPOI.SS.UserModel.DataFormatter.FormatRawCellContents(System.Double,System.Int32,System.String,System.Boolean)">
  4221. Formats the given raw cell value, based on the supplied
  4222. format index and string, according to excel style rules.
  4223. @see #formatCellValue(Cell)
  4224. </member>
  4225. <member name="M:NPOI.SS.UserModel.DataFormatter.FormatCellValue(NPOI.SS.UserModel.ICell)">
  4226. Returns the Formatted value of a cell as a <c>String</c> regardless
  4227. of the cell type. If the Excel FormatBase pattern cannot be Parsed then the
  4228. cell value will be Formatted using a default FormatBase.
  4229. When passed a null or blank cell, this method will return an empty
  4230. String (""). Formulas in formula type cells will not be evaluated.
  4231. @param cell The cell
  4232. @return the Formatted cell value as a String
  4233. </member>
  4234. <member name="M:NPOI.SS.UserModel.DataFormatter.FormatCellValue(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IFormulaEvaluator)">
  4235. Returns the Formatted value of a cell as a <c>String</c> regardless
  4236. of the cell type. If the Excel FormatBase pattern cannot be Parsed then the
  4237. cell value will be Formatted using a default FormatBase.
  4238. When passed a null or blank cell, this method will return an empty
  4239. String (""). Formula cells will be evaluated using the given
  4240. {@link HSSFFormulaEvaluator} if the evaluator is non-null. If the
  4241. evaluator is null, then the formula String will be returned. The caller
  4242. is responsible for setting the currentRow on the evaluator
  4243. @param cell The cell (can be null)
  4244. @param evaluator The HSSFFormulaEvaluator (can be null)
  4245. @return a string value of the cell
  4246. </member>
  4247. <member name="M:NPOI.SS.UserModel.DataFormatter.SetDefaultNumberFormat(NPOI.SS.Util.FormatBase)">
  4248. Sets a default number FormatBase to be used when the Excel FormatBase cannot be
  4249. Parsed successfully. <b>Note:</b> This is a fall back for when an error
  4250. occurs while parsing an Excel number FormatBase pattern. This will not
  4251. affect cells with the <em>General</em> FormatBase.
  4252. The value that will be passed to the FormatBase's FormatBase method (specified
  4253. by <c>java.text.FormatBase#FormatBase</c>) will be a double value from a
  4254. numeric cell. Therefore the code in the FormatBase method should expect a
  4255. <c>Number</c> value.
  4256. @param FormatBase A FormatBase instance to be used as a default
  4257. @see java.text.FormatBase#FormatBase
  4258. </member>
  4259. <member name="M:NPOI.SS.UserModel.DataFormatter.AddFormat(System.String,NPOI.SS.Util.FormatBase)">
  4260. Adds a new FormatBase to the available formats.
  4261. The value that will be passed to the FormatBase's FormatBase method (specified
  4262. by <c>java.text.FormatBase#FormatBase</c>) will be a double value from a
  4263. numeric cell. Therefore the code in the FormatBase method should expect a
  4264. <c>Number</c> value.
  4265. @param excelformatStr The data FormatBase string
  4266. @param FormatBase A FormatBase instance
  4267. </member>
  4268. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormatter.#ctor(System.Globalization.CultureInfo)">
  4269. Creates a formatter using the given locale.
  4270. </member>
  4271. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormatter.#ctor">
  4272. Creates a formatter using the {@link Locale#getDefault() default locale}.
  4273. </member>
  4274. <member name="T:NPOI.HSSF.UserModel.HSSFDataValidation">
  4275. Utility class for creating data validation cells
  4276. @author Dragos Buleandra (dragos.buleandra@trade2b.ro)
  4277. </member>
  4278. <member name="M:NPOI.SS.UserModel.IDataValidation.CreatePromptBox(System.String,System.String)">
  4279. Sets the title and text for the prompt box . Prompt box is displayed when
  4280. the user selects a cell which belongs to this validation object . In
  4281. order for a prompt box to be displayed you should also use method
  4282. SetShowPromptBox( bool show )
  4283. @param title The prompt box's title
  4284. @param text The prompt box's text
  4285. </member>
  4286. <member name="M:NPOI.SS.UserModel.IDataValidation.CreateErrorBox(System.String,System.String)">
  4287. Sets the title and text for the error box . Error box is displayed when
  4288. the user enters an invalid value int o a cell which belongs to this
  4289. validation object . In order for an error box to be displayed you should
  4290. also use method SetShowErrorBox( bool show )
  4291. @param title The error box's title
  4292. @param text The error box's text
  4293. </member>
  4294. <member name="P:NPOI.SS.UserModel.IDataValidation.ErrorStyle">
  4295. <summary>
  4296. get or set the error style for error box
  4297. </summary>
  4298. </member>
  4299. <member name="P:NPOI.SS.UserModel.IDataValidation.EmptyCellAllowed">
  4300. <summary>
  4301. Setting this allows an empty object as a valid value. Retrieve the settings for empty cells allowed.
  4302. @return True if this object should treats empty as valid value , false otherwise
  4303. </summary>
  4304. <value><c>true</c> if this object should treats empty as valid value, <c>false</c> otherwise</value>
  4305. </member>
  4306. <member name="P:NPOI.SS.UserModel.IDataValidation.SuppressDropDownArrow">
  4307. <summary>
  4308. Useful for list validation objects .
  4309. Useful only list validation objects . This method always returns false if the object isn't a list validation object
  4310. </summary>
  4311. </member>
  4312. <member name="P:NPOI.SS.UserModel.IDataValidation.ShowPromptBox">
  4313. Sets the behaviour when a cell which belongs to this object is selected
  4314. <value><c>true</c> if an prompt box should be displayed , <c>false</c> otherwise</value>
  4315. </member>
  4316. <member name="P:NPOI.SS.UserModel.IDataValidation.ShowErrorBox">
  4317. Sets the behaviour when an invalid value is entered
  4318. <value><c>true</c> if an error box should be displayed , <c>false</c> otherwise</value>
  4319. </member>
  4320. <member name="P:NPOI.SS.UserModel.IDataValidation.PromptBoxTitle">
  4321. @return Prompt box's title or <code>null</code>
  4322. </member>
  4323. <member name="P:NPOI.SS.UserModel.IDataValidation.PromptBoxText">
  4324. @return Prompt box's text or <code>null</code>
  4325. </member>
  4326. <member name="P:NPOI.SS.UserModel.IDataValidation.ErrorBoxTitle">
  4327. @return Error box's title or <code>null</code>
  4328. </member>
  4329. <member name="P:NPOI.SS.UserModel.IDataValidation.ErrorBoxText">
  4330. @return Error box's text or <code>null</code>
  4331. </member>
  4332. <member name="M:NPOI.HSSF.UserModel.HSSFDataValidation.#ctor(NPOI.SS.Util.CellRangeAddressList,NPOI.SS.UserModel.IDataValidationConstraint)">
  4333. Constructor which Initializes the cell range on which this object will be
  4334. applied
  4335. @param constraint
  4336. </member>
  4337. <member name="T:NPOI.HSSF.UserModel.HSSFDataValidationHelper">
  4338. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  4339. </member>
  4340. <member name="T:NPOI.SS.UserModel.IDataValidationHelper">
  4341. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  4342. </member>
  4343. <member name="T:NPOI.HSSF.UserModel.HSSFDateUtil">
  4344. Contains methods for dealing with Excel dates.
  4345. @author Michael Harhen
  4346. @author Glen Stampoultzis (glens at apache.org)
  4347. @author Dan Sherman (dsherman at isisph.com)
  4348. @author Hack Kampbjorn (hak at 2mba.dk)
  4349. @author Alex Jacoby (ajacoby at gmail.com)
  4350. @author Pavel Krupets (pkrupets at palmtreebusiness dot com)
  4351. </member>
  4352. <member name="T:NPOI.SS.UserModel.DateUtil">
  4353. <summary>
  4354. Contains methods for dealing with Excel dates.
  4355. @author Michael Harhen
  4356. @author Glen Stampoultzis (glens at apache.org)
  4357. @author Dan Sherman (dsherman at Isisph.com)
  4358. @author Hack Kampbjorn (hak at 2mba.dk)
  4359. @author Alex Jacoby (ajacoby at gmail.com)
  4360. @author Pavel Krupets (pkrupets at palmtreebusiness dot com)
  4361. @author Thies Wellpott
  4362. </summary>
  4363. </member>
  4364. <member name="F:NPOI.SS.UserModel.DateUtil.date_ptrn1">
  4365. The following patterns are used in {@link #isADateFormat(int, String)}
  4366. </member>
  4367. <member name="M:NPOI.SS.UserModel.DateUtil.AbsoluteDay(System.DateTime,System.Boolean)">
  4368. <summary>
  4369. Given a Calendar, return the number of days since 1899/12/31.
  4370. </summary>
  4371. <param name="cal">the date</param>
  4372. <param name="use1904windowing">if set to <c>true</c> [use1904windowing].</param>
  4373. <returns>number of days since 1899/12/31</returns>
  4374. </member>
  4375. <member name="M:NPOI.SS.UserModel.DateUtil.GetExcelDate(System.DateTime)">
  4376. <summary>
  4377. Given a Date, Converts it into a double representing its internal Excel representation,
  4378. which Is the number of days since 1/1/1900. Fractional days represent hours, minutes, and seconds.
  4379. </summary>
  4380. <param name="date">Excel representation of Date (-1 if error - test for error by Checking for less than 0.1)</param>
  4381. <returns>the Date</returns>
  4382. </member>
  4383. <member name="M:NPOI.SS.UserModel.DateUtil.GetExcelDate(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean)">
  4384. <summary>
  4385. Gets the excel date.
  4386. </summary>
  4387. <param name="year">The year.</param>
  4388. <param name="month">The month.</param>
  4389. <param name="day">The day.</param>
  4390. <param name="hour">The hour.</param>
  4391. <param name="minute">The minute.</param>
  4392. <param name="second">The second.</param>
  4393. <param name="use1904windowing">Should 1900 or 1904 date windowing be used?</param>
  4394. <returns></returns>
  4395. </member>
  4396. <member name="M:NPOI.SS.UserModel.DateUtil.GetExcelDate(System.DateTime,System.Boolean)">
  4397. <summary>
  4398. Given a Date, Converts it into a double representing its internal Excel representation,
  4399. which Is the number of days since 1/1/1900. Fractional days represent hours, minutes, and seconds.
  4400. </summary>
  4401. <param name="date">The date.</param>
  4402. <param name="use1904windowing">Should 1900 or 1904 date windowing be used?</param>
  4403. <returns>Excel representation of Date (-1 if error - test for error by Checking for less than 0.1)</returns>
  4404. </member>
  4405. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaDate(System.Double)">
  4406. <summary>
  4407. Given an Excel date with using 1900 date windowing, and converts it to a java.util.Date.
  4408. Excel Dates and Times are stored without any timezone
  4409. information. If you know (through other means) that your file
  4410. uses a different TimeZone to the system default, you can use
  4411. this version of the getJavaDate() method to handle it.
  4412. </summary>
  4413. <param name="date">The Excel date.</param>
  4414. <returns>null if date is not a valid Excel date</returns>
  4415. </member>
  4416. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaDate(System.Double,System.Boolean)">
  4417. Given an Excel date with either 1900 or 1904 date windowing,
  4418. Converts it to a Date.
  4419. NOTE: If the default <c>TimeZone</c> in Java uses Daylight
  4420. Saving Time then the conversion back to an Excel date may not give
  4421. the same value, that Is the comparison
  4422. <CODE>excelDate == GetExcelDate(GetJavaDate(excelDate,false))</CODE>
  4423. Is not always true. For example if default timezone Is
  4424. <c>Europe/Copenhagen</c>, on 2004-03-28 the minute after
  4425. 01:59 CET Is 03:00 CEST, if the excel date represents a time between
  4426. 02:00 and 03:00 then it Is Converted to past 03:00 summer time
  4427. @param date The Excel date.
  4428. @param use1904windowing true if date uses 1904 windowing,
  4429. or false if using 1900 date windowing.
  4430. @return Java representation of the date, or null if date Is not a valid Excel date
  4431. @see TimeZone
  4432. </member>
  4433. <member name="M:NPOI.SS.UserModel.DateUtil.getJavaDate(System.Double,System.Boolean,System.TimeZone)">
  4434. Given an Excel date with either 1900 or 1904 date windowing,
  4435. converts it to a java.util.Date.
  4436. Excel Dates and Times are stored without any timezone
  4437. information. If you know (through other means) that your file
  4438. uses a different TimeZone to the system default, you can use
  4439. this version of the getJavaDate() method to handle it.
  4440. @param date The Excel date.
  4441. @param tz The TimeZone to evaluate the date in
  4442. @param use1904windowing true if date uses 1904 windowing,
  4443. or false if using 1900 date windowing.
  4444. @return Java representation of the date, or null if date is not a valid Excel date
  4445. </member>
  4446. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaDate(System.Double,System.Boolean,System.TimeZone,System.Boolean)">
  4447. Given an Excel date with either 1900 or 1904 date windowing,
  4448. converts it to a java.util.Date.
  4449. Excel Dates and Times are stored without any timezone
  4450. information. If you know (through other means) that your file
  4451. uses a different TimeZone to the system default, you can use
  4452. this version of the getJavaDate() method to handle it.
  4453. @param date The Excel date.
  4454. @param tz The TimeZone to evaluate the date in
  4455. @param use1904windowing true if date uses 1904 windowing,
  4456. or false if using 1900 date windowing.
  4457. @param roundSeconds round to closest second
  4458. @return Java representation of the date, or null if date is not a valid Excel date
  4459. </member>
  4460. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaCalendar(System.Double,System.Boolean)">
  4461. Get EXCEL date as Java Calendar with given time zone.
  4462. @param date The Excel date.
  4463. @param use1904windowing true if date uses 1904 windowing,
  4464. or false if using 1900 date windowing.
  4465. @param timeZone The TimeZone to evaluate the date in
  4466. @return Java representation of the date, or null if date is not a valid Excel date
  4467. </member>
  4468. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaCalendar(System.Double,System.Boolean,System.Boolean)">
  4469. <summary>
  4470. Get EXCEL date as Java Calendar (with default time zone). This is like GetJavaDate(double, boolean) but returns a Calendar object.
  4471. </summary>
  4472. <param name="date">The Excel date.</param>
  4473. <param name="use1904windowing">true if date uses 1904 windowing, or false if using 1900 date windowing.</param>
  4474. <param name="roundSeconds"></param>
  4475. <returns>null if date is not a valid Excel date</returns>
  4476. </member>
  4477. <member name="M:NPOI.SS.UserModel.DateUtil.ConvertTime(System.String)">
  4478. <summary>
  4479. Converts a string of format "HH:MM" or "HH:MM:SS" to its (Excel) numeric equivalent
  4480. </summary>
  4481. <param name="timeStr">The time STR.</param>
  4482. <returns> a double between 0 and 1 representing the fraction of the day</returns>
  4483. </member>
  4484. <member name="M:NPOI.SS.UserModel.DateUtil.ConvertTimeInternal(System.String)">
  4485. <summary>
  4486. Converts the time internal.
  4487. </summary>
  4488. <param name="timeStr">The time STR.</param>
  4489. <returns></returns>
  4490. </member>
  4491. <member name="M:NPOI.SS.UserModel.DateUtil.IsADateFormat(System.Int32,System.String)">
  4492. <summary>
  4493. Given a format ID and its format String, will Check to see if the
  4494. format represents a date format or not.
  4495. Firstly, it will Check to see if the format ID corresponds to an
  4496. internal excel date format (eg most US date formats)
  4497. If not, it will Check to see if the format string only Contains
  4498. date formatting Chars (ymd-/), which covers most
  4499. non US date formats.
  4500. </summary>
  4501. <param name="formatIndex">The index of the format, eg from ExtendedFormatRecord.GetFormatIndex</param>
  4502. <param name="formatString">The format string, eg from FormatRecord.GetFormatString</param>
  4503. <returns>
  4504. <c>true</c> if [is A date format] [the specified format index]; otherwise, <c>false</c>.
  4505. </returns>
  4506. </member>
  4507. <member name="M:NPOI.SS.UserModel.DateUtil.ParseYYYYMMDDDate(System.String)">
  4508. <summary>
  4509. Converts a string of format "YYYY/MM/DD" to its (Excel) numeric equivalent
  4510. </summary>
  4511. <param name="dateStr">The date STR.</param>
  4512. <returns>a double representing the (integer) number of days since the start of the Excel epoch</returns>
  4513. </member>
  4514. <member name="M:NPOI.SS.UserModel.DateUtil.ParseYYYYMMDDDateInternal(System.String)">
  4515. <summary>
  4516. Parses the YYYYMMDD date internal.
  4517. </summary>
  4518. <param name="timeStr">The time string.</param>
  4519. <returns></returns>
  4520. </member>
  4521. <member name="M:NPOI.SS.UserModel.DateUtil.ParseInt(System.String,System.String,System.Int32)">
  4522. <summary>
  4523. Parses the int.
  4524. </summary>
  4525. <param name="strVal">The string value.</param>
  4526. <param name="fieldName">Name of the field.</param>
  4527. <param name="rangeMax">The range max.</param>
  4528. <returns></returns>
  4529. </member>
  4530. <member name="M:NPOI.SS.UserModel.DateUtil.ParseInt(System.String,System.String,System.Int32,System.Int32)">
  4531. <summary>
  4532. Parses the int.
  4533. </summary>
  4534. <param name="strVal">The STR val.</param>
  4535. <param name="fieldName">Name of the field.</param>
  4536. <param name="lowerLimit">The lower limit.</param>
  4537. <param name="upperLimit">The upper limit.</param>
  4538. <returns></returns>
  4539. </member>
  4540. <member name="M:NPOI.SS.UserModel.DateUtil.IsInternalDateFormat(System.Int32)">
  4541. <summary>
  4542. Given a format ID this will Check whether the format represents an internal excel date format or not.
  4543. </summary>
  4544. <param name="format">The format.</param>
  4545. </member>
  4546. <member name="M:NPOI.SS.UserModel.DateUtil.IsCellDateFormatted(NPOI.SS.UserModel.ICell)">
  4547. <summary>
  4548. Check if a cell Contains a date
  4549. Since dates are stored internally in Excel as double values
  4550. we infer it Is a date if it Is formatted as such.
  4551. </summary>
  4552. <param name="cell">The cell.</param>
  4553. </member>
  4554. <member name="M:NPOI.SS.UserModel.DateUtil.IsCellInternalDateFormatted(NPOI.SS.UserModel.ICell)">
  4555. <summary>
  4556. Check if a cell contains a date, Checking only for internal excel date formats.
  4557. As Excel stores a great many of its dates in "non-internal" date formats, you will not normally want to use this method.
  4558. </summary>
  4559. <param name="cell">The cell.</param>
  4560. </member>
  4561. <member name="M:NPOI.SS.UserModel.DateUtil.IsValidExcelDate(System.Double)">
  4562. <summary>
  4563. Given a double, Checks if it Is a valid Excel date.
  4564. </summary>
  4565. <param name="value">the double value.</param>
  4566. <returns>
  4567. <c>true</c> if [is valid excel date] [the specified value]; otherwise, <c>false</c>.
  4568. </returns>
  4569. </member>
  4570. <member name="T:NPOI.HSSF.Util.LazilyConcatenatedByteArray">
  4571. Utility for delaying the concatenation of multiple byte arrays. Doing this up-front
  4572. causes significantly more copying, which for a large number of byte arrays can cost
  4573. a large amount of time.
  4574. </member>
  4575. <member name="M:NPOI.HSSF.Util.LazilyConcatenatedByteArray.Clear">
  4576. Clears the array (sets the concatenated length back to zero.
  4577. </member>
  4578. <member name="M:NPOI.HSSF.Util.LazilyConcatenatedByteArray.Concatenate(System.Byte[])">
  4579. Concatenates an array onto the end of our array.
  4580. This is a relatively fast operation.
  4581. @param array the array to concatenate.
  4582. @throws ArgumentException if {@code array} is {@code null}.
  4583. </member>
  4584. <member name="M:NPOI.HSSF.Util.LazilyConcatenatedByteArray.ToArray">
  4585. Gets the concatenated contents as a single byte array.
  4586. This is a slower operation, but the concatenated array is stored off as a single
  4587. array again so that subsequent calls will not perform Additional copying.
  4588. @return the byte array. Returns {@code null} if no data has been placed into it.
  4589. </member>
  4590. <member name="T:NPOI.UnsupportedFileFormatException">
  4591. Base class of all the exceptions that POI throws in the event
  4592. that it's given a file that isn't supported
  4593. </member>
  4594. <member name="T:NPOI.DDF.DefaultEscherRecordFactory">
  4595. <summary>
  4596. Generates escher records when provided the byte array containing those records.
  4597. @author Glen Stampoultzis
  4598. @author Nick Burch (nick at torchbox . com)
  4599. </summary>
  4600. </member>
  4601. <member name="T:NPOI.DDF.IEscherRecordFactory">
  4602. <summary>
  4603. The escher record factory interface allows for the creation of escher
  4604. records from a pointer into a data array.
  4605. @author Glen Stampoultzis (glens at apache.org)
  4606. </summary>
  4607. </member>
  4608. <member name="M:NPOI.DDF.IEscherRecordFactory.CreateRecord(System.Byte[],System.Int32)">
  4609. <summary>
  4610. Create a new escher record from the data provided. Does not attempt
  4611. to Fill the contents of the record however.
  4612. </summary>
  4613. <param name="data">The data.</param>
  4614. <param name="offset">The off set.</param>
  4615. <returns></returns>
  4616. </member>
  4617. <member name="M:NPOI.DDF.DefaultEscherRecordFactory.#ctor">
  4618. <summary>
  4619. Initializes a new instance of the <see cref="T:NPOI.DDF.DefaultEscherRecordFactory"/> class.
  4620. </summary>
  4621. </member>
  4622. <member name="M:NPOI.DDF.DefaultEscherRecordFactory.CreateRecord(System.Byte[],System.Int32)">
  4623. <summary>
  4624. Generates an escher record including the any children contained under that record.
  4625. An exception is thrown if the record could not be generated.
  4626. </summary>
  4627. <param name="data">The byte array containing the records</param>
  4628. <param name="offset">The starting offset into the byte array</param>
  4629. <returns>The generated escher record</returns>
  4630. </member>
  4631. <member name="M:NPOI.DDF.DefaultEscherRecordFactory.RecordsToMap(System.Type[])">
  4632. <summary>
  4633. Converts from a list of classes into a map that Contains the record id as the key and
  4634. the Constructor in the value part of the map. It does this by using reflection to look up
  4635. the RECORD_ID field then using reflection again to find a reference to the constructor.
  4636. </summary>
  4637. <param name="records">The records to convert</param>
  4638. <returns>The map containing the id/constructor pairs.</returns>
  4639. </member>
  4640. <member name="T:NPOI.DDF.EscherArrayProperty">
  4641. <summary>
  4642. Escher array properties are the most wierd construction ever invented
  4643. with all sorts of special cases. I'm hopeful I've got them all.
  4644. @author Glen Stampoultzis (glens at superlinksoftware.com)
  4645. </summary>
  4646. </member>
  4647. <member name="T:NPOI.DDF.EscherComplexProperty">
  4648. <summary>
  4649. A complex property differs from a simple property in that the data can not fit inside a 32 bit
  4650. integer. See the specification for more detailed information regarding exactly what is
  4651. stored here.
  4652. @author Glen Stampoultzis
  4653. </summary>
  4654. </member>
  4655. <member name="T:NPOI.DDF.EscherProperty">
  4656. <summary>
  4657. This is the abstract base class for all escher properties.
  4658. @see EscherOptRecord
  4659. @author Glen Stampoultzis (glens at apache.org)
  4660. </summary>
  4661. </member>
  4662. <member name="M:NPOI.DDF.EscherProperty.#ctor(System.Int16)">
  4663. <summary>
  4664. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherProperty"/> class.
  4665. </summary>
  4666. <param name="id">The id is distinct from the actual property number. The id includes the property number the blip id
  4667. flag and an indicator whether the property is complex or not.</param>
  4668. </member>
  4669. <member name="M:NPOI.DDF.EscherProperty.#ctor(System.Int16,System.Boolean,System.Boolean)">
  4670. <summary>
  4671. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherProperty"/> class.The three parameters are combined to form a property
  4672. id.
  4673. </summary>
  4674. <param name="propertyNumber">The property number.</param>
  4675. <param name="isComplex">if set to <c>true</c> [is complex].</param>
  4676. <param name="isBlipId">if set to <c>true</c> [is blip id].</param>
  4677. </member>
  4678. <member name="M:NPOI.DDF.EscherProperty.SerializeSimplePart(System.Byte[],System.Int32)">
  4679. <summary>
  4680. Escher properties consist of a simple fixed Length part and a complex variable Length part.
  4681. The fixed Length part is Serialized first.
  4682. </summary>
  4683. <param name="data">The data.</param>
  4684. <param name="pos">The pos.</param>
  4685. <returns></returns>
  4686. </member>
  4687. <member name="M:NPOI.DDF.EscherProperty.SerializeComplexPart(System.Byte[],System.Int32)">
  4688. <summary>
  4689. Escher properties consist of a simple fixed Length part and a complex variable Length part.
  4690. The fixed Length part is Serialized first.
  4691. </summary>
  4692. <param name="data">The data.</param>
  4693. <param name="pos">The pos.</param>
  4694. <returns></returns>
  4695. </member>
  4696. <member name="P:NPOI.DDF.EscherProperty.Id">
  4697. <summary>
  4698. Gets the id.
  4699. </summary>
  4700. <value>The id.</value>
  4701. </member>
  4702. <member name="P:NPOI.DDF.EscherProperty.PropertyNumber">
  4703. <summary>
  4704. Gets the property number.
  4705. </summary>
  4706. <value>The property number.</value>
  4707. </member>
  4708. <member name="P:NPOI.DDF.EscherProperty.IsComplex">
  4709. <summary>
  4710. Gets a value indicating whether this instance is complex.
  4711. </summary>
  4712. <value>
  4713. <c>true</c> if this instance is complex; otherwise, <c>false</c>.
  4714. </value>
  4715. </member>
  4716. <member name="P:NPOI.DDF.EscherProperty.IsBlipId">
  4717. <summary>
  4718. Gets a value indicating whether this instance is blip id.
  4719. </summary>
  4720. <value>
  4721. <c>true</c> if this instance is blip id; otherwise, <c>false</c>.
  4722. </value>
  4723. </member>
  4724. <member name="P:NPOI.DDF.EscherProperty.Name">
  4725. <summary>
  4726. Gets the name.
  4727. </summary>
  4728. <value>The name.</value>
  4729. </member>
  4730. <member name="P:NPOI.DDF.EscherProperty.PropertySize">
  4731. <summary>
  4732. Most properties are just 6 bytes in Length. Override this if we're
  4733. dealing with complex properties.
  4734. </summary>
  4735. <value>The size of the property.</value>
  4736. </member>
  4737. <member name="M:NPOI.DDF.EscherComplexProperty.#ctor(System.Int16,System.Byte[])">
  4738. <summary>
  4739. Create a complex property using the property id and a byte array containing the complex
  4740. data value.
  4741. </summary>
  4742. <param name="id"> The id consists of the property number, a flag indicating whether this is a blip id and a flag
  4743. indicating that this is a complex property.</param>
  4744. <param name="complexData">The value of this property.</param>
  4745. </member>
  4746. <member name="M:NPOI.DDF.EscherComplexProperty.#ctor(System.Int16,System.Boolean,System.Byte[])">
  4747. <summary>
  4748. Create a complex property using the property number, a flag to indicate whether this is a
  4749. blip reference and the complex property data.
  4750. </summary>
  4751. <param name="propertyNumber">The property number.</param>
  4752. <param name="isBlipId">Whether this is a blip id. Should be false.</param>
  4753. <param name="complexData">The value of this complex property.</param>
  4754. </member>
  4755. <member name="M:NPOI.DDF.EscherComplexProperty.SerializeSimplePart(System.Byte[],System.Int32)">
  4756. <summary>
  4757. Serializes the simple part of this property. ie the first 6 bytes.
  4758. </summary>
  4759. <param name="data"></param>
  4760. <param name="pos"></param>
  4761. <returns></returns>
  4762. </member>
  4763. <member name="M:NPOI.DDF.EscherComplexProperty.SerializeComplexPart(System.Byte[],System.Int32)">
  4764. <summary>
  4765. Serializes the complex part of this property
  4766. </summary>
  4767. <param name="data">The data array to Serialize to</param>
  4768. <param name="pos">The offset within data to start serializing to.</param>
  4769. <returns>The number of bytes Serialized.</returns>
  4770. </member>
  4771. <member name="M:NPOI.DDF.EscherComplexProperty.Equals(System.Object)">
  4772. <summary>
  4773. Determine whether this property is equal to another property.
  4774. </summary>
  4775. <param name="o">The object to compare to.</param>
  4776. <returns>True if the objects are equal.</returns>
  4777. </member>
  4778. <member name="M:NPOI.DDF.EscherComplexProperty.GetHashCode">
  4779. <summary>
  4780. Serves as a hash function for a particular type.
  4781. </summary>
  4782. <returns>
  4783. A hash code for the current <see cref="T:System.Object"/>.
  4784. </returns>
  4785. </member>
  4786. <member name="M:NPOI.DDF.EscherComplexProperty.ToString">
  4787. <summary>
  4788. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4789. </summary>
  4790. <returns>
  4791. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4792. </returns>
  4793. </member>
  4794. <member name="P:NPOI.DDF.EscherComplexProperty.ComplexData">
  4795. <summary>
  4796. Gets the complex data.
  4797. </summary>
  4798. <value>The complex data.</value>
  4799. </member>
  4800. <member name="P:NPOI.DDF.EscherComplexProperty.PropertySize">
  4801. <summary>
  4802. Caclulates the number of bytes required to Serialize this property.
  4803. </summary>
  4804. <value>Number of bytes</value>
  4805. </member>
  4806. <member name="F:NPOI.DDF.EscherArrayProperty.FIXED_SIZE">
  4807. The size of the header that goes at the
  4808. start of the array, before the data
  4809. </member>
  4810. <member name="F:NPOI.DDF.EscherArrayProperty.sizeIncludesHeaderSize">
  4811. Normally, the size recorded in the simple data (for the complex
  4812. data) includes the size of the header.
  4813. There are a few cases when it doesn't though...
  4814. </member>
  4815. <member name="F:NPOI.DDF.EscherArrayProperty.emptyComplexPart">
  4816. When Reading a property from data stream remeber if the complex part is empty and Set this flag.
  4817. </member>
  4818. <member name="M:NPOI.DDF.EscherArrayProperty.GetElement(System.Int32)">
  4819. <summary>
  4820. Gets the element.
  4821. </summary>
  4822. <param name="index">The index.</param>
  4823. <returns></returns>
  4824. </member>
  4825. <member name="M:NPOI.DDF.EscherArrayProperty.SetElement(System.Int32,System.Byte[])">
  4826. <summary>
  4827. Sets the element.
  4828. </summary>
  4829. <param name="index">The index.</param>
  4830. <param name="element">The element.</param>
  4831. </member>
  4832. <member name="M:NPOI.DDF.EscherArrayProperty.ToString">
  4833. <summary>
  4834. Retrieves the string representation for this property.
  4835. </summary>
  4836. <returns></returns>
  4837. </member>
  4838. <member name="M:NPOI.DDF.EscherArrayProperty.SetArrayData(System.Byte[],System.Int32)">
  4839. <summary>
  4840. We have this method because the way in which arrays in escher works
  4841. is screwed for seemly arbitary reasons. While most properties are
  4842. fairly consistent and have a predictable array size, escher arrays
  4843. have special cases.
  4844. </summary>
  4845. <param name="data">The data array containing the escher array information</param>
  4846. <param name="offset">The offset into the array to start Reading from.</param>
  4847. <returns>the number of bytes used by this complex property.</returns>
  4848. </member>
  4849. <member name="M:NPOI.DDF.EscherArrayProperty.SerializeSimplePart(System.Byte[],System.Int32)">
  4850. <summary>
  4851. Serializes the simple part of this property. ie the first 6 bytes.
  4852. Needs special code to handle the case when the size doesn't
  4853. include the size of the header block
  4854. </summary>
  4855. <param name="data"></param>
  4856. <param name="pos"></param>
  4857. <returns></returns>
  4858. </member>
  4859. <member name="M:NPOI.DDF.EscherArrayProperty.GetActualSizeOfElements(System.Int16)">
  4860. <summary>
  4861. Sometimes the element size is stored as a negative number. We
  4862. negate it and shift it to Get the real value.
  4863. </summary>
  4864. <param name="sizeOfElements">The size of elements.</param>
  4865. <returns></returns>
  4866. </member>
  4867. <member name="T:NPOI.DDF.EscherBitmapBlip">
  4868. <summary>
  4869. @author Glen Stampoultzis
  4870. @version $Id: EscherBitmapBlip.java 569827 2007-08-26 15:26:29Z yegor $
  4871. </summary>
  4872. </member>
  4873. <member name="T:NPOI.DDF.EscherBlipRecord">
  4874. <summary>
  4875. @author Glen Stampoultzis
  4876. @version $Id: EscherBlipRecord.java 569827 2007-08-26 15:26:29Z yegor $
  4877. </summary>
  4878. </member>
  4879. <member name="M:NPOI.DDF.EscherBlipRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  4880. <summary>
  4881. This method deSerializes the record from a byte array.
  4882. </summary>
  4883. <param name="data">The byte array containing the escher record information</param>
  4884. <param name="offset">The starting offset into </param>
  4885. <param name="recordFactory">May be null since this is not a container record.</param>
  4886. <returns>The number of bytes Read from the byte array.</returns>
  4887. </member>
  4888. <member name="M:NPOI.DDF.EscherBlipRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  4889. <summary>
  4890. Serializes the record to an existing byte array.
  4891. </summary>
  4892. <param name="offset"> the offset within the byte array</param>
  4893. <param name="data">the data array to Serialize to</param>
  4894. <param name="listener">a listener for begin and end serialization events.</param>
  4895. <returns>the number of bytes written.</returns>
  4896. </member>
  4897. <member name="M:NPOI.DDF.EscherBlipRecord.ToString">
  4898. <summary>
  4899. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4900. </summary>
  4901. <returns>
  4902. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4903. </returns>
  4904. </member>
  4905. <member name="P:NPOI.DDF.EscherBlipRecord.RecordSize">
  4906. <summary>
  4907. Returns the number of bytes that are required to Serialize this record.
  4908. </summary>
  4909. <value>Number of bytes</value>
  4910. </member>
  4911. <member name="P:NPOI.DDF.EscherBlipRecord.RecordName">
  4912. <summary>
  4913. The short name for this record
  4914. </summary>
  4915. <value></value>
  4916. </member>
  4917. <member name="P:NPOI.DDF.EscherBlipRecord.PictureData">
  4918. <summary>
  4919. Gets or sets the picture data.
  4920. </summary>
  4921. <value>The picture data.</value>
  4922. </member>
  4923. <member name="M:NPOI.DDF.EscherBitmapBlip.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  4924. <summary>
  4925. This method deSerializes the record from a byte array.
  4926. </summary>
  4927. <param name="data"> The byte array containing the escher record information</param>
  4928. <param name="offset">The starting offset into </param>
  4929. <param name="recordFactory">May be null since this is not a container record.</param>
  4930. <returns>The number of bytes Read from the byte array.</returns>
  4931. </member>
  4932. <member name="M:NPOI.DDF.EscherBitmapBlip.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  4933. <summary>
  4934. Serializes the record to an existing byte array.
  4935. </summary>
  4936. <param name="offset">the offset within the byte array</param>
  4937. <param name="data">the data array to Serialize to</param>
  4938. <param name="listener">a listener for begin and end serialization events.</param>
  4939. <returns>the number of bytes written.</returns>
  4940. </member>
  4941. <member name="M:NPOI.DDF.EscherBitmapBlip.ToString">
  4942. <summary>
  4943. Toes the string.
  4944. </summary>
  4945. <returns></returns>
  4946. </member>
  4947. <member name="P:NPOI.DDF.EscherBitmapBlip.RecordSize">
  4948. <summary>
  4949. Returns the number of bytes that are required to Serialize this record.
  4950. </summary>
  4951. <value> Number of bytes</value>
  4952. </member>
  4953. <member name="P:NPOI.DDF.EscherBitmapBlip.UID">
  4954. <summary>
  4955. Gets or sets the UID.
  4956. </summary>
  4957. <value>The UID.</value>
  4958. </member>
  4959. <member name="P:NPOI.DDF.EscherBitmapBlip.Marker">
  4960. <summary>
  4961. Gets or sets the marker.
  4962. </summary>
  4963. <value>The marker.</value>
  4964. </member>
  4965. <member name="T:NPOI.DDF.EscherBoolProperty">
  4966. <summary>
  4967. Represents a bool property. The actual utility of this property is in doubt because many
  4968. of the properties marked as bool seem to actually contain special values. In other words
  4969. they're not true bools.
  4970. @author Glen Stampoultzis
  4971. </summary>
  4972. </member>
  4973. <member name="T:NPOI.DDF.EscherSimpleProperty">
  4974. <summary>
  4975. A simple property is of fixed Length and as a property number in Addition
  4976. to a 32-bit value. Properties that can't be stored in only 32-bits are
  4977. stored as EscherComplexProperty objects.
  4978. @author Glen Stampoultzis (glens at apache.org)
  4979. </summary>
  4980. </member>
  4981. <member name="M:NPOI.DDF.EscherSimpleProperty.#ctor(System.Int16,System.Int32)">
  4982. <summary>
  4983. The id is distinct from the actual property number. The id includes the property number the blip id
  4984. flag and an indicator whether the property is complex or not.
  4985. </summary>
  4986. <param name="id">The id.</param>
  4987. <param name="propertyValue">The property value.</param>
  4988. </member>
  4989. <member name="M:NPOI.DDF.EscherSimpleProperty.#ctor(System.Int16,System.Boolean,System.Boolean,System.Int32)">
  4990. <summary>
  4991. Constructs a new escher property. The three parameters are combined to form a property
  4992. id.
  4993. </summary>
  4994. <param name="propertyNumber">The property number.</param>
  4995. <param name="isComplex">if set to <c>true</c> [is complex].</param>
  4996. <param name="isBlipId">if set to <c>true</c> [is blip id].</param>
  4997. <param name="propertyValue">The property value.</param>
  4998. </member>
  4999. <member name="M:NPOI.DDF.EscherSimpleProperty.SerializeSimplePart(System.Byte[],System.Int32)">
  5000. <summary>
  5001. Serialize the simple part of the escher record.
  5002. </summary>
  5003. <param name="data">The data.</param>
  5004. <param name="offset">The off set.</param>
  5005. <returns>the number of bytes Serialized.</returns>
  5006. </member>
  5007. <member name="M:NPOI.DDF.EscherSimpleProperty.SerializeComplexPart(System.Byte[],System.Int32)">
  5008. <summary>
  5009. Escher properties consist of a simple fixed Length part and a complex variable Length part.
  5010. The fixed Length part is Serialized first.
  5011. </summary>
  5012. <param name="data"></param>
  5013. <param name="pos"></param>
  5014. <returns></returns>
  5015. </member>
  5016. <member name="M:NPOI.DDF.EscherSimpleProperty.Equals(System.Object)">
  5017. <summary>
  5018. Returns true if one escher property is equal to another.
  5019. </summary>
  5020. <param name="o">The o.</param>
  5021. <returns></returns>
  5022. </member>
  5023. <member name="M:NPOI.DDF.EscherSimpleProperty.GetHashCode">
  5024. <summary>
  5025. Serves as a hash function for a particular type.
  5026. </summary>
  5027. <returns>
  5028. A hash code for the current <see cref="T:System.Object"/>.
  5029. </returns>
  5030. </member>
  5031. <member name="M:NPOI.DDF.EscherSimpleProperty.ToString">
  5032. <summary>
  5033. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5034. </summary>
  5035. <returns>
  5036. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5037. </returns>
  5038. </member>
  5039. <member name="P:NPOI.DDF.EscherSimpleProperty.PropertyValue">
  5040. <summary>
  5041. Return the 32 bit value of this property.
  5042. </summary>
  5043. <value>The property value.</value>
  5044. </member>
  5045. <member name="M:NPOI.DDF.EscherBoolProperty.#ctor(System.Int16,System.Int32)">
  5046. <summary>
  5047. Create an instance of an escher bool property.
  5048. </summary>
  5049. <param name="propertyNumber">The property number (or id)</param>
  5050. <param name="value">The 32 bit value of this bool property</param>
  5051. </member>
  5052. <member name="P:NPOI.DDF.EscherBoolProperty.IsTrue">
  5053. <summary>
  5054. Whether this bool property is true
  5055. </summary>
  5056. <value><c>true</c> if this instance is true; otherwise, <c>false</c>.</value>
  5057. </member>
  5058. <member name="P:NPOI.DDF.EscherBoolProperty.IsFalse">
  5059. <summary>
  5060. Whether this bool property is false
  5061. </summary>
  5062. <value><c>true</c> if this instance is false; otherwise, <c>false</c>.</value>
  5063. </member>
  5064. <member name="T:NPOI.DDF.EscherBSERecord">
  5065. <summary>
  5066. The BSE record is related closely to the EscherBlipRecord and stores
  5067. extra information about the blip. A blip record is actually stored inside
  5068. the BSE record even though the BSE record isn't actually a container record.
  5069. @author Glen Stampoultzis
  5070. @see EscherBlipRecord
  5071. </summary>
  5072. </member>
  5073. <member name="M:NPOI.DDF.EscherBSERecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  5074. <summary>
  5075. This method deSerializes the record from a byte array.
  5076. </summary>
  5077. <param name="data">The byte array containing the escher record information</param>
  5078. <param name="offset">The starting offset into data</param>
  5079. <param name="recordFactory">May be null since this is not a container record.</param>
  5080. <returns>The number of bytes Read from the byte array.</returns>
  5081. </member>
  5082. <member name="M:NPOI.DDF.EscherBSERecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  5083. <summary>
  5084. This method Serializes this escher record into a byte array.
  5085. </summary>
  5086. <param name="offset">The offset into
  5087. data to start writing the record data to</param>
  5088. <param name="data">The byte array to Serialize to.</param>
  5089. <param name="listener">a listener for begin and end serialization events.</param>
  5090. <returns>The number of bytes written.</returns>
  5091. </member>
  5092. <member name="M:NPOI.DDF.EscherBSERecord.ToString">
  5093. <summary>
  5094. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5095. </summary>
  5096. <returns>
  5097. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5098. </returns>
  5099. </member>
  5100. <member name="M:NPOI.DDF.EscherBSERecord.GetBlipType(System.Byte)">
  5101. <summary>
  5102. Retrieve the string representation given a blip id.
  5103. </summary>
  5104. <param name="b">The b.</param>
  5105. <returns></returns>
  5106. </member>
  5107. <member name="P:NPOI.DDF.EscherBSERecord.RecordSize">
  5108. <summary>
  5109. Returns the number of bytes that are required to Serialize this record.
  5110. </summary>
  5111. <value>Number of bytes</value>
  5112. </member>
  5113. <member name="P:NPOI.DDF.EscherBSERecord.RecordName">
  5114. <summary>
  5115. The short name for this record
  5116. </summary>
  5117. <value></value>
  5118. </member>
  5119. <member name="P:NPOI.DDF.EscherBSERecord.BlipTypeWin32">
  5120. <summary>
  5121. Gets or sets the expected blip type under windows (failure to match this blip type will result in
  5122. Excel converting to this format).
  5123. </summary>
  5124. <value>The blip type win32.</value>
  5125. </member>
  5126. <member name="P:NPOI.DDF.EscherBSERecord.BlipTypeMacOS">
  5127. <summary>
  5128. Gets or sets the expected blip type under MacOS (failure to match this blip type will result in
  5129. Excel converting to this format).
  5130. </summary>
  5131. <value>The blip type mac OS.</value>
  5132. </member>
  5133. <member name="P:NPOI.DDF.EscherBSERecord.UID">
  5134. <summary>
  5135. Gets or sets 16 byte MD4 checksum.
  5136. </summary>
  5137. <value>The UID.</value>
  5138. </member>
  5139. <member name="P:NPOI.DDF.EscherBSERecord.Tag">
  5140. <summary>
  5141. Gets or sets the tag. (Unused)
  5142. </summary>
  5143. <value>The tag.</value>
  5144. </member>
  5145. <member name="P:NPOI.DDF.EscherBSERecord.Size">
  5146. <summary>
  5147. Gets or sets Blip size in stream..
  5148. </summary>
  5149. <value>The size.</value>
  5150. </member>
  5151. <member name="P:NPOI.DDF.EscherBSERecord.Ref">
  5152. <summary>
  5153. Gets or sets the reference count of this blip.
  5154. </summary>
  5155. <value>The ref.</value>
  5156. </member>
  5157. <member name="P:NPOI.DDF.EscherBSERecord.Offset">
  5158. <summary>
  5159. Gets or sets the offset in the delay stream..
  5160. </summary>
  5161. <value>The offset.</value>
  5162. </member>
  5163. <member name="P:NPOI.DDF.EscherBSERecord.Usage">
  5164. <summary>
  5165. Defines the way this blip is used.
  5166. </summary>
  5167. <value>The usage.</value>
  5168. </member>
  5169. <member name="P:NPOI.DDF.EscherBSERecord.Name">
  5170. <summary>
  5171. Gets or sets the blip name.
  5172. </summary>
  5173. <value>The name.</value>
  5174. </member>
  5175. <member name="P:NPOI.DDF.EscherBSERecord.Unused2">
  5176. <summary>
  5177. Gets or sets the unused2.
  5178. </summary>
  5179. <value>The unused2.</value>
  5180. </member>
  5181. <member name="P:NPOI.DDF.EscherBSERecord.Unused3">
  5182. <summary>
  5183. Gets or sets the unused3.
  5184. </summary>
  5185. <value>The unused3.</value>
  5186. </member>
  5187. <member name="P:NPOI.DDF.EscherBSERecord.BlipRecord">
  5188. <summary>
  5189. Gets or sets the blip record.
  5190. </summary>
  5191. <value>The blip record.</value>
  5192. </member>
  5193. <member name="P:NPOI.DDF.EscherBSERecord.RemainingData">
  5194. <summary>
  5195. Gets or sets any remaining data in this record.
  5196. </summary>
  5197. <value>The remaining data.</value>
  5198. </member>
  5199. <member name="T:NPOI.DDF.EscherChildAnchorRecord">
  5200. <summary>
  5201. The escher child achor record is used to specify the position of a shape under an
  5202. existing group. The first level of shape records use a EscherClientAnchor record instead.
  5203. @author Glen Stampoultzis
  5204. </summary>
  5205. </member>
  5206. <member name="M:NPOI.DDF.EscherChildAnchorRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  5207. <summary>
  5208. This method deSerializes the record from a byte array.
  5209. </summary>
  5210. <param name="data">The byte array containing the escher record information</param>
  5211. <param name="offset">The starting offset into data</param>
  5212. <param name="recordFactory">May be null since this is not a container record.</param>
  5213. <returns>The number of bytes Read from the byte array.</returns>
  5214. </member>
  5215. <member name="M:NPOI.DDF.EscherChildAnchorRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  5216. <summary>
  5217. This method Serializes this escher record into a byte array.
  5218. </summary>
  5219. <param name="offset">The offset into data to start writing the record data to.</param>
  5220. <param name="data">The byte array to Serialize to.</param>
  5221. <param name="listener">a listener for begin and end serialization events.</param>
  5222. <returns>The number of bytes written.</returns>
  5223. </member>
  5224. <member name="M:NPOI.DDF.EscherChildAnchorRecord.ToString">
  5225. <summary>
  5226. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5227. </summary>
  5228. <returns>
  5229. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5230. </returns>
  5231. </member>
  5232. <member name="P:NPOI.DDF.EscherChildAnchorRecord.RecordSize">
  5233. <summary>
  5234. Returns the number of bytes that are required to Serialize this record.
  5235. </summary>
  5236. <value>Number of bytes</value>
  5237. </member>
  5238. <member name="P:NPOI.DDF.EscherChildAnchorRecord.RecordId">
  5239. <summary>
  5240. The record id for the EscherChildAnchorRecord.
  5241. </summary>
  5242. <value></value>
  5243. </member>
  5244. <member name="P:NPOI.DDF.EscherChildAnchorRecord.RecordName">
  5245. <summary>
  5246. The short name for this record
  5247. </summary>
  5248. <value></value>
  5249. </member>
  5250. <member name="P:NPOI.DDF.EscherChildAnchorRecord.Dx1">
  5251. <summary>
  5252. Gets or sets offset within the parent coordinate space for the top left point.
  5253. </summary>
  5254. <value>The DX1.</value>
  5255. </member>
  5256. <member name="P:NPOI.DDF.EscherChildAnchorRecord.Dy1">
  5257. <summary>
  5258. Gets or sets the offset within the parent coordinate space for the top left point.
  5259. </summary>
  5260. <value>The dy1.</value>
  5261. </member>
  5262. <member name="P:NPOI.DDF.EscherChildAnchorRecord.Dx2">
  5263. <summary>
  5264. Gets or sets the offset within the parent coordinate space for the bottom right point.
  5265. </summary>
  5266. <value>The DX2.</value>
  5267. </member>
  5268. <member name="P:NPOI.DDF.EscherChildAnchorRecord.Dy2">
  5269. <summary>
  5270. Gets or sets the offset within the parent coordinate space for the bottom right point.
  5271. </summary>
  5272. <value>The dy2.</value>
  5273. </member>
  5274. <member name="T:NPOI.DDF.EscherClientAnchorRecord">
  5275. <summary>
  5276. The escher client anchor specifies which rows and cells the shape is bound to as well as
  5277. the offsets within those cells. Each cell is 1024 units wide by 256 units long regardless
  5278. of the actual size of the cell. The EscherClientAnchorRecord only applies to the top-most
  5279. shapes. Shapes contained in groups are bound using the EscherChildAnchorRecords.
  5280. @author Glen Stampoultzis
  5281. </summary>
  5282. </member>
  5283. <member name="F:NPOI.DDF.EscherClientAnchorRecord.field_1_flag">
  5284. bit[0] - fMove (1 bit): A bit that specifies whether the shape will be kept intact when the cells are moved.
  5285. bit[1] - fSize (1 bit): A bit that specifies whether the shape will be kept intact when the cells are resized. If fMove is 1, the value MUST be 1.
  5286. bit[2-4] - reserved, MUST be 0 and MUST be ignored
  5287. bit[5-15]- Undefined and MUST be ignored.
  5288. it can take values: 0, 2, 3
  5289. </member>
  5290. <member name="M:NPOI.DDF.EscherClientAnchorRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  5291. <summary>
  5292. This method deSerializes the record from a byte array.
  5293. </summary>
  5294. <param name="data">The byte array containing the escher record information</param>
  5295. <param name="offset">The starting offset into data</param>
  5296. <param name="recordFactory">May be null since this is not a container record.</param>
  5297. <returns>The number of bytes Read from the byte array.</returns>
  5298. </member>
  5299. <member name="M:NPOI.DDF.EscherClientAnchorRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  5300. <summary>
  5301. This method Serializes this escher record into a byte array.
  5302. </summary>
  5303. <param name="offset">The offset into data to start writing the record data to.</param>
  5304. <param name="data">The byte array to Serialize to.</param>
  5305. <param name="listener">a listener for begin and end serialization events.</param>
  5306. <returns>The number of bytes written.</returns>
  5307. </member>
  5308. <member name="M:NPOI.DDF.EscherClientAnchorRecord.ToString">
  5309. <summary>
  5310. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5311. </summary>
  5312. <returns>
  5313. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5314. </returns>
  5315. </member>
  5316. <member name="P:NPOI.DDF.EscherClientAnchorRecord.RecordSize">
  5317. <summary>
  5318. Returns the number of bytes that are required to Serialize this record.
  5319. </summary>
  5320. <value>Number of bytes</value>
  5321. </member>
  5322. <member name="P:NPOI.DDF.EscherClientAnchorRecord.RecordId">
  5323. <summary>
  5324. The record id for this record.
  5325. </summary>
  5326. <value></value>
  5327. </member>
  5328. <member name="P:NPOI.DDF.EscherClientAnchorRecord.RecordName">
  5329. <summary>
  5330. The short name for this record
  5331. </summary>
  5332. <value></value>
  5333. </member>
  5334. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Flag">
  5335. <summary>
  5336. Gets or sets the flag.
  5337. </summary>
  5338. <value>0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.</value>
  5339. </member>
  5340. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Col1">
  5341. <summary>
  5342. Gets or sets The column number for the top-left position. 0 based.
  5343. </summary>
  5344. <value>The col1.</value>
  5345. </member>
  5346. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Dx1">
  5347. <summary>
  5348. Gets or sets The x offset within the top-left cell. Range is from 0 to 1023.
  5349. </summary>
  5350. <value>The DX1.</value>
  5351. </member>
  5352. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Row1">
  5353. <summary>
  5354. Gets or sets The row number for the top-left corner of the shape.
  5355. </summary>
  5356. <value>The row1.</value>
  5357. </member>
  5358. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Dy1">
  5359. <summary>
  5360. Gets or sets The y offset within the top-left corner of the current shape.
  5361. </summary>
  5362. <value>The dy1.</value>
  5363. </member>
  5364. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Col2">
  5365. <summary>
  5366. Gets or sets The column of the bottom right corner of this shape.
  5367. </summary>
  5368. <value>The col2.</value>
  5369. </member>
  5370. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Dx2">
  5371. <summary>
  5372. Gets or sets The x offset withing the cell for the bottom-right corner of this shape.
  5373. </summary>
  5374. <value>The DX2.</value>
  5375. </member>
  5376. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Row2">
  5377. <summary>
  5378. Gets or sets The row number for the bottom-right corner of the current shape.
  5379. </summary>
  5380. <value>The row2.</value>
  5381. </member>
  5382. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Dy2">
  5383. <summary>
  5384. Gets or sets The y offset withing the cell for the bottom-right corner of this shape.
  5385. </summary>
  5386. <value>The dy2.</value>
  5387. </member>
  5388. <member name="P:NPOI.DDF.EscherClientAnchorRecord.RemainingData">
  5389. <summary>
  5390. Gets or sets the remaining data.
  5391. </summary>
  5392. <value>The remaining data.</value>
  5393. </member>
  5394. <member name="T:NPOI.DDF.EscherClientDataRecord">
  5395. <summary>
  5396. The EscherClientDataRecord is used to store client specific data about the position of a
  5397. shape within a container.
  5398. @author Glen Stampoultzis
  5399. </summary>
  5400. </member>
  5401. <member name="M:NPOI.DDF.EscherClientDataRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  5402. <summary>
  5403. This method deSerializes the record from a byte array.
  5404. </summary>
  5405. <param name="data">The byte array containing the escher record information</param>
  5406. <param name="offset">The starting offset into data</param>
  5407. <param name="recordFactory">May be null since this is not a container record.</param>
  5408. <returns>The number of bytes Read from the byte array.</returns>
  5409. </member>
  5410. <member name="M:NPOI.DDF.EscherClientDataRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  5411. This method Serializes this escher record into a byte array.
  5412. @param offset The offset into <c>data</c> to start writing the record data to.
  5413. @param data The byte array to Serialize to.
  5414. @param listener A listener to retrieve start and end callbacks. Use a <c>NullEscherSerailizationListener</c> to ignore these events.
  5415. @return The number of bytes written.
  5416. @see NullEscherSerializationListener
  5417. </member>
  5418. <member name="M:NPOI.DDF.EscherClientDataRecord.ToString">
  5419. Returns the string representation of this record.
  5420. </member>
  5421. <member name="P:NPOI.DDF.EscherClientDataRecord.RecordSize">
  5422. Returns the number of bytes that are required to Serialize this record.
  5423. @return Number of bytes
  5424. </member>
  5425. <member name="P:NPOI.DDF.EscherClientDataRecord.RecordId">
  5426. Returns the identifier of this record.
  5427. </member>
  5428. <member name="P:NPOI.DDF.EscherClientDataRecord.RecordName">
  5429. The short name for this record
  5430. </member>
  5431. <member name="P:NPOI.DDF.EscherClientDataRecord.RemainingData">
  5432. Any data recording this record.
  5433. </member>
  5434. <member name="T:NPOI.DDF.EscherContainerRecord">
  5435. <summary>
  5436. Escher container records store other escher records as children.
  5437. The container records themselves never store any information beyond
  5438. the standard header used by all escher records. This one record is
  5439. used to represent many different types of records.
  5440. @author Glen Stampoultzis
  5441. </summary>
  5442. </member>
  5443. <member name="F:NPOI.DDF.EscherContainerRecord._remainingLength">
  5444. in case if document contains any charts we have such document structure:
  5445. BOF
  5446. ...
  5447. DrawingRecord
  5448. ...
  5449. ObjRecord|TxtObjRecord
  5450. ...
  5451. EOF
  5452. ...
  5453. BOF(Chart begin)
  5454. ...
  5455. DrawingRecord
  5456. ...
  5457. ObjRecord|TxtObjRecord
  5458. ...
  5459. EOF
  5460. So, when we call EscherAggregate.createAggregate() we have not all needed data.
  5461. When we got warning "WARNING: " + bytesRemaining + " bytes remaining but no space left"
  5462. we should save value of bytesRemaining
  5463. and add it to container size when we serialize it
  5464. </member>
  5465. <member name="M:NPOI.DDF.EscherContainerRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  5466. <summary>
  5467. The contract of this method is to deSerialize an escher record including
  5468. it's children.
  5469. </summary>
  5470. <param name="data">The byte array containing the Serialized escher
  5471. records.</param>
  5472. <param name="offset">The offset into the byte array.</param>
  5473. <param name="recordFactory">A factory for creating new escher records</param>
  5474. <returns>The number of bytes written.</returns>
  5475. </member>
  5476. <member name="M:NPOI.DDF.EscherContainerRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  5477. <summary>
  5478. Serializes to an existing byte array without serialization listener.
  5479. This is done by delegating to Serialize(int, byte[], EscherSerializationListener).
  5480. </summary>
  5481. <param name="offset">the offset within the data byte array.</param>
  5482. <param name="data"> the data array to Serialize to.</param>
  5483. <param name="listener">a listener for begin and end serialization events.</param>
  5484. <returns>The number of bytes written.</returns>
  5485. </member>
  5486. <member name="M:NPOI.DDF.EscherContainerRecord.HasChildOfType(System.Int16)">
  5487. <summary>
  5488. Do any of our (top level) children have the
  5489. given recordId?
  5490. </summary>
  5491. <param name="recordId">The record id.</param>
  5492. <returns>
  5493. <c>true</c> if [has child of type] [the specified record id]; otherwise, <c>false</c>.
  5494. </returns>
  5495. </member>
  5496. <member name="M:NPOI.DDF.EscherContainerRecord.Display(System.Int32)">
  5497. <summary>
  5498. The display methods allows escher variables to print the record names
  5499. according to their hierarchy.
  5500. </summary>
  5501. <param name="indent">The current indent level.</param>
  5502. </member>
  5503. <member name="M:NPOI.DDF.EscherContainerRecord.AddChildRecord(NPOI.DDF.EscherRecord)">
  5504. <summary>
  5505. Adds the child record.
  5506. </summary>
  5507. <param name="record">The record.</param>
  5508. </member>
  5509. <member name="M:NPOI.DDF.EscherContainerRecord.ToString">
  5510. <summary>
  5511. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5512. </summary>
  5513. <returns>
  5514. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5515. </returns>
  5516. </member>
  5517. <member name="M:NPOI.DDF.EscherContainerRecord.GetChildById(System.Int16)">
  5518. <summary>
  5519. Gets the child by id.
  5520. </summary>
  5521. <param name="recordId">The record id.</param>
  5522. <returns></returns>
  5523. </member>
  5524. <member name="M:NPOI.DDF.EscherContainerRecord.GetRecordsById(System.Int16,System.Collections.ArrayList@)">
  5525. <summary>
  5526. Recursively find records with the specified record ID
  5527. </summary>
  5528. <param name="recordId"></param>
  5529. <param name="out1">list to store found records</param>
  5530. </member>
  5531. <member name="P:NPOI.DDF.EscherContainerRecord.RecordSize">
  5532. <summary>
  5533. Subclasses should effeciently return the number of bytes required to
  5534. Serialize the record.
  5535. </summary>
  5536. <value>number of bytes</value>
  5537. </member>
  5538. <member name="P:NPOI.DDF.EscherContainerRecord.ChildRecords">
  5539. <summary>
  5540. Returns a list of all the child (escher) records
  5541. of the container.
  5542. </summary>
  5543. <value></value>
  5544. </member>
  5545. <member name="P:NPOI.DDF.EscherContainerRecord.ChildContainers">
  5546. <summary>
  5547. Returns all of our children which are also
  5548. EscherContainers (may be 0, 1, or vary rarely
  5549. 2 or 3)
  5550. </summary>
  5551. <value>The child containers.</value>
  5552. </member>
  5553. <member name="P:NPOI.DDF.EscherContainerRecord.RecordName">
  5554. <summary>
  5555. Subclasses should return the short name for this escher record.
  5556. </summary>
  5557. <value></value>
  5558. </member>
  5559. <member name="T:NPOI.DDF.EscherDggRecord">
  5560. <summary>
  5561. This record defines the drawing groups used for a particular sheet.
  5562. </summary>
  5563. </member>
  5564. <member name="M:NPOI.DDF.EscherDggRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  5565. <summary>
  5566. This method deSerializes the record from a byte array.
  5567. </summary>
  5568. <param name="data">The byte array containing the escher record information</param>
  5569. <param name="offset">The starting offset into data</param>
  5570. <param name="recordFactory">May be null since this is not a container record.</param>
  5571. <returns>The number of bytes Read from the byte array.</returns>
  5572. </member>
  5573. <member name="M:NPOI.DDF.EscherDggRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  5574. <summary>
  5575. This method Serializes this escher record into a byte array.
  5576. </summary>
  5577. <param name="offset">The offset into data to start writing the record data to.</param>
  5578. <param name="data">The byte array to Serialize to.</param>
  5579. <param name="listener">a listener for begin and end serialization events.</param>
  5580. <returns>The number of bytes written.</returns>
  5581. </member>
  5582. <member name="M:NPOI.DDF.EscherDggRecord.ToString">
  5583. <summary>
  5584. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5585. </summary>
  5586. <returns>
  5587. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5588. </returns>
  5589. </member>
  5590. <member name="M:NPOI.DDF.EscherDggRecord.AddCluster(System.Int32,System.Int32)">
  5591. <summary>
  5592. Adds the cluster.
  5593. </summary>
  5594. <param name="dgId">The dg id.</param>
  5595. <param name="numShapedUsed">The num shaped used.</param>
  5596. </member>
  5597. <member name="M:NPOI.DDF.EscherDggRecord.AddCluster(System.Int32,System.Int32,System.Boolean)">
  5598. <summary>
  5599. Adds the cluster.
  5600. </summary>
  5601. <param name="dgId">id of the drawing group (stored in the record options)</param>
  5602. <param name="numShapedUsed">initial value of the numShapedUsed field</param>
  5603. <param name="sort">if set to <c>true</c> if true then sort clusters by drawing group id.(
  5604. In Excel the clusters are sorted but in PPT they are not).</param>
  5605. </member>
  5606. <member name="P:NPOI.DDF.EscherDggRecord.RecordSize">
  5607. <summary>
  5608. Returns the number of bytes that are required to Serialize this record.
  5609. </summary>
  5610. <value>Number of bytes</value>
  5611. </member>
  5612. <member name="P:NPOI.DDF.EscherDggRecord.RecordId">
  5613. <summary>
  5614. Return the current record id.
  5615. </summary>
  5616. <value>The 16 bit record id.</value>
  5617. </member>
  5618. <member name="P:NPOI.DDF.EscherDggRecord.RecordName">
  5619. <summary>
  5620. The short name for this record
  5621. </summary>
  5622. <value></value>
  5623. </member>
  5624. <member name="P:NPOI.DDF.EscherDggRecord.ShapeIdMax">
  5625. <summary>
  5626. Gets or sets the shape id max.
  5627. </summary>
  5628. <value>The shape id max.</value>
  5629. </member>
  5630. <member name="P:NPOI.DDF.EscherDggRecord.NumIdClusters">
  5631. <summary>
  5632. Gets the Number of id clusters + 1
  5633. </summary>
  5634. <value>The num id clusters.</value>
  5635. </member>
  5636. <member name="P:NPOI.DDF.EscherDggRecord.NumShapesSaved">
  5637. <summary>
  5638. Gets or sets the num shapes saved.
  5639. </summary>
  5640. <value>The num shapes saved.</value>
  5641. </member>
  5642. <member name="P:NPOI.DDF.EscherDggRecord.DrawingsSaved">
  5643. <summary>
  5644. Gets or sets the drawings saved.
  5645. </summary>
  5646. <value>The drawings saved.</value>
  5647. </member>
  5648. <member name="P:NPOI.DDF.EscherDggRecord.MaxDrawingGroupId">
  5649. <summary>
  5650. Gets or sets the max drawing group id.
  5651. </summary>
  5652. <value>The max drawing group id.</value>
  5653. </member>
  5654. <member name="P:NPOI.DDF.EscherDggRecord.FileIdClusters">
  5655. <summary>
  5656. Gets or sets the file id clusters.
  5657. </summary>
  5658. <value>The file id clusters.</value>
  5659. </member>
  5660. <member name="T:NPOI.DDF.EscherDgRecord">
  5661. <summary>
  5662. This record simply holds the number of shapes in the drawing group and the
  5663. last shape id used for this drawing group.
  5664. @author Glen Stampoultzis
  5665. </summary>
  5666. </member>
  5667. <member name="M:NPOI.DDF.EscherDgRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  5668. <summary>
  5669. This method deSerializes the record from a byte array.
  5670. </summary>
  5671. <param name="data">The byte array containing the escher record information</param>
  5672. <param name="offset">The starting offset into data</param>
  5673. <param name="recordFactory">May be null since this is not a container record.</param>
  5674. <returns>The number of bytes Read from the byte array.</returns>
  5675. </member>
  5676. <member name="M:NPOI.DDF.EscherDgRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  5677. <summary>
  5678. This method Serializes this escher record into a byte array.
  5679. </summary>
  5680. <param name="offset"> The offset into data to start writing the record data to.</param>
  5681. <param name="data"> The byte array to Serialize to.</param>
  5682. <returns>The number of bytes written.</returns>
  5683. <param name="listener">a listener for begin and end serialization events.</param>
  5684. </member>
  5685. <member name="M:NPOI.DDF.EscherDgRecord.ToString">
  5686. <summary>
  5687. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5688. </summary>
  5689. <returns>
  5690. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5691. </returns>
  5692. </member>
  5693. <member name="M:NPOI.DDF.EscherDgRecord.IncrementShapeCount">
  5694. <summary>
  5695. Increments the shape count.
  5696. </summary>
  5697. </member>
  5698. <member name="P:NPOI.DDF.EscherDgRecord.RecordSize">
  5699. <summary>
  5700. Returns the number of bytes that are required to Serialize this record.
  5701. </summary>
  5702. <value>Number of bytes</value>
  5703. </member>
  5704. <member name="P:NPOI.DDF.EscherDgRecord.RecordId">
  5705. <summary>
  5706. Return the current record id.
  5707. </summary>
  5708. <value>The 16 bit record id.</value>
  5709. </member>
  5710. <member name="P:NPOI.DDF.EscherDgRecord.RecordName">
  5711. <summary>
  5712. The short name for this record
  5713. </summary>
  5714. <value></value>
  5715. </member>
  5716. <member name="P:NPOI.DDF.EscherDgRecord.NumShapes">
  5717. <summary>
  5718. Gets or sets The number of shapes in this drawing group.
  5719. </summary>
  5720. <value>The num shapes.</value>
  5721. </member>
  5722. <member name="P:NPOI.DDF.EscherDgRecord.LastMSOSPID">
  5723. <summary>
  5724. Gets or sets The last shape id used in this drawing group.
  5725. </summary>
  5726. <value>The last MSOSPID.</value>
  5727. </member>
  5728. <member name="P:NPOI.DDF.EscherDgRecord.DrawingGroupId">
  5729. <summary>
  5730. Gets the drawing group id for this record. This is encoded in the
  5731. instance part of the option record.
  5732. </summary>
  5733. <value>The drawing group id.</value>
  5734. </member>
  5735. <member name="T:NPOI.DDF.EscherDump">
  5736. <summary>
  5737. Used to dump the contents of escher records to a PrintStream.
  5738. @author Glen Stampoultzis (glens at apache.org)
  5739. </summary>
  5740. </member>
  5741. <member name="M:NPOI.DDF.EscherDump.Dump(System.Byte[],System.Int32,System.Int32)">
  5742. <summary>
  5743. Decodes the escher stream from a byte array and dumps the results to
  5744. a print stream.
  5745. </summary>
  5746. <param name="data">The data array containing the escher records.</param>
  5747. <param name="offset">The starting offset within the data array.</param>
  5748. <param name="size">The number of bytes to Read.</param>
  5749. </member>
  5750. <member name="M:NPOI.DDF.EscherDump.DumpOld(System.Int64,System.IO.Stream)">
  5751. <summary>
  5752. This version of dump is a translation from the open office escher dump routine.
  5753. </summary>
  5754. <param name="maxLength">The number of bytes to Read</param>
  5755. <param name="in1">An input stream to Read from.</param>
  5756. </member>
  5757. <member name="M:NPOI.DDF.EscherDump.PropertyName(System.Int16)">
  5758. <summary>
  5759. Returns a property name given a property id. This is used only by the
  5760. old escher dump routine.
  5761. </summary>
  5762. <param name="propertyId">The property number for the name</param>
  5763. <returns>A descriptive name.</returns>
  5764. </member>
  5765. <member name="M:NPOI.DDF.EscherDump.GetBlipType(System.Byte)">
  5766. <summary>
  5767. Returns the blip description given a blip id.
  5768. </summary>
  5769. <param name="b">blip id</param>
  5770. <returns> A description.</returns>
  5771. </member>
  5772. <member name="M:NPOI.DDF.EscherDump.Dec1616(System.Int32)">
  5773. <summary>
  5774. Straight conversion from OO. Converts a type of float.
  5775. </summary>
  5776. <param name="n32">The N32.</param>
  5777. <returns></returns>
  5778. </member>
  5779. <member name="M:NPOI.DDF.EscherDump.OutHex(System.Int32,System.IO.Stream)">
  5780. <summary>
  5781. Dumps out a hex value by Reading from a input stream.
  5782. </summary>
  5783. <param name="bytes">How many bytes this hex value consists of.</param>
  5784. <param name="in1">The stream to Read the hex value from.</param>
  5785. </member>
  5786. <member name="M:NPOI.DDF.EscherDump.Dump(System.Int32,System.Byte[])">
  5787. <summary>
  5788. Dumps the specified record size.
  5789. </summary>
  5790. <param name="recordSize">Size of the record.</param>
  5791. <param name="data">The data.</param>
  5792. </member>
  5793. <member name="T:NPOI.DDF.EscherMetafileBlip">
  5794. <summary>
  5795. @author Daniel Noll
  5796. </summary>
  5797. </member>
  5798. <member name="F:NPOI.DDF.EscherMetafileBlip.SIGNATURE_EMF">
  5799. BLIP signatures as defined in the escher spec
  5800. </member>
  5801. <member name="F:NPOI.DDF.EscherMetafileBlip.field_2_UID">
  5802. The primary UID is only saved to disk if (blip_instance ^ blip_signature == 1)
  5803. </member>
  5804. <member name="M:NPOI.DDF.EscherMetafileBlip.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  5805. <summary>
  5806. This method deSerializes the record from a byte array.
  5807. </summary>
  5808. <param name="data">The byte array containing the escher record information</param>
  5809. <param name="offset">The starting offset into</param>
  5810. <param name="recordFactory">May be null since this is not a container record.</param>
  5811. <returns>
  5812. The number of bytes Read from the byte array.
  5813. </returns>
  5814. </member>
  5815. <member name="M:NPOI.DDF.EscherMetafileBlip.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  5816. <summary>
  5817. Serializes the record to an existing byte array.
  5818. </summary>
  5819. <param name="offset">the offset within the byte array</param>
  5820. <param name="data">the data array to Serialize to</param>
  5821. <param name="listener">a listener for begin and end serialization events.</param>
  5822. <returns>the number of bytes written.</returns>
  5823. </member>
  5824. <member name="M:NPOI.DDF.EscherMetafileBlip.InflatePictureData(System.Byte[])">
  5825. <summary>
  5826. Decompresses the provided data, returning the inflated result.
  5827. </summary>
  5828. <param name="data">the deflated picture data.</param>
  5829. <returns>the inflated picture data.</returns>
  5830. </member>
  5831. <member name="M:NPOI.DDF.EscherMetafileBlip.ToString">
  5832. <summary>
  5833. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5834. </summary>
  5835. <returns>
  5836. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5837. </returns>
  5838. </member>
  5839. <member name="P:NPOI.DDF.EscherMetafileBlip.RecordSize">
  5840. <summary>
  5841. Returns the number of bytes that are required to Serialize this record.
  5842. </summary>
  5843. <value>Number of bytes</value>
  5844. </member>
  5845. <member name="P:NPOI.DDF.EscherMetafileBlip.UID">
  5846. <summary>
  5847. Gets or sets the UID.
  5848. </summary>
  5849. <value>The UID.</value>
  5850. </member>
  5851. <member name="P:NPOI.DDF.EscherMetafileBlip.PrimaryUID">
  5852. <summary>
  5853. Gets or sets the primary UID.
  5854. </summary>
  5855. <value>The primary UID.</value>
  5856. </member>
  5857. <member name="P:NPOI.DDF.EscherMetafileBlip.UncompressedSize">
  5858. <summary>
  5859. Gets or sets the size of the uncompressed.
  5860. </summary>
  5861. <value>The size of the uncompressed.</value>
  5862. </member>
  5863. <member name="P:NPOI.DDF.EscherMetafileBlip.Bounds">
  5864. <summary>
  5865. Gets or sets the bounds.
  5866. </summary>
  5867. <value>The bounds.</value>
  5868. </member>
  5869. <member name="P:NPOI.DDF.EscherMetafileBlip.SizeEMU">
  5870. <summary>
  5871. Gets or sets the size EMU.
  5872. </summary>
  5873. <value>The size EMU.</value>
  5874. </member>
  5875. <member name="P:NPOI.DDF.EscherMetafileBlip.CompressedSize">
  5876. <summary>
  5877. Gets or sets the size of the compressed.
  5878. </summary>
  5879. <value>The size of the compressed.</value>
  5880. </member>
  5881. <member name="P:NPOI.DDF.EscherMetafileBlip.IsCompressed">
  5882. <summary>
  5883. Gets or sets a value indicating whether this instance is compressed.
  5884. </summary>
  5885. <value>
  5886. <c>true</c> if this instance is compressed; otherwise, <c>false</c>.
  5887. </value>
  5888. </member>
  5889. <member name="P:NPOI.DDF.EscherMetafileBlip.Signature">
  5890. <summary>
  5891. Return the blip signature
  5892. </summary>
  5893. <value>the blip signature</value>
  5894. </member>
  5895. <member name="T:NPOI.DDF.EscherOptRecord">
  5896. <summary>
  5897. The opt record is used to store property values for a shape. It is the key to determining
  5898. the attributes of a shape. Properties can be of two types: simple or complex. Simple types
  5899. are fixed Length. Complex properties are variable Length.
  5900. @author Glen Stampoultzis
  5901. </summary>
  5902. </member>
  5903. <member name="P:NPOI.DDF.EscherOptRecord.Options">
  5904. <summary>
  5905. Automatically recalculate the correct option
  5906. </summary>
  5907. <value></value>
  5908. </member>
  5909. <member name="P:NPOI.DDF.EscherOptRecord.RecordName">
  5910. <summary>
  5911. The short name for this record
  5912. </summary>
  5913. <value></value>
  5914. </member>
  5915. <member name="T:NPOI.DDF.EscherPictBlip">
  5916. <summary>
  5917. @author Daniel Noll
  5918. </summary>
  5919. </member>
  5920. <member name="M:NPOI.DDF.EscherPictBlip.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  5921. <summary>
  5922. This method deSerializes the record from a byte array.
  5923. </summary>
  5924. <param name="data">The byte array containing the escher record information</param>
  5925. <param name="offset">The starting offset into</param>
  5926. <param name="recordFactory">May be null since this is not a container record.</param>
  5927. <returns>
  5928. The number of bytes Read from the byte array.
  5929. </returns>
  5930. </member>
  5931. <member name="M:NPOI.DDF.EscherPictBlip.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  5932. <summary>
  5933. Serializes the record to an existing byte array.
  5934. </summary>
  5935. <param name="offset">the offset within the byte array</param>
  5936. <param name="data">the data array to Serialize to</param>
  5937. <param name="listener">a listener for begin and end serialization events.</param>
  5938. <returns>the number of bytes written.</returns>
  5939. </member>
  5940. <member name="M:NPOI.DDF.EscherPictBlip.InflatePictureData(System.Byte[])">
  5941. <summary>
  5942. Decompresses the provided data, returning the inflated result.
  5943. </summary>
  5944. <param name="data">the deflated picture data.</param>
  5945. <returns>the inflated picture data.</returns>
  5946. </member>
  5947. <member name="M:NPOI.DDF.EscherPictBlip.ToString">
  5948. <summary>
  5949. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5950. </summary>
  5951. <returns>
  5952. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5953. </returns>
  5954. </member>
  5955. <member name="P:NPOI.DDF.EscherPictBlip.RecordSize">
  5956. <summary>
  5957. Returns the number of bytes that are required to Serialize this record.
  5958. </summary>
  5959. <value>Number of bytes</value>
  5960. </member>
  5961. <member name="P:NPOI.DDF.EscherPictBlip.UID">
  5962. <summary>
  5963. Gets or sets the UID.
  5964. </summary>
  5965. <value>The UID.</value>
  5966. </member>
  5967. <member name="P:NPOI.DDF.EscherPictBlip.UncompressedSize">
  5968. <summary>
  5969. Gets or sets the size of the uncompressed.
  5970. </summary>
  5971. <value>The size of the uncompressed.</value>
  5972. </member>
  5973. <member name="P:NPOI.DDF.EscherPictBlip.Bounds">
  5974. <summary>
  5975. Gets or sets the bounds.
  5976. </summary>
  5977. <value>The bounds.</value>
  5978. </member>
  5979. <member name="P:NPOI.DDF.EscherPictBlip.SizeEMU">
  5980. <summary>
  5981. Gets or sets the size EMU.
  5982. </summary>
  5983. <value>The size EMU.</value>
  5984. </member>
  5985. <member name="P:NPOI.DDF.EscherPictBlip.CompressedSize">
  5986. <summary>
  5987. Gets or sets the size of the compressed.
  5988. </summary>
  5989. <value>The size of the compressed.</value>
  5990. </member>
  5991. <member name="P:NPOI.DDF.EscherPictBlip.IsCompressed">
  5992. <summary>
  5993. Gets a value indicating whether this instance is compressed.
  5994. </summary>
  5995. <value>
  5996. <c>true</c> if this instance is compressed; otherwise, <c>false</c>.
  5997. </value>
  5998. </member>
  5999. <member name="T:NPOI.DDF.EscherProperties">
  6000. <summary>
  6001. Provides a list of all known escher properties including the description and
  6002. type.
  6003. @author Glen Stampoultzis (glens at apache.org)
  6004. </summary>
  6005. </member>
  6006. <member name="M:NPOI.DDF.EscherProperties.InitProps">
  6007. <summary>
  6008. Inits the props.
  6009. </summary>
  6010. </member>
  6011. <member name="M:NPOI.DDF.EscherProperties.AddProp(System.Int32,NPOI.DDF.EscherPropertyMetaData)">
  6012. <summary>
  6013. Adds the prop.
  6014. </summary>
  6015. <param name="s">The s.</param>
  6016. <param name="data">The data.</param>
  6017. </member>
  6018. <member name="M:NPOI.DDF.EscherProperties.GetData(System.String,System.Byte)">
  6019. <summary>
  6020. Gets the data.
  6021. </summary>
  6022. <param name="propName">Name of the prop.</param>
  6023. <param name="type">The type.</param>
  6024. <returns></returns>
  6025. </member>
  6026. <member name="M:NPOI.DDF.EscherProperties.GetData(System.String)">
  6027. <summary>
  6028. Gets the data.
  6029. </summary>
  6030. <param name="propName">Name of the prop.</param>
  6031. <returns></returns>
  6032. </member>
  6033. <member name="M:NPOI.DDF.EscherProperties.GetPropertyName(System.Int16)">
  6034. <summary>
  6035. Gets the name of the property.
  6036. </summary>
  6037. <param name="propertyId">The property id.</param>
  6038. <returns></returns>
  6039. </member>
  6040. <member name="M:NPOI.DDF.EscherProperties.GetPropertyType(System.Int16)">
  6041. <summary>
  6042. Gets the type of the property.
  6043. </summary>
  6044. <param name="propertyId">The property id.</param>
  6045. <returns></returns>
  6046. </member>
  6047. <member name="T:NPOI.DDF.EscherPropertyFactory">
  6048. <summary>
  6049. Generates a property given a reference into the byte array storing that property.
  6050. @author Glen Stampoultzis
  6051. </summary>
  6052. </member>
  6053. <member name="M:NPOI.DDF.EscherPropertyFactory.CreateProperties(System.Byte[],System.Int32,System.Int16)">
  6054. <summary>
  6055. Create new properties from a byte array.
  6056. </summary>
  6057. <param name="data">The byte array containing the property</param>
  6058. <param name="offset">The starting offset into the byte array</param>
  6059. <param name="numProperties">The new properties</param>
  6060. <returns></returns>
  6061. </member>
  6062. <member name="T:NPOI.DDF.EscherPropertyMetaData">
  6063. <summary>
  6064. This class stores the type and description of an escher property.
  6065. @author Glen Stampoultzis (glens at apache.org)
  6066. </summary>
  6067. </member>
  6068. <member name="M:NPOI.DDF.EscherPropertyMetaData.#ctor(System.String)">
  6069. <summary>
  6070. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherPropertyMetaData"/> class.
  6071. </summary>
  6072. <param name="description">The description of the escher property.</param>
  6073. </member>
  6074. <member name="M:NPOI.DDF.EscherPropertyMetaData.#ctor(System.String,System.Byte)">
  6075. <summary>
  6076. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherPropertyMetaData"/> class.
  6077. </summary>
  6078. <param name="description">The description of the escher property.</param>
  6079. <param name="type">The type of the property.</param>
  6080. </member>
  6081. <member name="P:NPOI.DDF.EscherPropertyMetaData.Description">
  6082. <summary>
  6083. Gets the description.
  6084. </summary>
  6085. <value>The description.</value>
  6086. </member>
  6087. <member name="P:NPOI.DDF.EscherPropertyMetaData.Type">
  6088. <summary>
  6089. Gets the type.
  6090. </summary>
  6091. <value>The type.</value>
  6092. </member>
  6093. <member name="T:NPOI.DDF.EscherRGBProperty">
  6094. <summary>
  6095. A color property.
  6096. @author Glen Stampoultzis (glens at apache.org)
  6097. </summary>
  6098. </member>
  6099. <member name="M:NPOI.DDF.EscherRGBProperty.#ctor(System.Int16,System.Int32)">
  6100. <summary>
  6101. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherRGBProperty"/> class.
  6102. </summary>
  6103. <param name="propertyNumber">The property number.</param>
  6104. <param name="rgbColor">Color of the RGB.</param>
  6105. </member>
  6106. <member name="P:NPOI.DDF.EscherRGBProperty.RgbColor">
  6107. <summary>
  6108. Gets the color of the RGB.
  6109. </summary>
  6110. <value>The color of the RGB.</value>
  6111. </member>
  6112. <member name="P:NPOI.DDF.EscherRGBProperty.Red">
  6113. <summary>
  6114. Gets the red.
  6115. </summary>
  6116. <value>The red.</value>
  6117. </member>
  6118. <member name="P:NPOI.DDF.EscherRGBProperty.Green">
  6119. <summary>
  6120. Gets the green.
  6121. </summary>
  6122. <value>The green.</value>
  6123. </member>
  6124. <member name="P:NPOI.DDF.EscherRGBProperty.Blue">
  6125. <summary>
  6126. Gets the blue.
  6127. </summary>
  6128. <value>The blue.</value>
  6129. </member>
  6130. <member name="T:NPOI.DDF.EscherSerializationListener">
  6131. Interface for listening to escher serialization events.
  6132. @author Glen Stampoultzis (glens at apache.org)
  6133. </member>
  6134. <member name="M:NPOI.DDF.EscherSerializationListener.BeforeRecordSerialize(System.Int32,System.Int16,NPOI.DDF.EscherRecord)">
  6135. Fired before a given escher record is Serialized.
  6136. @param offset The position in the data array at which the record will be Serialized.
  6137. @param recordId The id of the record about to be Serialized.
  6138. </member>
  6139. <member name="M:NPOI.DDF.EscherSerializationListener.AfterRecordSerialize(System.Int32,System.Int16,System.Int32,NPOI.DDF.EscherRecord)">
  6140. Fired after a record has been Serialized.
  6141. @param offset The position of the end of the Serialized record + 1
  6142. @param recordId The id of the record about to be Serialized
  6143. @param size The number of bytes written for this record. If it is a container
  6144. record then this will include the size of any included records.
  6145. </member>
  6146. <member name="T:NPOI.DDF.EscherShapePathProperty">
  6147. <summary>
  6148. Defines the constants for the various possible shape paths.
  6149. @author Glen Stampoultzis (glens at apache.org)
  6150. </summary>
  6151. </member>
  6152. <member name="M:NPOI.DDF.EscherShapePathProperty.#ctor(System.Int16,System.Int32)">
  6153. <summary>
  6154. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherShapePathProperty"/> class.
  6155. </summary>
  6156. <param name="propertyNumber">The property number.</param>
  6157. <param name="shapePath">The shape path.</param>
  6158. </member>
  6159. <member name="T:NPOI.DDF.EscherSpgrRecord">
  6160. <summary>
  6161. The spgr record defines information about a shape group. Groups in escher
  6162. are simply another form of shape that you can't physically see.
  6163. @author Glen Stampoultzis (glens at apache.org)
  6164. </summary>
  6165. </member>
  6166. <member name="M:NPOI.DDF.EscherSpgrRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  6167. <summary>
  6168. This method deSerializes the record from a byte array.
  6169. </summary>
  6170. <param name="data">The byte array containing the escher record information</param>
  6171. <param name="offset">The starting offset into data</param>
  6172. <param name="recordFactory">May be null since this is not a container record.</param>
  6173. <returns>The number of bytes Read from the byte array.</returns>
  6174. </member>
  6175. <member name="M:NPOI.DDF.EscherSpgrRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  6176. <summary>
  6177. This method Serializes this escher record into a byte array
  6178. </summary>
  6179. <param name="offset">The offset into data
  6180. to start writing the record data to.</param>
  6181. <param name="data">The byte array to Serialize to.</param>
  6182. <param name="listener">a listener for begin and end serialization events.</param>
  6183. <returns>The number of bytes written.</returns>
  6184. </member>
  6185. <member name="M:NPOI.DDF.EscherSpgrRecord.ToString">
  6186. <summary>
  6187. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  6188. </summary>
  6189. <returns>
  6190. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  6191. </returns>
  6192. </member>
  6193. <member name="P:NPOI.DDF.EscherSpgrRecord.RecordSize">
  6194. <summary>
  6195. Returns the number of bytes that are required to Serialize this record.
  6196. </summary>
  6197. <value>Number of bytes</value>
  6198. </member>
  6199. <member name="P:NPOI.DDF.EscherSpgrRecord.RecordId">
  6200. <summary>
  6201. Return the current record id.
  6202. </summary>
  6203. <value>The 16 bit identifier of this shape group record.</value>
  6204. </member>
  6205. <member name="P:NPOI.DDF.EscherSpgrRecord.RecordName">
  6206. <summary>
  6207. The short name for this record
  6208. </summary>
  6209. <value></value>
  6210. </member>
  6211. <member name="P:NPOI.DDF.EscherSpgrRecord.RectX1">
  6212. <summary>
  6213. Gets or sets the starting top-left coordinate of child records.
  6214. </summary>
  6215. <value>The rect x1.</value>
  6216. </member>
  6217. <member name="P:NPOI.DDF.EscherSpgrRecord.RectX2">
  6218. <summary>
  6219. Gets or sets the starting bottom-right coordinate of child records.
  6220. </summary>
  6221. <value>The rect x2.</value>
  6222. </member>
  6223. <member name="P:NPOI.DDF.EscherSpgrRecord.RectY1">
  6224. <summary>
  6225. Gets or sets the starting top-left coordinate of child records.
  6226. </summary>
  6227. <value>The rect y1.</value>
  6228. </member>
  6229. <member name="P:NPOI.DDF.EscherSpgrRecord.RectY2">
  6230. <summary>
  6231. Gets or sets the starting bottom-right coordinate of child records.
  6232. </summary>
  6233. <value>The rect y2.</value>
  6234. </member>
  6235. <member name="T:NPOI.DDF.EscherSplitMenuColorsRecord">
  6236. <summary>
  6237. A list of the most recently used colours for the drawings contained in
  6238. this document.
  6239. @author Glen Stampoultzis (glens at apache.org)
  6240. </summary>
  6241. </member>
  6242. <member name="M:NPOI.DDF.EscherSplitMenuColorsRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  6243. <summary>
  6244. This method deSerializes the record from a byte array.
  6245. </summary>
  6246. <param name="data">The byte array containing the escher record information</param>
  6247. <param name="offset">The starting offset into data</param>
  6248. <param name="recordFactory">May be null since this is not a container record.</param>
  6249. <returns>The number of bytes Read from the byte array.</returns>
  6250. </member>
  6251. <member name="M:NPOI.DDF.EscherSplitMenuColorsRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  6252. <summary>
  6253. This method Serializes this escher record into a byte array
  6254. </summary>
  6255. <param name="offset">The offset into data
  6256. to start writing the record data to.</param>
  6257. <param name="data">The byte array to Serialize to.</param>
  6258. <param name="listener">a listener for begin and end serialization events.</param>
  6259. <returns>The number of bytes written.</returns>
  6260. </member>
  6261. <member name="M:NPOI.DDF.EscherSplitMenuColorsRecord.ToString">
  6262. <summary>
  6263. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  6264. </summary>
  6265. <returns>
  6266. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  6267. </returns>
  6268. @return a string representation of this record.
  6269. </member>
  6270. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.RecordSize">
  6271. <summary>
  6272. Returns the number of bytes that are required to Serialize this record.
  6273. </summary>
  6274. <value>number of bytes</value>
  6275. </member>
  6276. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.RecordId">
  6277. <summary>
  6278. Return the current record id.
  6279. </summary>
  6280. <value>the 16 bit identifer for this record.</value>
  6281. </member>
  6282. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.RecordName">
  6283. <summary>
  6284. Gets the short name for this record
  6285. </summary>
  6286. <value>The name of the record.</value>
  6287. </member>
  6288. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.Color1">
  6289. <summary>
  6290. Gets or sets the color1.
  6291. </summary>
  6292. <value>The color1.</value>
  6293. </member>
  6294. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.Color2">
  6295. <summary>
  6296. Gets or sets the color2.
  6297. </summary>
  6298. <value>The color2.</value>
  6299. </member>
  6300. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.Color3">
  6301. <summary>
  6302. Gets or sets the color3.
  6303. </summary>
  6304. <value>The color3.</value>
  6305. </member>
  6306. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.Color4">
  6307. <summary>
  6308. Gets or sets the color4.
  6309. </summary>
  6310. <value>The color4.</value>
  6311. </member>
  6312. <member name="T:NPOI.DDF.EscherSpRecord">
  6313. <summary>
  6314. ToGether the the EscherOptRecord this record defines some of the basic
  6315. properties of a shape.
  6316. @author Glen Stampoultzis (glens at apache.org)
  6317. </summary>
  6318. </member>
  6319. <member name="M:NPOI.DDF.EscherSpRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  6320. <summary>
  6321. The contract of this method is to deSerialize an escher record including
  6322. it's children.
  6323. </summary>
  6324. <param name="data">The byte array containing the Serialized escher
  6325. records.</param>
  6326. <param name="offset">The offset into the byte array.</param>
  6327. <param name="recordFactory">A factory for creating new escher records</param>
  6328. <returns>The number of bytes written.</returns>
  6329. </member>
  6330. <member name="M:NPOI.DDF.EscherSpRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  6331. <summary>
  6332. Serializes to an existing byte array without serialization listener.
  6333. This is done by delegating to Serialize(int, byte[], EscherSerializationListener).
  6334. </summary>
  6335. <param name="offset">the offset within the data byte array.</param>
  6336. <param name="data"> the data array to Serialize to.</param>
  6337. <param name="listener">a listener for begin and end serialization events.</param>
  6338. <returns>The number of bytes written.</returns>
  6339. </member>
  6340. <member name="M:NPOI.DDF.EscherSpRecord.ToString">
  6341. <summary>
  6342. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  6343. </summary>
  6344. <returns>
  6345. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  6346. </returns>
  6347. </member>
  6348. <member name="M:NPOI.DDF.EscherSpRecord.DecodeFlags(System.Int32)">
  6349. <summary>
  6350. Converts the shape flags into a more descriptive name.
  6351. </summary>
  6352. <param name="flags">The flags.</param>
  6353. <returns></returns>
  6354. </member>
  6355. <member name="P:NPOI.DDF.EscherSpRecord.RecordSize">
  6356. <summary>
  6357. Returns the number of bytes that are required to Serialize this record.
  6358. </summary>
  6359. <value>Number of bytes</value>
  6360. </member>
  6361. <member name="P:NPOI.DDF.EscherSpRecord.RecordId">
  6362. <summary>
  6363. @return the 16 bit identifier for this record.
  6364. </summary>
  6365. <value></value>
  6366. </member>
  6367. <member name="P:NPOI.DDF.EscherSpRecord.RecordName">
  6368. <summary>
  6369. The short name for this record
  6370. </summary>
  6371. <value></value>
  6372. </member>
  6373. <member name="P:NPOI.DDF.EscherSpRecord.ShapeId">
  6374. <summary>
  6375. Gets or sets A number that identifies this shape
  6376. </summary>
  6377. <value>The shape id.</value>
  6378. </member>
  6379. <member name="P:NPOI.DDF.EscherSpRecord.Flags">
  6380. <summary>
  6381. The flags that apply to this shape.
  6382. </summary>
  6383. <value>The flags.</value>
  6384. </member>
  6385. <member name="P:NPOI.DDF.EscherSpRecord.ShapeType">
  6386. <summary>
  6387. Get or set shape type. Must be one of MSOSPT values (see [MS-ODRAW] for details).
  6388. </summary>
  6389. </member>
  6390. <member name="T:NPOI.DDF.EscherTextboxRecord">
  6391. <summary>
  6392. Holds data from the parent application. Most commonly used to store
  6393. text in the format of the parent application, rather than in
  6394. Escher format. We don't attempt to understand the contents, since
  6395. they will be in the parent's format, not Escher format.
  6396. @author Glen Stampoultzis (glens at apache.org)
  6397. @author Nick Burch (nick at torchbox dot com)
  6398. </summary>
  6399. </member>
  6400. <member name="F:NPOI.DDF.EscherTextboxRecord._thedata">
  6401. The data for this record not including the the 8 byte header
  6402. </member>
  6403. <member name="M:NPOI.DDF.EscherTextboxRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  6404. This method deserializes the record from a byte array.
  6405. @param data The byte array containing the escher record information
  6406. @param offset The starting offset into <c>data</c>.
  6407. @param recordFactory May be null since this is not a container record.
  6408. @return The number of bytes Read from the byte array.
  6409. </member>
  6410. <member name="M:NPOI.DDF.EscherTextboxRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  6411. <summary>
  6412. Writes this record and any contained records to the supplied byte
  6413. </summary>
  6414. <param name="offset"></param>
  6415. <param name="data"></param>
  6416. <param name="listener">a listener for begin and end serialization events.</param>
  6417. <returns>the number of bytes written.</returns>
  6418. </member>
  6419. <member name="M:NPOI.DDF.EscherTextboxRecord.SetData(System.Byte[],System.Int32,System.Int32)">
  6420. <summary>
  6421. Sets the extra data (in the parent application's format) to be
  6422. contained by the record. Used when the parent application changes
  6423. the contents.
  6424. </summary>
  6425. <param name="b">The b.</param>
  6426. <param name="start">The start.</param>
  6427. <param name="length">The length.</param>
  6428. </member>
  6429. <member name="M:NPOI.DDF.EscherTextboxRecord.SetData(System.Byte[])">
  6430. <summary>
  6431. Sets the data.
  6432. </summary>
  6433. <param name="b">The b.</param>
  6434. </member>
  6435. <member name="M:NPOI.DDF.EscherTextboxRecord.ToString">
  6436. <summary>
  6437. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  6438. </summary>
  6439. <returns>
  6440. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  6441. </returns>
  6442. </member>
  6443. <member name="P:NPOI.DDF.EscherTextboxRecord.Data">
  6444. <summary>
  6445. Returns any extra data associated with this record. In practice excel
  6446. does not seem to put anything here, but with PowerPoint this will
  6447. contain the bytes that make up a TextHeaderAtom followed by a
  6448. TextBytesAtom/TextCharsAtom
  6449. </summary>
  6450. <value>The data.</value>
  6451. </member>
  6452. <member name="P:NPOI.DDF.EscherTextboxRecord.RecordSize">
  6453. <summary>
  6454. Returns the number of bytes that are required to serialize this record.
  6455. </summary>
  6456. <value>Number of bytes</value>
  6457. </member>
  6458. <member name="P:NPOI.DDF.EscherTextboxRecord.RecordName">
  6459. <summary>
  6460. The short name for this record
  6461. </summary>
  6462. <value></value>
  6463. </member>
  6464. <member name="T:NPOI.DDF.UnknownEscherRecord">
  6465. <summary>
  6466. This record is used whenever a escher record is encountered that
  6467. we do not explicitly support.
  6468. @author Glen Stampoultzis (glens at apache.org)
  6469. </summary>
  6470. </member>
  6471. <member name="F:NPOI.DDF.UnknownEscherRecord._thedata">
  6472. The data for this record not including the the 8 byte header
  6473. </member>
  6474. <member name="M:NPOI.DDF.UnknownEscherRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  6475. <summary>
  6476. This method deSerializes the record from a byte array.
  6477. </summary>
  6478. <param name="data"> The byte array containing the escher record information</param>
  6479. <param name="offset">The starting offset into data </param>
  6480. <param name="recordFactory">May be null since this is not a container record.</param>
  6481. <returns>The number of bytes Read from the byte array.</returns>
  6482. </member>
  6483. <member name="M:NPOI.DDF.UnknownEscherRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  6484. <summary>
  6485. Writes this record and any contained records to the supplied byte
  6486. array.
  6487. </summary>
  6488. <param name="offset"></param>
  6489. <param name="data"></param>
  6490. <param name="listener">a listener for begin and end serialization events.</param>
  6491. <returns>the number of bytes written.</returns>
  6492. </member>
  6493. <member name="M:NPOI.DDF.UnknownEscherRecord.ToString">
  6494. <summary>
  6495. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  6496. </summary>
  6497. <returns>
  6498. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  6499. </returns>
  6500. </member>
  6501. <member name="M:NPOI.DDF.UnknownEscherRecord.AddChildRecord(NPOI.DDF.EscherRecord)">
  6502. <summary>
  6503. Adds the child record.
  6504. </summary>
  6505. <param name="childRecord">The child record.</param>
  6506. </member>
  6507. <member name="P:NPOI.DDF.UnknownEscherRecord.Data">
  6508. <summary>
  6509. Gets the data.
  6510. </summary>
  6511. <value>The data.</value>
  6512. </member>
  6513. <member name="P:NPOI.DDF.UnknownEscherRecord.RecordSize">
  6514. <summary>
  6515. Returns the number of bytes that are required to Serialize this record.
  6516. </summary>
  6517. <value>Number of bytes</value>
  6518. </member>
  6519. <member name="P:NPOI.DDF.UnknownEscherRecord.ChildRecords">
  6520. <summary>
  6521. Returns the children of this record. By default this will
  6522. be an empty list. EscherCotainerRecord is the only record
  6523. that may contain children.
  6524. </summary>
  6525. <value></value>
  6526. </member>
  6527. <member name="P:NPOI.DDF.UnknownEscherRecord.RecordName">
  6528. <summary>
  6529. The short name for this record
  6530. </summary>
  6531. <value></value>
  6532. </member>
  6533. <member name="T:NPOI.HPSF.Constants">
  6534. <summary>
  6535. Defines constants of general use.
  6536. @author Rainer Klute klute@rainer-klute.de
  6537. @since 2004-06-20
  6538. </summary>
  6539. </member>
  6540. <member name="F:NPOI.HPSF.Constants.None">
  6541. <summary>
  6542. Allow accessing the Initial value.
  6543. </summary>
  6544. </member>
  6545. <member name="F:NPOI.HPSF.Constants.CP_037">
  6546. Codepage 037, a special case
  6547. </member>
  6548. <member name="F:NPOI.HPSF.Constants.CP_SJIS">
  6549. Codepage for SJIS
  6550. </member>
  6551. <member name="F:NPOI.HPSF.Constants.CP_GBK">
  6552. Codepage for GBK, aka MS936
  6553. </member>
  6554. <member name="F:NPOI.HPSF.Constants.CP_MS949">
  6555. Codepage for MS949
  6556. </member>
  6557. <member name="F:NPOI.HPSF.Constants.CP_UTF16">
  6558. Codepage for UTF-16
  6559. </member>
  6560. <member name="F:NPOI.HPSF.Constants.CP_UTF16_BE">
  6561. Codepage for UTF-16 big-endian
  6562. </member>
  6563. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1250">
  6564. Codepage for Windows 1250
  6565. </member>
  6566. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1251">
  6567. Codepage for Windows 1251
  6568. </member>
  6569. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1252">
  6570. Codepage for Windows 1252
  6571. </member>
  6572. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1253">
  6573. Codepage for Windows 1253
  6574. </member>
  6575. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1254">
  6576. Codepage for Windows 1254
  6577. </member>
  6578. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1255">
  6579. Codepage for Windows 1255
  6580. </member>
  6581. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1256">
  6582. Codepage for Windows 1256
  6583. </member>
  6584. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1257">
  6585. Codepage for Windows 1257
  6586. </member>
  6587. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1258">
  6588. Codepage for Windows 1258
  6589. </member>
  6590. <member name="F:NPOI.HPSF.Constants.CP_JOHAB">
  6591. Codepage for Johab
  6592. </member>
  6593. <member name="F:NPOI.HPSF.Constants.CP_MAC_ROMAN">
  6594. Codepage for Macintosh Roman (Java: MacRoman)
  6595. </member>
  6596. <member name="F:NPOI.HPSF.Constants.CP_MAC_JAPAN">
  6597. Codepage for Macintosh Japan (Java: unknown - use SJIS, cp942 or
  6598. cp943)
  6599. </member>
  6600. <member name="F:NPOI.HPSF.Constants.CP_MAC_CHINESE_TRADITIONAL">
  6601. Codepage for Macintosh Chinese Traditional (Java: unknown - use Big5,
  6602. MS950, or cp937)
  6603. </member>
  6604. <member name="F:NPOI.HPSF.Constants.CP_MAC_KOREAN">
  6605. Codepage for Macintosh Korean (Java: unknown - use EUC_KR or
  6606. cp949)
  6607. </member>
  6608. <member name="F:NPOI.HPSF.Constants.CP_MAC_ARABIC">
  6609. Codepage for Macintosh Arabic (Java: MacArabic)
  6610. </member>
  6611. <member name="F:NPOI.HPSF.Constants.CP_MAC_HEBREW">
  6612. Codepage for Macintosh Hebrew (Java: MacHebrew)
  6613. </member>
  6614. <member name="F:NPOI.HPSF.Constants.CP_MAC_GREEK">
  6615. Codepage for Macintosh Greek (Java: MacGreek)
  6616. </member>
  6617. <member name="F:NPOI.HPSF.Constants.CP_MAC_CYRILLIC">
  6618. Codepage for Macintosh Cyrillic (Java: MacCyrillic)
  6619. </member>
  6620. <member name="F:NPOI.HPSF.Constants.CP_MAC_CHINESE_SIMPLE">
  6621. Codepage for Macintosh Chinese Simplified (Java: unknown - use
  6622. EUC_CN, ISO2022_CN_GB, MS936 or cp935)
  6623. </member>
  6624. <member name="F:NPOI.HPSF.Constants.CP_MAC_ROMANIA">
  6625. Codepage for Macintosh Romanian (Java: MacRomania)
  6626. </member>
  6627. <member name="F:NPOI.HPSF.Constants.CP_MAC_UKRAINE">
  6628. Codepage for Macintosh Ukrainian (Java: MacUkraine)
  6629. </member>
  6630. <member name="F:NPOI.HPSF.Constants.CP_MAC_THAI">
  6631. Codepage for Macintosh Thai (Java: MacThai)
  6632. </member>
  6633. <member name="F:NPOI.HPSF.Constants.CP_MAC_CENTRAL_EUROPE">
  6634. Codepage for Macintosh Central Europe (Latin-2)
  6635. (Java: MacCentralEurope)
  6636. </member>
  6637. <member name="F:NPOI.HPSF.Constants.CP_MAC_ICELAND">
  6638. Codepage for Macintosh Iceland (Java: MacIceland)
  6639. </member>
  6640. <member name="F:NPOI.HPSF.Constants.CP_MAC_TURKISH">
  6641. Codepage for Macintosh Turkish (Java: MacTurkish)
  6642. </member>
  6643. <member name="F:NPOI.HPSF.Constants.CP_MAC_CROATIAN">
  6644. Codepage for Macintosh Croatian (Java: MacCroatian)
  6645. </member>
  6646. <member name="F:NPOI.HPSF.Constants.CP_US_ACSII">
  6647. Codepage for US-ASCII
  6648. </member>
  6649. <member name="F:NPOI.HPSF.Constants.CP_KOI8_R">
  6650. Codepage for KOI8-R
  6651. </member>
  6652. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_1">
  6653. Codepage for ISO-8859-1
  6654. </member>
  6655. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_2">
  6656. Codepage for ISO-8859-2
  6657. </member>
  6658. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_3">
  6659. Codepage for ISO-8859-3
  6660. </member>
  6661. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_4">
  6662. Codepage for ISO-8859-4
  6663. </member>
  6664. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_5">
  6665. Codepage for ISO-8859-5
  6666. </member>
  6667. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_6">
  6668. Codepage for ISO-8859-6
  6669. </member>
  6670. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_7">
  6671. Codepage for ISO-8859-7
  6672. </member>
  6673. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_8">
  6674. Codepage for ISO-8859-8
  6675. </member>
  6676. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_9">
  6677. Codepage for ISO-8859-9
  6678. </member>
  6679. <member name="F:NPOI.HPSF.Constants.CP_ISO_2022_JP1">
  6680. Codepage for ISO-2022-JP
  6681. </member>
  6682. <member name="F:NPOI.HPSF.Constants.CP_ISO_2022_JP2">
  6683. Another codepage for ISO-2022-JP
  6684. </member>
  6685. <member name="F:NPOI.HPSF.Constants.CP_ISO_2022_JP3">
  6686. Yet another codepage for ISO-2022-JP
  6687. </member>
  6688. <member name="F:NPOI.HPSF.Constants.CP_ISO_2022_KR">
  6689. Codepage for ISO-2022-KR
  6690. </member>
  6691. <member name="F:NPOI.HPSF.Constants.CP_EUC_JP">
  6692. Codepage for EUC-JP
  6693. </member>
  6694. <member name="F:NPOI.HPSF.Constants.CP_EUC_KR">
  6695. Codepage for EUC-KR
  6696. </member>
  6697. <member name="F:NPOI.HPSF.Constants.CP_GB2312">
  6698. Codepage for GB2312
  6699. </member>
  6700. <member name="F:NPOI.HPSF.Constants.CP_GB18030">
  6701. Codepage for GB18030
  6702. </member>
  6703. <member name="F:NPOI.HPSF.Constants.CP_US_ASCII2">
  6704. Another codepage for US-ASCII
  6705. </member>
  6706. <member name="F:NPOI.HPSF.Constants.CP_UTF8">
  6707. Codepage for UTF-8
  6708. </member>
  6709. <member name="F:NPOI.HPSF.Constants.CP_UNICODE">
  6710. Codepage for Unicode
  6711. </member>
  6712. <member name="T:NPOI.HPSF.CustomProperties">
  6713. <summary>
  6714. Maintains the instances of {@link CustomProperty} that belong To a
  6715. {@link DocumentSummaryInformation}. The class maintains the names of the
  6716. custom properties in a dictionary. It implements the {@link Map} interface
  6717. and by this provides a simplified view on custom properties: A property's
  6718. name is the key that maps To a typed value. This implementation hides
  6719. property IDs from the developer and regards the property names as keys To
  6720. typed values.
  6721. While this class provides a simple API To custom properties, it ignores
  6722. the fact that not names, but IDs are the real keys To properties. Under the
  6723. hood this class maintains a 1:1 relationship between IDs and names. Therefore
  6724. you should not use this class To process property Sets with several IDs
  6725. mapping To the same name or with properties without a name: the result will
  6726. contain only a subSet of the original properties. If you really need To deal
  6727. such property Sets, use HPSF's low-level access methods.
  6728. An application can call the {@link #isPure} method To check whether a
  6729. property Set parsed by {@link CustomProperties} is still pure (i.e.
  6730. unmodified) or whether one or more properties have been dropped.
  6731. This class is not thRead-safe; concurrent access To instances of this
  6732. class must be syncronized.
  6733. @author Rainer Klute
  6734. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  6735. @since 2006-02-09
  6736. </summary>
  6737. </member>
  6738. <member name="F:NPOI.HPSF.CustomProperties.dictionaryIDToName">
  6739. Maps property IDs To property names.
  6740. </member>
  6741. <member name="F:NPOI.HPSF.CustomProperties.dictionaryNameToID">
  6742. Maps property names To property IDs.
  6743. </member>
  6744. <member name="F:NPOI.HPSF.CustomProperties.isPure">
  6745. Tells whether this object is pure or not.
  6746. </member>
  6747. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,NPOI.HPSF.CustomProperty)">
  6748. <summary>
  6749. Puts a {@link CustomProperty} into this map. It is assumed that the
  6750. {@link CustomProperty} alReady has a valid ID. Otherwise use
  6751. {@link #Put(CustomProperty)}.
  6752. </summary>
  6753. <param name="name">The name.</param>
  6754. <param name="cp">The custom property.</param>
  6755. <returns></returns>
  6756. </member>
  6757. <member name="M:NPOI.HPSF.CustomProperties.KeySet">
  6758. Returns a set of all the names of our
  6759. custom properties. Equivalent to
  6760. {@link #nameSet()}
  6761. </member>
  6762. <member name="M:NPOI.HPSF.CustomProperties.NameSet">
  6763. Returns a set of all the names of our
  6764. custom properties
  6765. </member>
  6766. <member name="M:NPOI.HPSF.CustomProperties.IdSet">
  6767. Returns a set of all the IDs of our
  6768. custom properties
  6769. </member>
  6770. <member name="M:NPOI.HPSF.CustomProperties.Put(NPOI.HPSF.CustomProperty)">
  6771. <summary>
  6772. Puts a {@link CustomProperty} that has not yet a valid ID into this
  6773. map. The method will allocate a suitable ID for the custom property:
  6774. <ul>
  6775. <li>If there is alReady a property with the same name, take the ID
  6776. of that property.</li>
  6777. <li>Otherwise Find the highest ID and use its value plus one.</li>
  6778. </ul>
  6779. </summary>
  6780. <param name="customProperty">The custom property.</param>
  6781. <returns>If the was alReady a property with the same name, the</returns>
  6782. </member>
  6783. <member name="M:NPOI.HPSF.CustomProperties.Remove(System.String)">
  6784. <summary>
  6785. Removes a custom property.
  6786. </summary>
  6787. <param name="name">The name of the custom property To Remove</param>
  6788. <returns>The Removed property or
  6789. <c>null</c>
  6790. if the specified property was not found.</returns>
  6791. </member>
  6792. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.String)">
  6793. <summary>
  6794. Adds a named string property.
  6795. </summary>
  6796. <param name="name">The property's name.</param>
  6797. <param name="value">The property's value.</param>
  6798. <returns>the property that was stored under the specified name before, or
  6799. <c>null</c>
  6800. if there was no such property before.</returns>
  6801. </member>
  6802. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.Int64)">
  6803. <summary>
  6804. Adds a named long property
  6805. </summary>
  6806. <param name="name">The property's name.</param>
  6807. <param name="value">The property's value.</param>
  6808. <returns>the property that was stored under the specified name before, or
  6809. <c>null</c>
  6810. if there was no such property before.</returns>
  6811. </member>
  6812. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.Double)">
  6813. <summary>
  6814. Adds a named double property.
  6815. </summary>
  6816. <param name="name">The property's name.</param>
  6817. <param name="value">The property's value.</param>
  6818. <returns>the property that was stored under the specified name before, or
  6819. <c>null</c>
  6820. if there was no such property before.</returns>
  6821. </member>
  6822. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.Int32)">
  6823. <summary>
  6824. Adds a named integer property.
  6825. </summary>
  6826. <param name="name">The property's name.</param>
  6827. <param name="value">The property's value.</param>
  6828. <returns>the property that was stored under the specified name before, or
  6829. <c>null</c>
  6830. if there was no such property before.</returns>
  6831. </member>
  6832. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.Boolean)">
  6833. <summary>
  6834. Adds a named bool property.
  6835. </summary>
  6836. <param name="name">The property's name.</param>
  6837. <param name="value">The property's value.</param>
  6838. <returns>the property that was stored under the specified name before, or
  6839. <c>null</c>
  6840. if there was no such property before.</returns>
  6841. </member>
  6842. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.DateTime)">
  6843. <summary>
  6844. Adds a named date property.
  6845. </summary>
  6846. <param name="name">The property's name.</param>
  6847. <param name="value">The property's value.</param>
  6848. <returns>the property that was stored under the specified name before, or
  6849. <c>null</c>
  6850. if there was no such property before.</returns>
  6851. </member>
  6852. <member name="M:NPOI.HPSF.CustomProperties.ContainsKey(System.Object)">
  6853. Checks against both String Name and Long ID
  6854. </member>
  6855. <member name="M:NPOI.HPSF.CustomProperties.ContainsValue(System.Object)">
  6856. Checks against both the property, and its values.
  6857. </member>
  6858. <member name="P:NPOI.HPSF.CustomProperties.Item(System.String)">
  6859. <summary>
  6860. Gets the <see cref="T:System.Object"/> with the specified name.
  6861. </summary>
  6862. <value>the value or
  6863. <c>null</c>
  6864. if a value with the specified
  6865. name is not found in the custom properties.</value>
  6866. </member>
  6867. <member name="P:NPOI.HPSF.CustomProperties.Dictionary">
  6868. <summary>
  6869. Gets the dictionary which Contains IDs and names of the named custom
  6870. properties.
  6871. </summary>
  6872. <value>The dictionary.</value>
  6873. </member>
  6874. <member name="P:NPOI.HPSF.CustomProperties.Codepage">
  6875. <summary>
  6876. Gets or sets the codepage.
  6877. </summary>
  6878. <value>The codepage.</value>
  6879. </member>
  6880. <member name="P:NPOI.HPSF.CustomProperties.IsPure">
  6881. <summary>
  6882. Tells whether this {@link CustomProperties} instance is pure or one or
  6883. more properties of the underlying low-level property Set has been
  6884. dropped.
  6885. </summary>
  6886. <value><c>true</c> if this instance is pure; otherwise, <c>false</c>.</value>
  6887. </member>
  6888. <member name="T:NPOI.HPSF.CustomProperty">
  6889. <summary>
  6890. This class represents custum properties in the document summary
  6891. information stream. The difference To normal properties is that custom
  6892. properties have an optional name. If the name is not <c>null</c> it
  6893. will be maintained in the section's dictionary.
  6894. @author Rainer Klute
  6895. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  6896. @since 2006-02-09
  6897. </summary>
  6898. </member>
  6899. <member name="T:NPOI.HPSF.MutableProperty">
  6900. <summary>
  6901. Adds writing capability To the {@link Property} class.
  6902. Please be aware that this class' functionality will be merged into the
  6903. {@link Property} class at a later time, so the API will Change.
  6904. @author Rainer Klute
  6905. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  6906. @since 2003-08-03
  6907. </summary>
  6908. </member>
  6909. <member name="T:NPOI.HPSF.Property">
  6910. <summary>
  6911. A property in a {@link Section} of a {@link PropertySet}.
  6912. The property's ID gives the property a meaning
  6913. in the context of its {@link Section}. Each {@link Section} spans
  6914. its own name space of property IDs.
  6915. The property's type determines how its
  6916. value is interpreted. For example, if the type Is
  6917. {@link Variant#VT_LPSTR} (byte string), the value consists of a
  6918. DWord telling how many bytes the string Contains. The bytes follow
  6919. immediately, including any null bytes that terminate the
  6920. string. The type {@link Variant#VT_I4} denotes a four-byte integer
  6921. value, {@link Variant#VT_FILETIME} some DateTime and time (of a
  6922. file).
  6923. Please note that not all {@link Variant} types yet. This might Change
  6924. over time but largely depends on your feedback so that the POI team knows
  6925. which variant types are really needed. So please feel free To submit error
  6926. reports or patches for the types you need.
  6927. Microsoft documentation:
  6928. <a href="http://msdn.microsoft.com/library/en-us/stg/stg/property_Set_display_name_dictionary.asp?frame=true">
  6929. Property Set Display Name Dictionary</a>
  6930. .
  6931. @author Rainer Klute
  6932. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  6933. @author Drew Varner (Drew.Varner InAndAround sc.edu)
  6934. @see Section
  6935. @see Variant
  6936. @since 2002-02-09
  6937. </summary>
  6938. </member>
  6939. <member name="F:NPOI.HPSF.Property.id">
  6940. The property's ID.
  6941. </member>
  6942. <member name="F:NPOI.HPSF.Property.type">
  6943. The property's type.
  6944. </member>
  6945. <member name="F:NPOI.HPSF.Property.value">
  6946. The property's value.
  6947. </member>
  6948. <member name="M:NPOI.HPSF.Property.#ctor(System.Int64,System.Int64,System.Object)">
  6949. <summary>
  6950. Initializes a new instance of the <see cref="T:NPOI.HPSF.Property"/> class.
  6951. </summary>
  6952. <param name="id">the property's ID.</param>
  6953. <param name="type">the property's type, see {@link Variant}.</param>
  6954. <param name="value">the property's value. Only certain types are allowed, see
  6955. {@link Variant}.</param>
  6956. </member>
  6957. <member name="M:NPOI.HPSF.Property.#ctor(System.Int64,System.Byte[],System.Int64,System.Int32,System.Int32)">
  6958. <summary>
  6959. Initializes a new instance of the <see cref="T:NPOI.HPSF.Property"/> class.
  6960. </summary>
  6961. <param name="id">The property's ID.</param>
  6962. <param name="src">The bytes the property Set stream consists of.</param>
  6963. <param name="offset">The property's type/value pair's offset in the
  6964. section.</param>
  6965. <param name="Length">The property's type/value pair's Length in bytes.</param>
  6966. <param name="codepage">The section's and thus the property's
  6967. codepage. It is needed only when Reading string values</param>
  6968. </member>
  6969. <member name="M:NPOI.HPSF.Property.#ctor">
  6970. <summary>
  6971. Initializes a new instance of the <see cref="T:NPOI.HPSF.Property"/> class.
  6972. </summary>
  6973. </member>
  6974. <member name="M:NPOI.HPSF.Property.ReadDictionary(System.Byte[],System.Int64,System.Int32,System.Int32)">
  6975. <summary>
  6976. Reads the dictionary.
  6977. </summary>
  6978. <param name="src">The byte array containing the bytes making out the dictionary.</param>
  6979. <param name="offset">At this offset within src the dictionary starts.</param>
  6980. <param name="Length">The dictionary Contains at most this many bytes.</param>
  6981. <param name="codepage">The codepage of the string values.</param>
  6982. <returns>The dictonary</returns>
  6983. </member>
  6984. <member name="M:NPOI.HPSF.Property.Equals(System.Object)">
  6985. <summary>
  6986. Compares two properties.
  6987. Please beware that a property with
  6988. ID == 0 is a special case: It does not have a type, and its value is the
  6989. section's dictionary. Another special case are strings: Two properties
  6990. may have the different types Variant.VT_LPSTR and Variant.VT_LPWSTR;
  6991. </summary>
  6992. <param name="o">The o.</param>
  6993. <returns></returns>
  6994. </member>
  6995. <member name="M:NPOI.HPSF.Property.TypesAreEqual(System.Int64,System.Int64)">
  6996. <summary>
  6997. Typeses the are equal.
  6998. </summary>
  6999. <param name="t1">The t1.</param>
  7000. <param name="t2">The t2.</param>
  7001. <returns></returns>
  7002. </member>
  7003. <member name="M:NPOI.HPSF.Property.GetHashCode">
  7004. <summary>
  7005. Serves as a hash function for a particular type.
  7006. </summary>
  7007. <returns>
  7008. A hash code for the current <see cref="T:System.Object"/>.
  7009. </returns>
  7010. </member>
  7011. <member name="M:NPOI.HPSF.Property.ToString">
  7012. <summary>
  7013. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  7014. </summary>
  7015. <returns>
  7016. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  7017. </returns>
  7018. </member>
  7019. <member name="P:NPOI.HPSF.Property.ID">
  7020. Returns the property's ID.
  7021. @return The ID value
  7022. </member>
  7023. <member name="P:NPOI.HPSF.Property.Type">
  7024. Returns the property's type.
  7025. @return The type value
  7026. </member>
  7027. <member name="P:NPOI.HPSF.Property.Value">
  7028. <summary>
  7029. Gets the property's value.
  7030. </summary>
  7031. <value>The property's value</value>
  7032. </member>
  7033. <member name="P:NPOI.HPSF.Property.Count">
  7034. <summary>
  7035. Gets the property's size in bytes. This is always a multiple of
  7036. 4.
  7037. </summary>
  7038. <value>the property's size in bytes</value>
  7039. </member>
  7040. <member name="M:NPOI.HPSF.MutableProperty.#ctor">
  7041. <summary>
  7042. Creates an empty property. It must be Filled using the Set method To
  7043. be usable.
  7044. </summary>
  7045. </member>
  7046. <member name="M:NPOI.HPSF.MutableProperty.#ctor(NPOI.HPSF.Property)">
  7047. <summary>
  7048. Initializes a new instance of the <see cref="T:NPOI.HPSF.MutableProperty"/> class.
  7049. </summary>
  7050. <param name="p">The property To copy.</param>
  7051. </member>
  7052. <member name="M:NPOI.HPSF.MutableProperty.Write(System.IO.Stream,System.Int32)">
  7053. <summary>
  7054. Writes the property To an output stream.
  7055. </summary>
  7056. <param name="out1">The output stream To Write To.</param>
  7057. <param name="codepage">The codepage To use for writing non-wide strings</param>
  7058. <returns>the number of bytes written To the stream</returns>
  7059. </member>
  7060. <member name="M:NPOI.HPSF.CustomProperty.#ctor">
  7061. <summary>
  7062. Initializes a new instance of the <see cref="T:NPOI.HPSF.CustomProperty"/> class.
  7063. </summary>
  7064. </member>
  7065. <member name="M:NPOI.HPSF.CustomProperty.#ctor(NPOI.HPSF.Property)">
  7066. <summary>
  7067. Initializes a new instance of the <see cref="T:NPOI.HPSF.CustomProperty"/> class.
  7068. </summary>
  7069. <param name="property">the property To copy</param>
  7070. </member>
  7071. <member name="M:NPOI.HPSF.CustomProperty.#ctor(NPOI.HPSF.Property,System.String)">
  7072. <summary>
  7073. Initializes a new instance of the <see cref="T:NPOI.HPSF.CustomProperty"/> class.
  7074. </summary>
  7075. <param name="property">This property's attributes are copied To the new custom
  7076. property.</param>
  7077. <param name="name">The new custom property's name.</param>
  7078. </member>
  7079. <member name="M:NPOI.HPSF.CustomProperty.EqualsContents(System.Object)">
  7080. <summary>
  7081. Compares two custom properties for equality. The method returns
  7082. <c>true</c> if all attributes of the two custom properties are
  7083. equal.
  7084. </summary>
  7085. <param name="o">The custom property To Compare with.</param>
  7086. <returns><c>true</c>
  7087. if both custom properties are equal, else
  7088. <c>false</c></returns>
  7089. </member>
  7090. <member name="M:NPOI.HPSF.CustomProperty.GetHashCode">
  7091. <summary>
  7092. </summary>
  7093. <returns></returns>
  7094. @see Object#GetHashCode()
  7095. </member>
  7096. <member name="P:NPOI.HPSF.CustomProperty.Name">
  7097. <summary>
  7098. Gets or sets the property's name.
  7099. </summary>
  7100. <value>the property's name.</value>
  7101. </member>
  7102. <member name="T:NPOI.HPSF.DocumentSummaryInformation">
  7103. <summary>
  7104. Convenience class representing a DocumentSummary Information stream in a
  7105. Microsoft Office document.
  7106. @author Rainer Klute
  7107. klute@rainer-klute.de
  7108. @author Drew Varner (Drew.Varner cloSeto sc.edu)
  7109. @author robert_flaherty@hyperion.com
  7110. @since 2002-02-09
  7111. </summary>
  7112. </member>
  7113. <member name="T:NPOI.HPSF.SpecialPropertySet">
  7114. <summary>
  7115. Abstract superclass for the convenience classes {@link
  7116. SummaryInformation} and {@link DocumentSummaryInformation}.
  7117. The motivation behind this class is quite nasty if you look
  7118. behind the scenes, but it serves the application programmer well by
  7119. providing him with the easy-to-use {@link SummaryInformation} and
  7120. {@link DocumentSummaryInformation} classes. When parsing the data a
  7121. property Set stream consists of (possibly coming from an {@link
  7122. java.io.Stream}) we want To Read and process each byte only
  7123. once. Since we don't know in advance which kind of property Set we
  7124. have, we can expect only the most general {@link
  7125. PropertySet}. Creating a special subclass should be as easy as
  7126. calling the special subclass' constructor and pass the general
  7127. {@link PropertySet} in. To make things easy internally, the special
  7128. class just holds a reference To the general {@link PropertySet} and
  7129. delegates all method calls To it.
  7130. A cleaner implementation would have been like this: The {@link
  7131. PropertySetFactory} parses the stream data into some internal
  7132. object first. Then it Finds out whether the stream is a {@link
  7133. SummaryInformation}, a {@link DocumentSummaryInformation} or a
  7134. general {@link PropertySet}. However, the current implementation
  7135. went the other way round historically: the convenience classes came
  7136. only late To my mind.
  7137. @author Rainer Klute
  7138. klute@rainer-klute.de
  7139. @since 2002-02-09
  7140. </summary>
  7141. </member>
  7142. <member name="T:NPOI.HPSF.MutablePropertySet">
  7143. <summary>
  7144. Adds writing support To the {@link PropertySet} class.
  7145. Please be aware that this class' functionality will be merged into the
  7146. {@link PropertySet} class at a later time, so the API will Change.
  7147. @author Rainer Klute
  7148. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  7149. @since 2003-02-19
  7150. </summary>
  7151. </member>
  7152. <member name="T:NPOI.HPSF.PropertySet">
  7153. <summary>
  7154. Represents a property Set in the Horrible Property Set Format
  7155. (HPSF). These are usually metadata of a Microsoft Office
  7156. document.
  7157. An application that wants To access these metadata should Create
  7158. an instance of this class or one of its subclasses by calling the
  7159. factory method {@link PropertySetFactory#Create} and then retrieve
  7160. the information its needs by calling appropriate methods.
  7161. {@link PropertySetFactory#Create} does its work by calling one
  7162. of the constructors {@link PropertySet#PropertySet(InputStream)} or
  7163. {@link PropertySet#PropertySet(byte[])}. If the constructor's
  7164. argument is not in the Horrible Property Set Format, i.e. not a
  7165. property Set stream, or if any other error occurs, an appropriate
  7166. exception is thrown.
  7167. A {@link PropertySet} has a list of {@link Section}s, and each
  7168. {@link Section} has a {@link Property} array. Use {@link
  7169. #GetSections} To retrieve the {@link Section}s, then call {@link
  7170. Section#GetProperties} for each {@link Section} To Get hold of the
  7171. {@link Property} arrays. Since the vast majority of {@link
  7172. PropertySet}s Contains only a single {@link Section}, the
  7173. convenience method {@link #GetProperties} returns the properties of
  7174. a {@link PropertySet}'s {@link Section} (throwing a {@link
  7175. NoSingleSectionException} if the {@link PropertySet} Contains more
  7176. (or less) than exactly one {@link Section}).
  7177. @author Rainer Klute
  7178. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  7179. @author Drew Varner (Drew.Varner hanginIn sc.edu)
  7180. @since 2002-02-09
  7181. </summary>
  7182. </member>
  7183. <member name="F:NPOI.HPSF.PropertySet.OS_WIN16">
  7184. If the OS version field holds this value the property Set stream Was
  7185. Created on a 16-bit Windows system.
  7186. </member>
  7187. <member name="F:NPOI.HPSF.PropertySet.OS_MACINTOSH">
  7188. If the OS version field holds this value the property Set stream Was
  7189. Created on a Macintosh system.
  7190. </member>
  7191. <member name="F:NPOI.HPSF.PropertySet.OS_WIN32">
  7192. If the OS version field holds this value the property Set stream Was
  7193. Created on a 32-bit Windows system.
  7194. </member>
  7195. <member name="F:NPOI.HPSF.PropertySet.BYTE_ORDER_ASSERTION">
  7196. The "byteOrder" field must equal this value.
  7197. </member>
  7198. <member name="F:NPOI.HPSF.PropertySet.byteOrder">
  7199. Specifies this {@link PropertySet}'s byte order. See the
  7200. HPFS documentation for details!
  7201. </member>
  7202. <member name="F:NPOI.HPSF.PropertySet.FORMAT_ASSERTION">
  7203. The "format" field must equal this value.
  7204. </member>
  7205. <member name="F:NPOI.HPSF.PropertySet.format">
  7206. Specifies this {@link PropertySet}'s format. See the HPFS
  7207. documentation for details!
  7208. </member>
  7209. <member name="F:NPOI.HPSF.PropertySet.osVersion">
  7210. Specifies the version of the operating system that Created
  7211. this {@link PropertySet}. See the HPFS documentation for
  7212. details!
  7213. </member>
  7214. <member name="F:NPOI.HPSF.PropertySet.classID">
  7215. Specifies this {@link PropertySet}'s "classID" field. See
  7216. the HPFS documentation for details!
  7217. </member>
  7218. <member name="F:NPOI.HPSF.PropertySet.sections">
  7219. The sections in this {@link PropertySet}.
  7220. </member>
  7221. <member name="M:NPOI.HPSF.PropertySet.#ctor">
  7222. <summary>
  7223. Creates an empty (uninitialized) {@link PropertySet}
  7224. Please note: For the time being this
  7225. constructor is protected since it is used for internal purposes
  7226. only, but expect it To become public once the property Set's
  7227. writing functionality is implemented.
  7228. </summary>
  7229. </member>
  7230. <member name="M:NPOI.HPSF.PropertySet.#ctor(System.IO.Stream)">
  7231. <summary>
  7232. Creates a {@link PropertySet} instance from an {@link
  7233. InputStream} in the Horrible Property Set Format.
  7234. The constructor Reads the first few bytes from the stream
  7235. and determines whether it is really a property Set stream. If
  7236. it Is, it parses the rest of the stream. If it is not, it
  7237. Resets the stream To its beginning in order To let other
  7238. components mess around with the data and throws an
  7239. exception.
  7240. </summary>
  7241. <param name="stream">Holds the data making out the property Set
  7242. stream.</param>
  7243. </member>
  7244. <member name="M:NPOI.HPSF.PropertySet.#ctor(System.Byte[],System.Int32,System.Int32)">
  7245. <summary>
  7246. Creates a {@link PropertySet} instance from a byte array
  7247. that represents a stream in the Horrible Property Set
  7248. Format.
  7249. </summary>
  7250. <param name="stream">The byte array holding the stream data.</param>
  7251. <param name="offset">The offset in stream where the stream data begin.
  7252. If the stream data begin with the first byte in the
  7253. array, the offset is 0.</param>
  7254. <param name="Length"> The Length of the stream data.</param>
  7255. </member>
  7256. <member name="M:NPOI.HPSF.PropertySet.#ctor(System.Byte[])">
  7257. <summary>
  7258. Creates a {@link PropertySet} instance from a byte array
  7259. that represents a stream in the Horrible Property Set
  7260. Format.
  7261. </summary>
  7262. <param name="stream">The byte array holding the stream data. The
  7263. complete byte array contents is the stream data.</param>
  7264. </member>
  7265. <member name="M:NPOI.HPSF.PropertySet.IsPropertySetStream(System.IO.Stream)">
  7266. <summary>
  7267. Checks whether an {@link InputStream} is in the Horrible
  7268. Property Set Format.
  7269. </summary>
  7270. <param name="stream">The {@link InputStream} To check. In order To
  7271. perform the check, the method Reads the first bytes from the
  7272. stream. After Reading, the stream is Reset To the position it
  7273. had before Reading. The {@link InputStream} must support the
  7274. {@link InputStream#mark} method.</param>
  7275. <returns>
  7276. <c>true</c> if the stream is a property Set
  7277. stream; otherwise, <c>false</c>.
  7278. </returns>
  7279. </member>
  7280. <member name="M:NPOI.HPSF.PropertySet.IsPropertySetStream(System.Byte[],System.Int32,System.Int32)">
  7281. <summary>
  7282. Checks whether a byte array is in the Horrible Property Set
  7283. Format.
  7284. </summary>
  7285. <param name="src">The byte array To check.</param>
  7286. <param name="offset">The offset in the byte array.</param>
  7287. <param name="Length">The significant number of bytes in the byte
  7288. array. Only this number of bytes will be checked.</param>
  7289. <returns>
  7290. <c>true</c> if the byte array is a property Set
  7291. stream; otherwise, <c>false</c>.
  7292. </returns>
  7293. </member>
  7294. <member name="M:NPOI.HPSF.PropertySet.init(System.Byte[],System.Int32,System.Int32)">
  7295. <summary>
  7296. Initializes this {@link PropertySet} instance from a byte
  7297. array. The method assumes that it has been checked alReady that
  7298. the byte array indeed represents a property Set stream. It does
  7299. no more checks on its own.
  7300. </summary>
  7301. <param name="src">Byte array containing the property Set stream</param>
  7302. <param name="offset">The property Set stream starts at this offset</param>
  7303. <param name="Length">Length of the property Set stream.</param>
  7304. </member>
  7305. <member name="M:NPOI.HPSF.PropertySet.GetProperty(System.Int32)">
  7306. <summary>
  7307. Convenience method returning the value of the property with
  7308. the specified ID. If the property is not available,
  7309. <c>null</c> is returned and a subsequent call To {@link
  7310. #WasNull} will return <c>true</c> .
  7311. </summary>
  7312. <param name="id">The property ID</param>
  7313. <returns>The property value</returns>
  7314. </member>
  7315. <member name="M:NPOI.HPSF.PropertySet.GetPropertyBooleanValue(System.Int32)">
  7316. <summary>
  7317. Convenience method returning the value of a bool property
  7318. with the specified ID. If the property is not available,
  7319. <c>false</c> is returned. A subsequent call To {@link
  7320. #WasNull} will return <c>true</c> To let the caller
  7321. distinguish that case from a real property value of
  7322. <c>false</c>.
  7323. </summary>
  7324. <param name="id">The property ID</param>
  7325. <returns>The property value</returns>
  7326. </member>
  7327. <member name="M:NPOI.HPSF.PropertySet.GetPropertyIntValue(System.Int32)">
  7328. <summary>
  7329. Convenience method returning the value of the numeric
  7330. property with the specified ID. If the property is not
  7331. available, 0 is returned. A subsequent call To {@link #WasNull}
  7332. will return <c>true</c> To let the caller distinguish
  7333. that case from a real property value of 0.
  7334. </summary>
  7335. <param name="id">The property ID</param>
  7336. <returns>The propertyIntValue value</returns>
  7337. </member>
  7338. <member name="M:NPOI.HPSF.PropertySet.Equals(System.Object)">
  7339. <summary>
  7340. Returns <c>true</c> if the <c>PropertySet</c> is equal
  7341. To the specified parameter, else <c>false</c>.
  7342. </summary>
  7343. <param name="o">the object To Compare this
  7344. <c>PropertySet</c>
  7345. with</param>
  7346. <returns><c>true</c>
  7347. if the objects are equal,
  7348. <c>false</c>
  7349. if not</returns>
  7350. </member>
  7351. <member name="M:NPOI.HPSF.PropertySet.GetHashCode">
  7352. <summary>
  7353. Serves as a hash function for a particular type.
  7354. </summary>
  7355. <returns>
  7356. A hash code for the current <see cref="T:System.Object"/>.
  7357. </returns>
  7358. </member>
  7359. <member name="M:NPOI.HPSF.PropertySet.ToString">
  7360. <summary>
  7361. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  7362. </summary>
  7363. <returns>
  7364. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  7365. </returns>
  7366. </member>
  7367. <member name="P:NPOI.HPSF.PropertySet.ByteOrder">
  7368. <summary>
  7369. Gets or sets the property Set stream's low-level "byte order"
  7370. field. It is always <c>0xFFFE</c>
  7371. </summary>
  7372. <value>The property Set stream's low-level "byte order" field..</value>
  7373. </member>
  7374. <member name="P:NPOI.HPSF.PropertySet.Format">
  7375. <summary>
  7376. Gets or sets the property Set stream's low-level "format"
  7377. field. It is always <c>0x0000</c>
  7378. </summary>
  7379. <value>The property Set stream's low-level "format" field.</value>
  7380. </member>
  7381. <member name="P:NPOI.HPSF.PropertySet.OSVersion">
  7382. <summary>
  7383. Returns the property Set stream's low-level "OS version"
  7384. field.
  7385. </summary>
  7386. <value>The property Set stream's low-level "OS version" field.</value>
  7387. </member>
  7388. <member name="P:NPOI.HPSF.PropertySet.ClassID">
  7389. <summary>
  7390. Gets or sets the property Set stream's low-level "class ID"
  7391. </summary>
  7392. <value>The property Set stream's low-level "class ID" field.</value>
  7393. </member>
  7394. <member name="P:NPOI.HPSF.PropertySet.SectionCount">
  7395. <summary>
  7396. Returns the number of {@link Section}s in the property
  7397. Set.
  7398. </summary>
  7399. <value>The number of {@link Section}s in the property Set.</value>
  7400. </member>
  7401. <member name="P:NPOI.HPSF.PropertySet.Sections">
  7402. <summary>
  7403. Returns the {@link Section}s in the property Set.
  7404. </summary>
  7405. <value>{@link Section}s in the property Set.</value>
  7406. </member>
  7407. <member name="P:NPOI.HPSF.PropertySet.IsSummaryInformation">
  7408. <summary>
  7409. Checks whether this {@link PropertySet} represents a Summary
  7410. Information.
  7411. </summary>
  7412. <value>
  7413. <c>true</c> Checks whether this {@link PropertySet} represents a Summary
  7414. Information; otherwise, <c>false</c>.
  7415. </value>
  7416. </member>
  7417. <member name="P:NPOI.HPSF.PropertySet.IsDocumentSummaryInformation">
  7418. <summary>
  7419. Gets a value indicating whether this instance is document summary information.
  7420. </summary>
  7421. <value>
  7422. <c>true</c> if this instance is document summary information; otherwise, <c>false</c>.
  7423. </value>
  7424. Checks whether this {@link PropertySet} is a Document
  7425. Summary Information.
  7426. @return
  7427. <c>true</c>
  7428. if this {@link PropertySet}
  7429. represents a Document Summary Information, else
  7430. <c>false</c>
  7431. </member>
  7432. <member name="P:NPOI.HPSF.PropertySet.Properties">
  7433. <summary>
  7434. Convenience method returning the {@link Property} array
  7435. contained in this property Set. It is a shortcut for Getting
  7436. the {@link PropertySet}'s {@link Section}s list and then
  7437. Getting the {@link Property} array from the first {@link
  7438. Section}.
  7439. </summary>
  7440. <value>The properties of the only {@link Section} of this
  7441. {@link PropertySet}.</value>
  7442. </member>
  7443. <member name="P:NPOI.HPSF.PropertySet.WasNull">
  7444. <summary>
  7445. Checks whether the property which the last call To {@link
  7446. #GetPropertyIntValue} or {@link #GetProperty} tried To access
  7447. Was available or not. This information might be important for
  7448. callers of {@link #GetPropertyIntValue} since the latter
  7449. returns 0 if the property does not exist. Using {@link
  7450. #WasNull}, the caller can distiguish this case from a
  7451. property's real value of 0.
  7452. </summary>
  7453. <value><c>true</c> if the last call To {@link
  7454. #GetPropertyIntValue} or {@link #GetProperty} tried To access a
  7455. property that Was not available; otherwise, <c>false</c>.</value>
  7456. </member>
  7457. <member name="P:NPOI.HPSF.PropertySet.FirstSection">
  7458. <summary>
  7459. Gets the first section.
  7460. </summary>
  7461. <value>The first section.</value>
  7462. </member>
  7463. <member name="P:NPOI.HPSF.PropertySet.SingleSection">
  7464. <summary>
  7465. If the {@link PropertySet} has only a single section this
  7466. method returns it.
  7467. </summary>
  7468. <value>The singleSection value</value>
  7469. </member>
  7470. <member name="M:NPOI.HPSF.MutablePropertySet.#ctor">
  7471. <summary>
  7472. Initializes a new instance of the <see cref="T:NPOI.HPSF.MutablePropertySet"/> class.
  7473. Its primary task is To initialize the immutable field with their proper
  7474. values. It also Sets fields that might Change To reasonable defaults.
  7475. </summary>
  7476. </member>
  7477. <member name="M:NPOI.HPSF.MutablePropertySet.#ctor(NPOI.HPSF.PropertySet)">
  7478. <summary>
  7479. Initializes a new instance of the <see cref="T:NPOI.HPSF.MutablePropertySet"/> class.
  7480. All nested elements, i.e.<c>Section</c>s and <c>Property</c> instances, will be their
  7481. mutable counterparts in the new <c>MutablePropertySet</c>.
  7482. </summary>
  7483. <param name="ps">The property Set To copy</param>
  7484. </member>
  7485. <member name="F:NPOI.HPSF.MutablePropertySet.OFFSET_HEADER">
  7486. The Length of the property Set stream header.
  7487. </member>
  7488. <member name="M:NPOI.HPSF.MutablePropertySet.ClearSections">
  7489. <summary>
  7490. Removes all sections from this property Set.
  7491. </summary>
  7492. </member>
  7493. <member name="M:NPOI.HPSF.MutablePropertySet.AddSection(NPOI.HPSF.Section)">
  7494. <summary>
  7495. Adds a section To this property Set.
  7496. </summary>
  7497. <param name="section">section The {@link Section} To Add. It will be Appended
  7498. after any sections that are alReady present in the property Set
  7499. and thus become the last section.</param>
  7500. </member>
  7501. <member name="M:NPOI.HPSF.MutablePropertySet.Write(System.IO.Stream)">
  7502. <summary>
  7503. Writes the property Set To an output stream.
  7504. </summary>
  7505. <param name="out1">the output stream To Write the section To</param>
  7506. </member>
  7507. <member name="M:NPOI.HPSF.MutablePropertySet.ToInputStream">
  7508. <summary>
  7509. Returns the contents of this property set stream as an input stream.
  7510. The latter can be used for example to write the property set into a POIFS
  7511. document. The input stream represents a snapshot of the property set.
  7512. If the latter is modified while the input stream is still being
  7513. read, the modifications will not be reflected in the input stream but in
  7514. the {@link MutablePropertySet} only.
  7515. </summary>
  7516. <returns>the contents of this property set stream</returns>
  7517. </member>
  7518. <member name="M:NPOI.HPSF.MutablePropertySet.Write(NPOI.POIFS.FileSystem.DirectoryEntry,System.String)">
  7519. <summary>
  7520. Writes a property Set To a document in a POI filesystem directory
  7521. </summary>
  7522. <param name="dir">The directory in the POI filesystem To Write the document To.</param>
  7523. <param name="name">The document's name. If there is alReady a document with the
  7524. same name in the directory the latter will be overwritten.</param>
  7525. </member>
  7526. <member name="P:NPOI.HPSF.MutablePropertySet.ByteOrder">
  7527. <summary>
  7528. Gets or sets the "byteOrder" property.
  7529. </summary>
  7530. <value>the byteOrder value To Set</value>
  7531. </member>
  7532. <member name="P:NPOI.HPSF.MutablePropertySet.Format">
  7533. <summary>
  7534. Gets or sets the "format" property.
  7535. </summary>
  7536. <value>the format value To Set</value>
  7537. </member>
  7538. <member name="P:NPOI.HPSF.MutablePropertySet.OSVersion">
  7539. <summary>
  7540. Gets or sets the "osVersion" property
  7541. </summary>
  7542. <value>the osVersion value To Set.</value>
  7543. </member>
  7544. <member name="P:NPOI.HPSF.MutablePropertySet.ClassID">
  7545. <summary>
  7546. Gets or sets the property Set stream's low-level "class ID"
  7547. </summary>
  7548. <value>The property Set stream's low-level "class ID" field.</value>
  7549. </member>
  7550. <member name="F:NPOI.HPSF.SpecialPropertySet.delegate1">
  7551. The "real" property Set <c>SpecialPropertySet</c>
  7552. delegates To.
  7553. </member>
  7554. <member name="M:NPOI.HPSF.SpecialPropertySet.#ctor(NPOI.HPSF.PropertySet)">
  7555. <summary>
  7556. Initializes a new instance of the <see cref="T:NPOI.HPSF.SpecialPropertySet"/> class.
  7557. </summary>
  7558. <param name="ps">The property Set To be encapsulated by the <c>SpecialPropertySet</c></param>
  7559. </member>
  7560. <member name="M:NPOI.HPSF.SpecialPropertySet.#ctor(NPOI.HPSF.MutablePropertySet)">
  7561. <summary>
  7562. Initializes a new instance of the <see cref="T:NPOI.HPSF.SpecialPropertySet"/> class.
  7563. </summary>
  7564. <param name="ps">The mutable property Set To be encapsulated by the <c>SpecialPropertySet</c></param>
  7565. </member>
  7566. <member name="M:NPOI.HPSF.SpecialPropertySet.AddSection(NPOI.HPSF.Section)">
  7567. <summary>
  7568. Adds a section To this property set.
  7569. </summary>
  7570. <param name="section">The {@link Section} To Add. It will be Appended
  7571. after any sections that are alReady present in the property Set
  7572. and thus become the last section.</param>
  7573. </member>
  7574. <member name="M:NPOI.HPSF.SpecialPropertySet.ClearSections">
  7575. <summary>
  7576. Removes all sections from this property Set.
  7577. </summary>
  7578. </member>
  7579. <member name="M:NPOI.HPSF.SpecialPropertySet.Write(NPOI.POIFS.FileSystem.DirectoryEntry,System.String)">
  7580. <summary>
  7581. Writes a property Set To a document in a POI filesystem directory.
  7582. </summary>
  7583. <param name="dir">The directory in the POI filesystem To Write the document To</param>
  7584. <param name="name">The document's name. If there is alReady a document with the
  7585. same name in the directory the latter will be overwritten.</param>
  7586. </member>
  7587. <member name="M:NPOI.HPSF.SpecialPropertySet.Write(System.IO.Stream)">
  7588. <summary>
  7589. Writes the property Set To an output stream.
  7590. </summary>
  7591. <param name="out1">the output stream To Write the section To</param>
  7592. </member>
  7593. <member name="M:NPOI.HPSF.SpecialPropertySet.Equals(System.Object)">
  7594. <summary>
  7595. Returns <c>true</c> if the <c>PropertySet</c> is equal
  7596. To the specified parameter, else <c>false</c>.
  7597. </summary>
  7598. <param name="o">the object To Compare this
  7599. <c>PropertySet</c>
  7600. with</param>
  7601. <returns>
  7602. <c>true</c>
  7603. if the objects are equal,
  7604. <c>false</c>
  7605. if not
  7606. </returns>
  7607. </member>
  7608. <member name="M:NPOI.HPSF.SpecialPropertySet.GetProperty(System.Int32)">
  7609. <summary>
  7610. Convenience method returning the value of the property with
  7611. the specified ID. If the property is not available,
  7612. <c>null</c> is returned and a subsequent call To {@link
  7613. #WasNull} will return <c>true</c> .
  7614. </summary>
  7615. <param name="id">The property ID</param>
  7616. <returns>The property value</returns>
  7617. </member>
  7618. <member name="M:NPOI.HPSF.SpecialPropertySet.GetPropertyBooleanValue(System.Int32)">
  7619. <summary>
  7620. Convenience method returning the value of a bool property
  7621. with the specified ID. If the property is not available,
  7622. <c>false</c> is returned. A subsequent call To {@link
  7623. #WasNull} will return <c>true</c> To let the caller
  7624. distinguish that case from a real property value of
  7625. <c>false</c>.
  7626. </summary>
  7627. <param name="id">The property ID</param>
  7628. <returns>The property value</returns>
  7629. </member>
  7630. <member name="M:NPOI.HPSF.SpecialPropertySet.GetPropertyIntValue(System.Int32)">
  7631. <summary>
  7632. Convenience method returning the value of the numeric
  7633. property with the specified ID. If the property is not
  7634. available, 0 is returned. A subsequent call To {@link #WasNull}
  7635. will return <c>true</c> To let the caller distinguish
  7636. that case from a real property value of 0.
  7637. </summary>
  7638. <param name="id">The property ID</param>
  7639. <returns>The propertyIntValue value</returns>
  7640. </member>
  7641. <member name="M:NPOI.HPSF.SpecialPropertySet.GetPropertyStringValue(System.Int32)">
  7642. Fetches the property with the given ID, then does its
  7643. best to return it as a String
  7644. @return The property as a String, or null if unavailable
  7645. </member>
  7646. <member name="M:NPOI.HPSF.SpecialPropertySet.GetHashCode">
  7647. <summary>
  7648. Serves as a hash function for a particular type.
  7649. </summary>
  7650. <returns>
  7651. A hash code for the current <see cref="T:System.Object"/>.
  7652. </returns>
  7653. </member>
  7654. <member name="M:NPOI.HPSF.SpecialPropertySet.ToString">
  7655. <summary>
  7656. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  7657. </summary>
  7658. <returns>
  7659. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  7660. </returns>
  7661. </member>
  7662. <member name="P:NPOI.HPSF.SpecialPropertySet.PropertySetIDMap">
  7663. The id to name mapping of the properties
  7664. in this set.
  7665. </member>
  7666. <member name="P:NPOI.HPSF.SpecialPropertySet.ByteOrder">
  7667. <summary>
  7668. gets or sets the "byteOrder" property.
  7669. </summary>
  7670. <value>the byteOrder value To Set</value>
  7671. </member>
  7672. <member name="P:NPOI.HPSF.SpecialPropertySet.Format">
  7673. <summary>
  7674. gets or sets the "format" property
  7675. </summary>
  7676. <value>the format value To Set</value>
  7677. </member>
  7678. <member name="P:NPOI.HPSF.SpecialPropertySet.ClassID">
  7679. <summary>
  7680. gets or sets the property Set stream's low-level "class ID"
  7681. field.
  7682. </summary>
  7683. <value>The property Set stream's low-level "class ID" field</value>
  7684. </member>
  7685. <member name="P:NPOI.HPSF.SpecialPropertySet.SectionCount">
  7686. <summary>
  7687. Returns the number of {@link Section}s in the property
  7688. Set.
  7689. </summary>
  7690. <value>The number of {@link Section}s in the property Set.</value>
  7691. </member>
  7692. <member name="P:NPOI.HPSF.SpecialPropertySet.IsSummaryInformation">
  7693. <summary>
  7694. Checks whether this {@link PropertySet} represents a Summary
  7695. Information.
  7696. </summary>
  7697. <value>
  7698. <c>true</c> Checks whether this {@link PropertySet} represents a Summary
  7699. Information; otherwise, <c>false</c>.
  7700. </value>
  7701. </member>
  7702. <member name="P:NPOI.HPSF.SpecialPropertySet.IsDocumentSummaryInformation">
  7703. <summary>
  7704. Gets a value indicating whether this instance is document summary information.
  7705. </summary>
  7706. <value>
  7707. <c>true</c> if this instance is document summary information; otherwise, <c>false</c>.
  7708. </value>
  7709. Checks whether this {@link PropertySet} is a Document
  7710. Summary Information.
  7711. @return
  7712. <c>true</c>
  7713. if this {@link PropertySet}
  7714. represents a Document Summary Information, else
  7715. <c>false</c>
  7716. </member>
  7717. <member name="P:NPOI.HPSF.SpecialPropertySet.FirstSection">
  7718. <summary>
  7719. Gets the PropertySet's first section.
  7720. </summary>
  7721. <value>The {@link PropertySet}'s first section.</value>
  7722. </member>
  7723. <member name="P:NPOI.HPSF.SpecialPropertySet.OSVersion">
  7724. <summary>
  7725. gets or sets the "osVersion" property
  7726. </summary>
  7727. <value> the osVersion value To Set</value>
  7728. </member>
  7729. <member name="P:NPOI.HPSF.SpecialPropertySet.Properties">
  7730. <summary>
  7731. Convenience method returning the {@link Property} array
  7732. contained in this property Set. It is a shortcut for Getting
  7733. the {@link PropertySet}'s {@link Section}s list and then
  7734. Getting the {@link Property} array from the first {@link
  7735. Section}.
  7736. </summary>
  7737. <value>
  7738. The properties of the only {@link Section} of this
  7739. {@link PropertySet}.
  7740. </value>
  7741. </member>
  7742. <member name="P:NPOI.HPSF.SpecialPropertySet.WasNull">
  7743. <summary>
  7744. Checks whether the property which the last call To {@link
  7745. #GetPropertyIntValue} or {@link #GetProperty} tried To access
  7746. Was available or not. This information might be important for
  7747. callers of {@link #GetPropertyIntValue} since the latter
  7748. returns 0 if the property does not exist. Using {@link
  7749. #WasNull}, the caller can distiguish this case from a
  7750. property's real value of 0.
  7751. </summary>
  7752. <value>
  7753. <c>true</c> if the last call To {@link
  7754. #GetPropertyIntValue} or {@link #GetProperty} tried To access a
  7755. property that Was not available; otherwise, <c>false</c>.
  7756. </value>
  7757. </member>
  7758. <member name="F:NPOI.HPSF.DocumentSummaryInformation.DEFAULT_STREAM_NAME">
  7759. The document name a document summary information stream
  7760. usually has in a POIFS filesystem.
  7761. </member>
  7762. <member name="M:NPOI.HPSF.DocumentSummaryInformation.#ctor(NPOI.HPSF.PropertySet)">
  7763. <summary>
  7764. Initializes a new instance of the <see cref="T:NPOI.HPSF.DocumentSummaryInformation"/> class.
  7765. </summary>
  7766. <param name="ps">A property Set which should be Created from a
  7767. document summary information stream.</param>
  7768. </member>
  7769. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveCategory">
  7770. <summary>
  7771. Removes the category.
  7772. </summary>
  7773. </member>
  7774. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemovePresentationFormat">
  7775. <summary>
  7776. Removes the presentation format.
  7777. </summary>
  7778. </member>
  7779. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveByteCount">
  7780. <summary>
  7781. Removes the byte count.
  7782. </summary>
  7783. </member>
  7784. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveLineCount">
  7785. <summary>
  7786. Removes the line count.
  7787. </summary>
  7788. </member>
  7789. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveParCount">
  7790. <summary>
  7791. Removes the par count.
  7792. </summary>
  7793. </member>
  7794. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveSlideCount">
  7795. <summary>
  7796. Removes the slide count.
  7797. </summary>
  7798. </member>
  7799. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveNoteCount">
  7800. <summary>
  7801. Removes the note count.
  7802. </summary>
  7803. </member>
  7804. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveHiddenCount">
  7805. <summary>
  7806. Removes the hidden count.
  7807. </summary>
  7808. </member>
  7809. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveMMClipCount">
  7810. <summary>
  7811. Removes the MMClip count.
  7812. </summary>
  7813. </member>
  7814. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveScale">
  7815. <summary>
  7816. Removes the scale.
  7817. </summary>
  7818. </member>
  7819. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveHeadingPair">
  7820. <summary>
  7821. Removes the heading pair.
  7822. </summary>
  7823. </member>
  7824. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveDocparts">
  7825. <summary>
  7826. Removes the doc parts.
  7827. </summary>
  7828. </member>
  7829. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveManager">
  7830. <summary>
  7831. Removes the manager.
  7832. </summary>
  7833. </member>
  7834. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveCompany">
  7835. <summary>
  7836. Removes the company.
  7837. </summary>
  7838. </member>
  7839. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveLinksDirty">
  7840. <summary>
  7841. Removes the links dirty.
  7842. </summary>
  7843. </member>
  7844. <member name="M:NPOI.HPSF.DocumentSummaryInformation.EnsureSection2">
  7845. <summary>
  7846. Creates section 2 if it is not alReady present.
  7847. </summary>
  7848. </member>
  7849. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveCustomProperties">
  7850. <summary>
  7851. Removes the custom properties.
  7852. </summary>
  7853. </member>
  7854. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Category">
  7855. <summary>
  7856. Gets or sets the category.
  7857. </summary>
  7858. <value>The category value</value>
  7859. </member>
  7860. <member name="P:NPOI.HPSF.DocumentSummaryInformation.PresentationFormat">
  7861. <summary>
  7862. Gets or sets the presentation format (or null).
  7863. </summary>
  7864. <value>The presentation format value</value>
  7865. </member>
  7866. <member name="P:NPOI.HPSF.DocumentSummaryInformation.ByteCount">
  7867. <summary>
  7868. Gets or sets the byte count or 0 if the {@link
  7869. DocumentSummaryInformation} does not contain a byte count.
  7870. </summary>
  7871. <value>The byteCount value</value>
  7872. </member>
  7873. <member name="P:NPOI.HPSF.DocumentSummaryInformation.LineCount">
  7874. <summary>
  7875. Gets or sets the line count or 0 if the {@link
  7876. DocumentSummaryInformation} does not contain a line count.
  7877. </summary>
  7878. <value>The line count value.</value>
  7879. </member>
  7880. <member name="P:NPOI.HPSF.DocumentSummaryInformation.ParCount">
  7881. <summary>
  7882. Gets or sets the par count or 0 if the {@link
  7883. DocumentSummaryInformation} does not contain a par count.
  7884. </summary>
  7885. <value>The par count value</value>
  7886. </member>
  7887. <member name="P:NPOI.HPSF.DocumentSummaryInformation.SlideCount">
  7888. <summary>
  7889. Gets or sets the slide count or 0 if the {@link
  7890. DocumentSummaryInformation} does not contain a slide count.
  7891. </summary>
  7892. <value>The slide count value</value>
  7893. </member>
  7894. <member name="P:NPOI.HPSF.DocumentSummaryInformation.NoteCount">
  7895. <summary>
  7896. Gets or sets the note count or 0 if the {@link
  7897. DocumentSummaryInformation} does not contain a note count
  7898. </summary>
  7899. <value>The note count value</value>
  7900. </member>
  7901. <member name="P:NPOI.HPSF.DocumentSummaryInformation.HiddenCount">
  7902. <summary>
  7903. Gets or sets the hidden count or 0 if the {@link
  7904. DocumentSummaryInformation} does not contain a hidden
  7905. count.
  7906. </summary>
  7907. <value>The hidden count value.</value>
  7908. </member>
  7909. <member name="P:NPOI.HPSF.DocumentSummaryInformation.MMClipCount">
  7910. <summary>
  7911. Returns the mmclip count or 0 if the {@link
  7912. DocumentSummaryInformation} does not contain a mmclip
  7913. count.
  7914. </summary>
  7915. <value>The mmclip count value.</value>
  7916. </member>
  7917. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Scale">
  7918. <summary>
  7919. Gets or sets a value indicating whether this <see cref="T:NPOI.HPSF.DocumentSummaryInformation"/> is scale.
  7920. </summary>
  7921. <value><c>true</c> if cropping is desired; otherwise, <c>false</c>.</value>
  7922. </member>
  7923. <member name="P:NPOI.HPSF.DocumentSummaryInformation.HeadingPair">
  7924. <summary>
  7925. Gets or sets the heading pair (or null)
  7926. </summary>
  7927. <value>The heading pair value.</value>
  7928. </member>
  7929. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Docparts">
  7930. <summary>
  7931. Gets or sets the doc parts.
  7932. </summary>
  7933. <value>The doc parts value</value>
  7934. </member>
  7935. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Manager">
  7936. <summary>
  7937. Gets or sets the manager (or <c>null</c>).
  7938. </summary>
  7939. <value>The manager value</value>
  7940. </member>
  7941. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Company">
  7942. <summary>
  7943. Gets or sets the company (or <c>null</c>).
  7944. </summary>
  7945. <value>The company value</value>
  7946. </member>
  7947. <member name="P:NPOI.HPSF.DocumentSummaryInformation.LinksDirty">
  7948. <summary>
  7949. Gets or sets a value indicating whether [links dirty].
  7950. </summary>
  7951. <value><c>true</c> if the custom links are dirty.; otherwise, <c>false</c>.</value>
  7952. </member>
  7953. <member name="P:NPOI.HPSF.DocumentSummaryInformation.CustomProperties">
  7954. <summary>
  7955. Gets or sets the custom properties.
  7956. </summary>
  7957. <value>The custom properties.</value>
  7958. </member>
  7959. <member name="T:NPOI.HPSF.Extractor.HPSFPropertiesExtractor">
  7960. <summary>
  7961. Extracts all of the HPSF properties, both
  7962. build in and custom, returning them in
  7963. textual form.
  7964. </summary>
  7965. </member>
  7966. <member name="T:NPOI.POITextExtractor">
  7967. <summary>
  7968. Common Parent for Text Extractors
  7969. of POI Documents.
  7970. You will typically find the implementation of
  7971. a given format's text extractor under
  7972. org.apache.poi.[format].extractor .
  7973. </summary>
  7974. @see org.apache.poi.hssf.extractor.ExcelExtractor
  7975. @see org.apache.poi.hslf.extractor.PowerPointExtractor
  7976. @see org.apache.poi.hdgf.extractor.VisioTextExtractor
  7977. @see org.apache.poi.hwpf.extractor.WordExtractor
  7978. </member>
  7979. <member name="F:NPOI.POITextExtractor.document">
  7980. The POIDocument that's open
  7981. </member>
  7982. <member name="M:NPOI.POITextExtractor.#ctor(NPOI.POIDocument)">
  7983. <summary>
  7984. Creates a new text extractor for the given document
  7985. </summary>
  7986. <param name="document">The document.</param>
  7987. </member>
  7988. <member name="M:NPOI.POITextExtractor.#ctor(NPOI.POITextExtractor)">
  7989. <summary>
  7990. Creates a new text extractor, using the same
  7991. document as another text extractor. Normally
  7992. only used by properties extractors.
  7993. </summary>
  7994. <param name="otherExtractor">The other extractor.</param>
  7995. </member>
  7996. <member name="P:NPOI.POITextExtractor.Text">
  7997. <summary>
  7998. Retrieves all the text from the document.
  7999. How cells, paragraphs etc are separated in the text
  8000. is implementation specific - see the javadocs for
  8001. a specific project for details.
  8002. </summary>
  8003. <value>All the text from the document.</value>
  8004. </member>
  8005. <member name="P:NPOI.POITextExtractor.MetadataTextExtractor">
  8006. <summary>
  8007. Returns another text extractor, which is able to
  8008. output the textual content of the document
  8009. metadata / properties, such as author and title.
  8010. </summary>
  8011. <value>The metadata text extractor.</value>
  8012. </member>
  8013. <member name="M:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.GetPropertiesText(NPOI.HPSF.SpecialPropertySet)">
  8014. <summary>
  8015. Gets the properties text.
  8016. </summary>
  8017. <param name="ps">The ps.</param>
  8018. <returns></returns>
  8019. </member>
  8020. <member name="P:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.DocumentSummaryInformationText">
  8021. <summary>
  8022. Gets the document summary information text.
  8023. </summary>
  8024. <value>The document summary information text.</value>
  8025. </member>
  8026. <member name="P:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.SummaryInformationText">
  8027. <summary>
  8028. Gets the summary information text.
  8029. </summary>
  8030. <value>The summary information text.</value>
  8031. </member>
  8032. <member name="P:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.Text">
  8033. <summary>
  8034. Return the text of all the properties defined in
  8035. the document.
  8036. </summary>
  8037. <value>All the text from the document.</value>
  8038. </member>
  8039. <member name="P:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.MetadataTextExtractor">
  8040. <summary>
  8041. Returns another text extractor, which is able to
  8042. output the textual content of the document
  8043. metadata / properties, such as author and title.
  8044. </summary>
  8045. <value>The metadata text extractor.</value>
  8046. </member>
  8047. <member name="T:NPOI.HPSF.HPSFException">
  8048. <summary>
  8049. This exception is the superclass of all other checked exceptions thrown
  8050. in this package. It supports a nested "reason" throwable, i.e. an exception
  8051. that caused this one To be thrown.
  8052. @author Rainer Klute
  8053. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  8054. @since 2002-02-09
  8055. </summary>
  8056. </member>
  8057. <member name="M:NPOI.HPSF.HPSFException.#ctor">
  8058. <summary>
  8059. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFException"/> class.
  8060. </summary>
  8061. </member>
  8062. <member name="M:NPOI.HPSF.HPSFException.#ctor(System.String)">
  8063. <summary>
  8064. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFException"/> class.
  8065. </summary>
  8066. <param name="msg">The message string.</param>
  8067. </member>
  8068. <member name="M:NPOI.HPSF.HPSFException.#ctor(System.Exception)">
  8069. <summary>
  8070. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFException"/> class.
  8071. </summary>
  8072. <param name="reason">The reason, i.e. a throwable that indirectly
  8073. caused this exception.</param>
  8074. </member>
  8075. <member name="M:NPOI.HPSF.HPSFException.#ctor(System.String,System.Exception)">
  8076. <summary>
  8077. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFException"/> class.
  8078. </summary>
  8079. <param name="msg">The message string.</param>
  8080. <param name="reason">The reason, i.e. a throwable that indirectly
  8081. caused this exception.</param>
  8082. </member>
  8083. <member name="P:NPOI.HPSF.HPSFException.Reason">
  8084. <summary>
  8085. Returns the {@link Exception} that caused this exception To
  8086. be thrown or null if there was no such {@link
  8087. Exception}.
  8088. </summary>
  8089. <value>The reason.</value>
  8090. </member>
  8091. <member name="T:NPOI.HPSF.HPSFRuntimeException">
  8092. <summary>
  8093. This exception is the superclass of all other unchecked
  8094. exceptions thrown in this package. It supports a nested "reason"
  8095. throwable, i.e. an exception that caused this one To be thrown.
  8096. @author Rainer Klute
  8097. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  8098. @since 2002-02-09
  8099. </summary>
  8100. </member>
  8101. <member name="M:NPOI.HPSF.HPSFRuntimeException.#ctor">
  8102. <summary>
  8103. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFRuntimeException"/> class.
  8104. </summary>
  8105. </member>
  8106. <member name="M:NPOI.HPSF.HPSFRuntimeException.#ctor(System.String)">
  8107. <summary>
  8108. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFRuntimeException"/> class.
  8109. </summary>
  8110. <param name="msg">The message string.</param>
  8111. </member>
  8112. <member name="M:NPOI.HPSF.HPSFRuntimeException.#ctor(System.Exception)">
  8113. <summary>
  8114. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFRuntimeException"/> class.
  8115. </summary>
  8116. <param name="reason">The reason, i.e. a throwable that indirectly
  8117. caused this exception.</param>
  8118. </member>
  8119. <member name="M:NPOI.HPSF.HPSFRuntimeException.#ctor(System.String,System.Exception)">
  8120. <summary>
  8121. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFRuntimeException"/> class.
  8122. </summary>
  8123. <param name="msg">The message string.</param>
  8124. <param name="reason">The reason, i.e. a throwable that indirectly
  8125. caused this exception.</param>
  8126. </member>
  8127. <member name="T:NPOI.HPSF.IllegalPropertySetDataException">
  8128. <summary>
  8129. This exception is thrown when there is an illegal value Set in a
  8130. {@link PropertySet}. For example, a {@link Variant#VT_BOOL} must
  8131. have a value of <c>-1 (true)</c> or <c>0 (false)</c>.
  8132. Any other value would trigger this exception. It supports a nested
  8133. "reason" throwable, i.e. an exception that caused this one To be
  8134. thrown.
  8135. @author Drew Varner(Drew.Varner atDomain sc.edu)
  8136. @since 2002-05-26
  8137. </summary>
  8138. </member>
  8139. <member name="M:NPOI.HPSF.IllegalPropertySetDataException.#ctor">
  8140. <summary>
  8141. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalPropertySetDataException"/> class.
  8142. </summary>
  8143. </member>
  8144. <member name="M:NPOI.HPSF.IllegalPropertySetDataException.#ctor(System.String)">
  8145. <summary>
  8146. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalPropertySetDataException"/> class.
  8147. </summary>
  8148. <param name="msg">The exception's message string</param>
  8149. </member>
  8150. <member name="M:NPOI.HPSF.IllegalPropertySetDataException.#ctor(System.Exception)">
  8151. <summary>
  8152. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalPropertySetDataException"/> class.
  8153. </summary>
  8154. <param name="reason">This exception's underlying reason</param>
  8155. </member>
  8156. <member name="M:NPOI.HPSF.IllegalPropertySetDataException.#ctor(System.String,System.Exception)">
  8157. <summary>
  8158. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalPropertySetDataException"/> class.
  8159. </summary>
  8160. <param name="msg"> The exception's message string</param>
  8161. <param name="reason">This exception's underlying reason</param>
  8162. </member>
  8163. <member name="T:NPOI.HPSF.IllegalVariantTypeException">
  8164. <summary>
  8165. This exception is thrown if HPSF encounters a variant type that is illegal
  8166. in the current context.
  8167. @author Rainer Klute
  8168. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  8169. @since 2004-06-21
  8170. </summary>
  8171. </member>
  8172. <member name="T:NPOI.HPSF.VariantTypeException">
  8173. <summary>
  8174. This exception is thrown if HPSF encounters a problem with a variant type.
  8175. Concrete subclasses specifiy the problem further.
  8176. @author Rainer Klute
  8177. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  8178. @since 2004-06-21
  8179. </summary>
  8180. </member>
  8181. <member name="M:NPOI.HPSF.VariantTypeException.#ctor(System.Int64,System.Object,System.String)">
  8182. <summary>
  8183. Initializes a new instance of the <see cref="T:NPOI.HPSF.VariantTypeException"/> class.
  8184. </summary>
  8185. <param name="variantType">The variant type causing the problem</param>
  8186. <param name="value">The value who's variant type causes the problem</param>
  8187. <param name="msg">A message text describing the problem</param>
  8188. </member>
  8189. <member name="P:NPOI.HPSF.VariantTypeException.VariantType">
  8190. <summary>
  8191. Gets the offending variant type
  8192. </summary>
  8193. <value>the offending variant type.</value>
  8194. </member>
  8195. <member name="P:NPOI.HPSF.VariantTypeException.Value">
  8196. <summary>
  8197. Returns the value who's variant type caused the problem.
  8198. </summary>
  8199. <value>the value who's variant type caused the problem.</value>
  8200. </member>
  8201. <member name="M:NPOI.HPSF.IllegalVariantTypeException.#ctor(System.Int64,System.Object,System.String)">
  8202. <summary>
  8203. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalVariantTypeException"/> class.
  8204. </summary>
  8205. <param name="variantType">The unsupported variant type</param>
  8206. <param name="value">The value</param>
  8207. <param name="msg">A message string</param>
  8208. </member>
  8209. <member name="M:NPOI.HPSF.IllegalVariantTypeException.#ctor(System.Int64,System.Object)">
  8210. <summary>
  8211. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalVariantTypeException"/> class.
  8212. </summary>
  8213. <param name="variantType">The unsupported variant type</param>
  8214. <param name="value">The value.</param>
  8215. </member>
  8216. <member name="T:NPOI.HPSF.MarkUnsupportedException">
  8217. <summary>
  8218. This exception is thrown if an {@link java.io.InputStream} does
  8219. not support the {@link java.io.InputStream#mark} operation.
  8220. @author Rainer Klute
  8221. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  8222. @since 2002-02-09
  8223. </summary>
  8224. </member>
  8225. <member name="M:NPOI.HPSF.MarkUnsupportedException.#ctor">
  8226. <summary>
  8227. Initializes a new instance of the <see cref="T:NPOI.HPSF.MarkUnsupportedException"/> class.
  8228. </summary>
  8229. </member>
  8230. <member name="M:NPOI.HPSF.MarkUnsupportedException.#ctor(System.String)">
  8231. <summary>
  8232. Initializes a new instance of the <see cref="T:NPOI.HPSF.MarkUnsupportedException"/> class.
  8233. </summary>
  8234. <param name="msg">The exception's message string.</param>
  8235. </member>
  8236. <member name="M:NPOI.HPSF.MarkUnsupportedException.#ctor(System.Exception)">
  8237. <summary>
  8238. Initializes a new instance of the <see cref="T:NPOI.HPSF.MarkUnsupportedException"/> class.
  8239. </summary>
  8240. <param name="reason">This exception's underlying reason.</param>
  8241. </member>
  8242. <member name="M:NPOI.HPSF.MarkUnsupportedException.#ctor(System.String,System.Exception)">
  8243. <summary>
  8244. Initializes a new instance of the <see cref="T:NPOI.HPSF.MarkUnsupportedException"/> class.
  8245. </summary>
  8246. <param name="msg">The exception's message string</param>
  8247. <param name="reason">This exception's underlying reason</param>
  8248. </member>
  8249. <member name="T:NPOI.HPSF.MissingSectionException">
  8250. <summary>
  8251. This exception is thrown if one of the {@link PropertySet}'s
  8252. convenience methods does not Find a required {@link Section}.
  8253. The constructors of this class are analogous To those of its
  8254. superclass and documented there.
  8255. @author Rainer Klute
  8256. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  8257. @since 2006-02-08
  8258. </summary>
  8259. </member>
  8260. <member name="M:NPOI.HPSF.MissingSectionException.#ctor">
  8261. <summary>
  8262. Initializes a new instance of the <see cref="T:NPOI.HPSF.MissingSectionException"/> class.
  8263. </summary>
  8264. </member>
  8265. <member name="M:NPOI.HPSF.MissingSectionException.#ctor(System.String)">
  8266. <summary>
  8267. Initializes a new instance of the <see cref="T:NPOI.HPSF.MissingSectionException"/> class.
  8268. </summary>
  8269. <param name="msg">The exception's message string</param>
  8270. </member>
  8271. <member name="M:NPOI.HPSF.MissingSectionException.#ctor(System.Exception)">
  8272. <summary>
  8273. Initializes a new instance of the <see cref="T:NPOI.HPSF.MissingSectionException"/> class.
  8274. </summary>
  8275. <param name="reason">This exception's underlying reason.</param>
  8276. </member>
  8277. <member name="M:NPOI.HPSF.MissingSectionException.#ctor(System.String,System.Exception)">
  8278. <summary>
  8279. Initializes a new instance of the <see cref="T:NPOI.HPSF.MissingSectionException"/> class.
  8280. </summary>
  8281. <param name="msg">The exception's message string</param>
  8282. <param name="reason">This exception's underlying reason</param>
  8283. </member>
  8284. <member name="T:NPOI.HPSF.MutableSection">
  8285. <summary>
  8286. Adds writing capability To the {@link Section} class.
  8287. Please be aware that this class' functionality will be merged into the
  8288. {@link Section} class at a later time, so the API will Change.
  8289. @since 2002-02-20
  8290. </summary>
  8291. </member>
  8292. <member name="T:NPOI.HPSF.Section">
  8293. <summary>
  8294. Represents a section in a {@link PropertySet}.
  8295. @author Rainer Klute
  8296. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  8297. @author Drew Varner (Drew.Varner allUpIn sc.edu)
  8298. @since 2002-02-09
  8299. </summary>
  8300. </member>
  8301. <member name="F:NPOI.HPSF.Section.dictionary">
  8302. Maps property IDs To section-private PID strings. These
  8303. strings can be found in the property with ID 0.
  8304. </member>
  8305. <member name="F:NPOI.HPSF.Section.formatID">
  8306. The section's format ID, {@link #GetFormatID}.
  8307. </member>
  8308. <member name="M:NPOI.HPSF.Section.#ctor">
  8309. <summary>
  8310. Creates an empty and uninitialized {@link Section}.
  8311. </summary>
  8312. </member>
  8313. <member name="M:NPOI.HPSF.Section.#ctor(System.Byte[],System.Int32)">
  8314. <summary>
  8315. Creates a {@link Section} instance from a byte array.
  8316. </summary>
  8317. <param name="src">Contains the complete property Set stream.</param>
  8318. <param name="offset">The position in the stream that points To the
  8319. section's format ID.</param>
  8320. </member>
  8321. <member name="M:NPOI.HPSF.Section.GetProperty(System.Int64)">
  8322. Returns the value of the property with the specified ID. If
  8323. the property is not available, <c>null</c> is returned
  8324. and a subsequent call To {@link #wasNull} will return
  8325. <c>true</c>.
  8326. @param id The property's ID
  8327. @return The property's value
  8328. </member>
  8329. <member name="M:NPOI.HPSF.Section.GetPropertyIntValue(System.Int64)">
  8330. Returns the value of the numeric property with the specified
  8331. ID. If the property is not available, 0 is returned. A
  8332. subsequent call To {@link #wasNull} will return
  8333. <c>true</c> To let the caller distinguish that case from
  8334. a real property value of 0.
  8335. @param id The property's ID
  8336. @return The property's value
  8337. </member>
  8338. <member name="M:NPOI.HPSF.Section.GetPropertyBooleanValue(System.Int32)">
  8339. Returns the value of the bool property with the specified
  8340. ID. If the property is not available, <c>false</c> Is
  8341. returned. A subsequent call To {@link #wasNull} will return
  8342. <c>true</c> To let the caller distinguish that case from
  8343. a real property value of <c>false</c>.
  8344. @param id The property's ID
  8345. @return The property's value
  8346. </member>
  8347. <member name="F:NPOI.HPSF.Section.wasNull">
  8348. This member is <c>true</c> if the last call To {@link
  8349. #GetPropertyIntValue} or {@link #GetProperty} tried To access a
  8350. property that was not available, else <c>false</c>.
  8351. </member>
  8352. <member name="M:NPOI.HPSF.Section.GetPIDString(System.Int64)">
  8353. <summary>
  8354. Returns the PID string associated with a property ID. The ID
  8355. is first looked up in the {@link Section}'s private
  8356. dictionary. If it is not found there, the method calls {@link
  8357. SectionIDMap#GetPIDString}.
  8358. </summary>
  8359. <param name="pid">The property ID.</param>
  8360. <returns>The property ID's string value</returns>
  8361. </member>
  8362. <member name="M:NPOI.HPSF.Section.Equals(System.Object)">
  8363. Checks whether this section is equal To another object. The result Is
  8364. <c>false</c> if one of the the following conditions holds:
  8365. <ul>
  8366. <li>The other object is not a {@link Section}.</li>
  8367. <li>The format IDs of the two sections are not equal.</li>
  8368. <li>The sections have a different number of properties. However,
  8369. properties with ID 1 (codepage) are not counted.</li>
  8370. <li>The other object is not a {@link Section}.</li>
  8371. <li>The properties have different values. The order of the properties
  8372. is irrelevant.</li>
  8373. </ul>
  8374. @param o The object To Compare this section with
  8375. @return <c>true</c> if the objects are equal, <c>false</c> if
  8376. not
  8377. </member>
  8378. <member name="M:NPOI.HPSF.Section.Remove(NPOI.HPSF.Property[],System.Int32)">
  8379. <summary>
  8380. Removes a field from a property array. The resulting array Is
  8381. compactified and returned.
  8382. </summary>
  8383. <param name="pa">The property array.</param>
  8384. <param name="i">The index of the field To be Removed.</param>
  8385. <returns>the compactified array.</returns>
  8386. </member>
  8387. <member name="M:NPOI.HPSF.Section.GetHashCode">
  8388. <summary>
  8389. Serves as a hash function for a particular type.
  8390. </summary>
  8391. <returns>
  8392. A hash code for the current <see cref="T:System.Object"/>.
  8393. </returns>
  8394. </member>
  8395. <member name="M:NPOI.HPSF.Section.ToString">
  8396. <summary>
  8397. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  8398. </summary>
  8399. <returns>
  8400. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  8401. </returns>
  8402. </member>
  8403. <member name="P:NPOI.HPSF.Section.FormatID">
  8404. <summary>
  8405. Returns the format ID. The format ID is the "type" of the
  8406. section. For example, if the format ID of the first {@link
  8407. Section} Contains the bytes specified by
  8408. <c>org.apache.poi.hpsf.wellknown.SectionIDMap.SUMMARY_INFORMATION_ID</c>
  8409. the section (and thus the property Set) is a SummaryInformation.
  8410. </summary>
  8411. <value>The format ID.</value>
  8412. </member>
  8413. <member name="P:NPOI.HPSF.Section.OffSet">
  8414. <summary>
  8415. Gets the offset of the section in the stream.
  8416. </summary>
  8417. <value>The offset of the section in the stream</value>
  8418. </member>
  8419. <member name="P:NPOI.HPSF.Section.Size">
  8420. <summary>
  8421. Returns the section's size in bytes.
  8422. </summary>
  8423. <value>The section's size in bytes.</value>
  8424. </member>
  8425. <member name="P:NPOI.HPSF.Section.PropertyCount">
  8426. <summary>
  8427. Returns the number of properties in this section.
  8428. </summary>
  8429. <value>The number of properties in this section.</value>
  8430. </member>
  8431. <member name="P:NPOI.HPSF.Section.Properties">
  8432. <summary>
  8433. Returns this section's properties.
  8434. </summary>
  8435. <value>This section's properties.</value>
  8436. </member>
  8437. <member name="P:NPOI.HPSF.Section.WasNull">
  8438. <summary>
  8439. Checks whether the property which the last call To {@link
  8440. #GetPropertyIntValue} or {@link #GetProperty} tried To access
  8441. was available or not. This information might be important for
  8442. callers of {@link #GetPropertyIntValue} since the latter
  8443. returns 0 if the property does not exist. Using {@link
  8444. #wasNull} the caller can distiguish this case from a property's
  8445. real value of 0.
  8446. </summary>
  8447. <value><c>true</c> if the last call To {@link
  8448. #GetPropertyIntValue} or {@link #GetProperty} tried To access a
  8449. property that was not available; otherwise, <c>false</c>.</value>
  8450. </member>
  8451. <member name="P:NPOI.HPSF.Section.Dictionary">
  8452. <summary>
  8453. Gets the section's dictionary. A dictionary allows an application To
  8454. use human-Readable property names instead of numeric property IDs. It
  8455. Contains mappings from property IDs To their associated string
  8456. values. The dictionary is stored as the property with ID 0. The codepage
  8457. for the strings in the dictionary is defined by property with ID 1.
  8458. </summary>
  8459. <value>the dictionary or null
  8460. if the section does not have
  8461. a dictionary.</value>
  8462. </member>
  8463. <member name="P:NPOI.HPSF.Section.Codepage">
  8464. <summary>
  8465. Gets the section's codepage, if any.
  8466. </summary>
  8467. <value>The section's codepage if one is defined, else -1.</value>
  8468. </member>
  8469. <member name="T:NPOI.HPSF.Section.PropertyListEntry">
  8470. Represents an entry in the property list and holds a property's ID and
  8471. its offset from the section's beginning.
  8472. </member>
  8473. <member name="M:NPOI.HPSF.Section.PropertyListEntry.CompareTo(System.Object)">
  8474. Compares this {@link PropertyListEntry} with another one by their
  8475. offsets. A {@link PropertyListEntry} is "smaller" than another one if
  8476. its offset from the section's begin is smaller.
  8477. @see Comparable#CompareTo(java.lang.Object)
  8478. </member>
  8479. <member name="F:NPOI.HPSF.MutableSection.dirty">
  8480. If the "dirty" flag is true, the section's size must be
  8481. (re-)calculated before the section is written.
  8482. </member>
  8483. <member name="F:NPOI.HPSF.MutableSection.preprops">
  8484. List To assemble the properties. Unfortunately a wrong
  8485. decision has been taken when specifying the "properties" field
  8486. as an Property[]. It should have been a {@link java.util.List}.
  8487. </member>
  8488. <member name="F:NPOI.HPSF.MutableSection.sectionBytes">
  8489. Contains the bytes making out the section. This byte array is
  8490. established when the section's size is calculated and can be reused
  8491. later. It is valid only if the "dirty" flag is false.
  8492. </member>
  8493. <member name="M:NPOI.HPSF.MutableSection.#ctor">
  8494. <summary>
  8495. Initializes a new instance of the <see cref="T:NPOI.HPSF.MutableSection"/> class.
  8496. </summary>
  8497. </member>
  8498. <member name="M:NPOI.HPSF.MutableSection.#ctor(NPOI.HPSF.Section)">
  8499. <summary>
  8500. Constructs a <c>MutableSection</c> by doing a deep copy of an
  8501. existing <c>Section</c>. All nested <c>Property</c>
  8502. instances, will be their mutable counterparts in the new
  8503. <c>MutableSection</c>.
  8504. </summary>
  8505. <param name="s">The section Set To copy</param>
  8506. </member>
  8507. <member name="M:NPOI.HPSF.MutableSection.SetFormatID(NPOI.Util.ClassID)">
  8508. <summary>
  8509. Sets the section's format ID.
  8510. </summary>
  8511. <param name="formatID">The section's format ID</param>
  8512. </member>
  8513. <member name="M:NPOI.HPSF.MutableSection.SetFormatID(System.Byte[])">
  8514. <summary>
  8515. Sets the section's format ID.
  8516. </summary>
  8517. <param name="formatID">The section's format ID as a byte array. It components
  8518. are in big-endian format.</param>
  8519. </member>
  8520. <member name="M:NPOI.HPSF.MutableSection.SetProperties(NPOI.HPSF.Property[])">
  8521. <summary>
  8522. Sets this section's properties. Any former values are overwritten.
  8523. </summary>
  8524. <param name="properties">This section's new properties.</param>
  8525. </member>
  8526. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.String)">
  8527. <summary>
  8528. Sets the string value of the property with the specified ID.
  8529. </summary>
  8530. <param name="id">The property's ID</param>
  8531. <param name="value">The property's value. It will be written as a Unicode
  8532. string.</param>
  8533. </member>
  8534. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Int32)">
  8535. <summary>
  8536. Sets the int value of the property with the specified ID.
  8537. </summary>
  8538. <param name="id">The property's ID</param>
  8539. <param name="value">The property's value.</param>
  8540. </member>
  8541. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Int64)">
  8542. <summary>
  8543. Sets the long value of the property with the specified ID.
  8544. </summary>
  8545. <param name="id">The property's ID</param>
  8546. <param name="value">The property's value.</param>
  8547. </member>
  8548. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Boolean)">
  8549. <summary>
  8550. Sets the bool value of the property with the specified ID.
  8551. </summary>
  8552. <param name="id">The property's ID</param>
  8553. <param name="value">The property's value.</param>
  8554. </member>
  8555. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Int64,System.Object)">
  8556. <summary>
  8557. Sets the value and the variant type of the property with the
  8558. specified ID. If a property with this ID is not yet present in
  8559. the section, it will be Added. An alReady present property with
  8560. the specified ID will be overwritten. A default mapping will be
  8561. used To choose the property's type.
  8562. </summary>
  8563. <param name="id">The property's ID.</param>
  8564. <param name="variantType">The property's variant type.</param>
  8565. <param name="value">The property's value.</param>
  8566. </member>
  8567. <member name="M:NPOI.HPSF.MutableSection.SetProperty(NPOI.HPSF.Property)">
  8568. <summary>
  8569. Sets the property.
  8570. </summary>
  8571. <param name="p">The property To be Set.</param>
  8572. </member>
  8573. <member name="M:NPOI.HPSF.MutableSection.RemoveProperty(System.Int64)">
  8574. <summary>
  8575. Removes the property.
  8576. </summary>
  8577. <param name="id">The ID of the property To be Removed</param>
  8578. </member>
  8579. <member name="M:NPOI.HPSF.MutableSection.SetPropertyBooleanValue(System.Int32,System.Boolean)">
  8580. <summary>
  8581. Sets the value of the bool property with the specified
  8582. ID.
  8583. </summary>
  8584. <param name="id">The property's ID</param>
  8585. <param name="value">The property's value</param>
  8586. </member>
  8587. <member name="M:NPOI.HPSF.MutableSection.CalcSize">
  8588. <summary>
  8589. Calculates the section's size. It is the sum of the Lengths of the
  8590. section's header (8), the properties list (16 times the number of
  8591. properties) and the properties themselves.
  8592. </summary>
  8593. <returns>the section's Length in bytes.</returns>
  8594. </member>
  8595. <member name="M:NPOI.HPSF.MutableSection.Write(System.IO.Stream)">
  8596. <summary>
  8597. Writes this section into an output stream.
  8598. Internally this is done by writing into three byte array output
  8599. streams: one for the properties, one for the property list and one for
  8600. the section as such. The two former are Appended To the latter when they
  8601. have received all their data.
  8602. </summary>
  8603. <param name="out1">The stream To Write into.</param>
  8604. <returns>The number of bytes written, i.e. the section's size.</returns>
  8605. </member>
  8606. <member name="M:NPOI.HPSF.MutableSection.WriteDictionary(System.IO.Stream,System.Collections.IDictionary,System.Int32)">
  8607. <summary>
  8608. Writes the section's dictionary
  8609. </summary>
  8610. <param name="out1">The output stream To Write To.</param>
  8611. <param name="dictionary">The dictionary.</param>
  8612. <param name="codepage">The codepage to be used to Write the dictionary items.</param>
  8613. <returns>The number of bytes written</returns>
  8614. <remarks>
  8615. see MSDN KB: http://msdn.microsoft.com/en-us/library/aa380065(VS.85).aspx
  8616. </remarks>
  8617. </member>
  8618. <member name="M:NPOI.HPSF.MutableSection.EnsureProperties">
  8619. <summary>
  8620. Ensures the properties.
  8621. </summary>
  8622. </member>
  8623. <member name="M:NPOI.HPSF.MutableSection.GetProperty(System.Int64)">
  8624. <summary>
  8625. Gets a property.
  8626. </summary>
  8627. <param name="id">The ID of the property To Get</param>
  8628. <returns>The property or null if there is no such property</returns>
  8629. </member>
  8630. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Object)">
  8631. <summary>
  8632. Sets the property.
  8633. </summary>
  8634. <param name="id">The property ID.</param>
  8635. <param name="value">The property's value. The value's class must be one of those
  8636. supported by HPSF.</param>
  8637. </member>
  8638. <member name="M:NPOI.HPSF.MutableSection.Clear">
  8639. <summary>
  8640. Removes all properties from the section including 0 (dictionary) and
  8641. 1 (codepage).
  8642. </summary>
  8643. </member>
  8644. <member name="P:NPOI.HPSF.MutableSection.Size">
  8645. <summary>
  8646. Returns the section's size in bytes.
  8647. </summary>
  8648. <value>The section's size in bytes.</value>
  8649. </member>
  8650. <member name="P:NPOI.HPSF.MutableSection.PropertyCount">
  8651. <summary>
  8652. OverWrites the base class' method To cope with a redundancy:
  8653. the property count is maintained in a separate member variable, but
  8654. shouldn't.
  8655. </summary>
  8656. <value>The number of properties in this section.</value>
  8657. </member>
  8658. <member name="P:NPOI.HPSF.MutableSection.Properties">
  8659. <summary>
  8660. Returns this section's properties.
  8661. </summary>
  8662. <value>This section's properties.</value>
  8663. </member>
  8664. <member name="P:NPOI.HPSF.MutableSection.Dictionary">
  8665. <summary>
  8666. Sets the section's dictionary. All keys in the dictionary must be
  8667. {@link java.lang.long} instances, all values must be
  8668. {@link java.lang.String}s. This method overWrites the properties with IDs
  8669. 0 and 1 since they are reserved for the dictionary and the dictionary's
  8670. codepage. Setting these properties explicitly might have surprising
  8671. effects. An application should never do this but always use this
  8672. method.
  8673. </summary>
  8674. <value>
  8675. the dictionary
  8676. </value>
  8677. </member>
  8678. <member name="P:NPOI.HPSF.MutableSection.Codepage">
  8679. <summary>
  8680. Gets the section's codepage, if any.
  8681. </summary>
  8682. <value>The section's codepage if one is defined, else -1.</value>
  8683. </member>
  8684. <member name="T:NPOI.HPSF.NoFormatIDException">
  8685. <summary>
  8686. This exception is thrown if a {@link MutablePropertySet} is To be written
  8687. but does not have a formatID Set (see {@link
  8688. MutableSection#SetFormatID(ClassID)} or
  8689. {@link org.apache.poi.hpsf.MutableSection#SetFormatID(byte[])}.
  8690. @author Rainer Klute
  8691. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  8692. @since 2002-09-03
  8693. </summary>
  8694. </member>
  8695. <member name="M:NPOI.HPSF.NoFormatIDException.#ctor">
  8696. <summary>
  8697. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoFormatIDException"/> class.
  8698. </summary>
  8699. </member>
  8700. <member name="M:NPOI.HPSF.NoFormatIDException.#ctor(System.String)">
  8701. <summary>
  8702. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoFormatIDException"/> class.
  8703. </summary>
  8704. <param name="msg">The exception's message string</param>
  8705. </member>
  8706. <member name="M:NPOI.HPSF.NoFormatIDException.#ctor(System.Exception)">
  8707. <summary>
  8708. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoFormatIDException"/> class.
  8709. </summary>
  8710. <param name="reason">This exception's underlying reason</param>
  8711. </member>
  8712. <member name="M:NPOI.HPSF.NoFormatIDException.#ctor(System.String,System.Exception)">
  8713. <summary>
  8714. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoFormatIDException"/> class.
  8715. </summary>
  8716. <param name="msg">The exception's message string</param>
  8717. <param name="reason">This exception's underlying reason</param>
  8718. </member>
  8719. <member name="T:NPOI.HPSF.NoPropertySetStreamException">
  8720. <summary>
  8721. This exception is thrown if a format error in a property Set stream Is
  8722. detected or when the input data do not constitute a property Set stream.
  8723. The constructors of this class are analogous To those of its superclass
  8724. and are documented there.
  8725. @author Rainer Klute
  8726. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  8727. @since 2002-02-09
  8728. </summary>
  8729. </member>
  8730. <member name="M:NPOI.HPSF.NoPropertySetStreamException.#ctor">
  8731. <summary>
  8732. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoPropertySetStreamException"/> class.
  8733. </summary>
  8734. </member>
  8735. <member name="M:NPOI.HPSF.NoPropertySetStreamException.#ctor(System.String)">
  8736. <summary>
  8737. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoPropertySetStreamException"/> class.
  8738. </summary>
  8739. <param name="msg">The exception's message string</param>
  8740. </member>
  8741. <member name="M:NPOI.HPSF.NoPropertySetStreamException.#ctor(System.Exception)">
  8742. <summary>
  8743. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoPropertySetStreamException"/> class.
  8744. </summary>
  8745. <param name="reason">This exception's underlying reason</param>
  8746. </member>
  8747. <member name="M:NPOI.HPSF.NoPropertySetStreamException.#ctor(System.String,System.Exception)">
  8748. <summary>
  8749. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoPropertySetStreamException"/> class.
  8750. </summary>
  8751. <param name="msg">The exception's message string</param>
  8752. <param name="reason">This exception's underlying reason</param>
  8753. </member>
  8754. <member name="T:NPOI.HPSF.NoSingleSectionException">
  8755. <summary>
  8756. This exception is thrown if one of the {@link PropertySet}'s
  8757. convenience methods that require a single {@link Section} is called
  8758. and the {@link PropertySet} does not contain exactly one {@link
  8759. Section}.
  8760. The constructors of this class are analogous To those of its
  8761. superclass and documented there.
  8762. @author Rainer Klute
  8763. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  8764. @since 2002-02-09
  8765. </summary>
  8766. </member>
  8767. <member name="M:NPOI.HPSF.NoSingleSectionException.#ctor">
  8768. <summary>
  8769. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoSingleSectionException"/> class.
  8770. </summary>
  8771. </member>
  8772. <member name="M:NPOI.HPSF.NoSingleSectionException.#ctor(System.String)">
  8773. <summary>
  8774. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoSingleSectionException"/> class.
  8775. </summary>
  8776. <param name="msg">The exception's message string</param>
  8777. </member>
  8778. <member name="M:NPOI.HPSF.NoSingleSectionException.#ctor(System.Exception)">
  8779. <summary>
  8780. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoSingleSectionException"/> class.
  8781. </summary>
  8782. <param name="reason">This exception's underlying reason</param>
  8783. </member>
  8784. <member name="M:NPOI.HPSF.NoSingleSectionException.#ctor(System.String,System.Exception)">
  8785. <summary>
  8786. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoSingleSectionException"/> class.
  8787. </summary>
  8788. <param name="msg">The exception's message string</param>
  8789. <param name="reason">This exception's underlying reason</param>
  8790. </member>
  8791. <member name="T:NPOI.HPSF.PropertySetFactory">
  8792. <summary>
  8793. Factory class To Create instances of {@link SummaryInformation},
  8794. {@link DocumentSummaryInformation} and {@link PropertySet}.
  8795. @author Rainer Klute
  8796. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  8797. @since 2002-02-09
  8798. </summary>
  8799. </member>
  8800. <member name="M:NPOI.HPSF.PropertySetFactory.Create(NPOI.POIFS.FileSystem.DirectoryEntry,System.String)">
  8801. <p>Creates the most specific {@link PropertySet} from an entry
  8802. in the specified POIFS Directory. This is preferrably a {@link
  8803. DocumentSummaryInformation} or a {@link SummaryInformation}. If
  8804. the specified entry does not contain a property Set stream, an
  8805. exception is thrown. If no entry is found with the given name,
  8806. an exception is thrown.</p>
  8807. @param dir The directory to find the PropertySet in
  8808. @param name The name of the entry Containing the PropertySet
  8809. @return The Created {@link PropertySet}.
  8810. @if there is no entry with that name
  8811. @if the stream does not
  8812. contain a property Set.
  8813. @if some I/O problem occurs.
  8814. @exception EncoderFallbackException if the specified codepage is not
  8815. supported.
  8816. </member>
  8817. <member name="M:NPOI.HPSF.PropertySetFactory.Create(System.IO.Stream)">
  8818. <summary>
  8819. Creates the most specific {@link PropertySet} from an {@link
  8820. InputStream}. This is preferrably a {@link
  8821. DocumentSummaryInformation} or a {@link SummaryInformation}. If
  8822. the specified {@link InputStream} does not contain a property
  8823. Set stream, an exception is thrown and the {@link InputStream}
  8824. is repositioned at its beginning.
  8825. </summary>
  8826. <param name="stream">Contains the property set stream's data.</param>
  8827. <returns>The Created {@link PropertySet}.</returns>
  8828. </member>
  8829. <member name="M:NPOI.HPSF.PropertySetFactory.CreateSummaryInformation">
  8830. <summary>
  8831. Creates a new summary information
  8832. </summary>
  8833. <returns>the new summary information.</returns>
  8834. </member>
  8835. <member name="M:NPOI.HPSF.PropertySetFactory.CreateDocumentSummaryInformation">
  8836. <summary>
  8837. Creates a new document summary information.
  8838. </summary>
  8839. <returns>the new document summary information.</returns>
  8840. </member>
  8841. <member name="T:NPOI.HPSF.ReadingNotSupportedException">
  8842. <summary>
  8843. This exception is thrown when HPSF tries To Read a (yet) unsupported
  8844. variant type.
  8845. @see WritingNotSupportedException
  8846. @see UnsupportedVariantTypeException
  8847. @author Rainer Klute
  8848. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  8849. @since 2003-08-08
  8850. </summary>
  8851. </member>
  8852. <member name="T:NPOI.HPSF.UnsupportedVariantTypeException">
  8853. <summary>
  8854. This exception is thrown if HPSF encounters a variant type that isn't
  8855. supported yet. Although a variant type is unsupported the value can still be
  8856. retrieved using the {@link VariantTypeException#GetValue} method.
  8857. Obviously this class should disappear some day.
  8858. @author Rainer Klute
  8859. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  8860. @since 2003-08-05
  8861. </summary>
  8862. </member>
  8863. <member name="M:NPOI.HPSF.UnsupportedVariantTypeException.#ctor(System.Int64,System.Object)">
  8864. <summary>
  8865. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnsupportedVariantTypeException"/> class.
  8866. </summary>
  8867. <param name="variantType">The unsupported variant type</param>
  8868. <param name="value">The value who's variant type is not yet supported</param>
  8869. </member>
  8870. <member name="M:NPOI.HPSF.ReadingNotSupportedException.#ctor(System.Int64,System.Object)">
  8871. <summary>
  8872. Initializes a new instance of the <see cref="T:NPOI.HPSF.ReadingNotSupportedException"/> class.
  8873. </summary>
  8874. <param name="variantType">The unsupported variant type</param>
  8875. <param name="value">The value who's variant type is not yet supported</param>
  8876. </member>
  8877. <member name="T:NPOI.HPSF.SummaryInformation">
  8878. <summary>
  8879. Convenience class representing a Summary Information stream in a
  8880. Microsoft Office document.
  8881. @author Rainer Klute
  8882. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  8883. @see DocumentSummaryInformation
  8884. @since 2002-02-09
  8885. </summary>
  8886. </member>
  8887. <member name="F:NPOI.HPSF.SummaryInformation.DEFAULT_STREAM_NAME">
  8888. The document name a summary information stream usually has in a POIFS
  8889. filesystem.
  8890. </member>
  8891. <member name="M:NPOI.HPSF.SummaryInformation.#ctor(NPOI.HPSF.PropertySet)">
  8892. <summary>
  8893. Initializes a new instance of the <see cref="T:NPOI.HPSF.SummaryInformation"/> class.
  8894. </summary>
  8895. <param name="ps">A property Set which should be Created from a summary
  8896. information stream.</param>
  8897. </member>
  8898. <member name="M:NPOI.HPSF.SummaryInformation.RemoveTitle">
  8899. <summary>
  8900. Removes the title.
  8901. </summary>
  8902. </member>
  8903. <member name="M:NPOI.HPSF.SummaryInformation.RemoveSubject">
  8904. <summary>
  8905. Removes the subject.
  8906. </summary>
  8907. </member>
  8908. <member name="M:NPOI.HPSF.SummaryInformation.RemoveAuthor">
  8909. <summary>
  8910. Removes the author.
  8911. </summary>
  8912. </member>
  8913. <member name="M:NPOI.HPSF.SummaryInformation.RemoveKeywords">
  8914. <summary>
  8915. Removes the keywords.
  8916. </summary>
  8917. </member>
  8918. <member name="M:NPOI.HPSF.SummaryInformation.RemoveComments">
  8919. <summary>
  8920. Removes the comments.
  8921. </summary>
  8922. </member>
  8923. <member name="M:NPOI.HPSF.SummaryInformation.RemoveTemplate">
  8924. <summary>
  8925. Removes the template.
  8926. </summary>
  8927. </member>
  8928. <member name="M:NPOI.HPSF.SummaryInformation.RemoveLastAuthor">
  8929. <summary>
  8930. Removes the last author.
  8931. </summary>
  8932. </member>
  8933. <member name="M:NPOI.HPSF.SummaryInformation.RemoveRevNumber">
  8934. <summary>
  8935. Removes the rev number.
  8936. </summary>
  8937. </member>
  8938. <member name="M:NPOI.HPSF.SummaryInformation.RemoveEditTime">
  8939. <summary>
  8940. Removes the edit time.
  8941. </summary>
  8942. </member>
  8943. <member name="M:NPOI.HPSF.SummaryInformation.RemoveLastPrinted">
  8944. <summary>
  8945. Removes the last printed.
  8946. </summary>
  8947. </member>
  8948. <member name="M:NPOI.HPSF.SummaryInformation.RemoveCreateDateTime">
  8949. <summary>
  8950. Removes the create date time.
  8951. </summary>
  8952. </member>
  8953. <member name="M:NPOI.HPSF.SummaryInformation.RemoveLastSaveDateTime">
  8954. <summary>
  8955. Removes the last save date time.
  8956. </summary>
  8957. </member>
  8958. <member name="M:NPOI.HPSF.SummaryInformation.RemovePageCount">
  8959. <summary>
  8960. Removes the page count.
  8961. </summary>
  8962. </member>
  8963. <member name="M:NPOI.HPSF.SummaryInformation.RemoveWordCount">
  8964. <summary>
  8965. Removes the word count.
  8966. </summary>
  8967. </member>
  8968. <member name="M:NPOI.HPSF.SummaryInformation.RemoveCharCount">
  8969. <summary>
  8970. Removes the char count.
  8971. </summary>
  8972. </member>
  8973. <member name="M:NPOI.HPSF.SummaryInformation.RemoveThumbnail">
  8974. <summary>
  8975. Removes the thumbnail.
  8976. </summary>
  8977. </member>
  8978. <member name="M:NPOI.HPSF.SummaryInformation.RemoveApplicationName">
  8979. <summary>
  8980. Removes the name of the application.
  8981. </summary>
  8982. </member>
  8983. <member name="M:NPOI.HPSF.SummaryInformation.RemoveSecurity">
  8984. <summary>
  8985. Removes the security code.
  8986. </summary>
  8987. </member>
  8988. <member name="P:NPOI.HPSF.SummaryInformation.Title">
  8989. <summary>
  8990. Gets or sets the title.
  8991. </summary>
  8992. <value>The title.</value>
  8993. </member>
  8994. <member name="P:NPOI.HPSF.SummaryInformation.Subject">
  8995. <summary>
  8996. Gets or sets the subject.
  8997. </summary>
  8998. <value>The subject.</value>
  8999. </member>
  9000. <member name="P:NPOI.HPSF.SummaryInformation.Author">
  9001. <summary>
  9002. Gets or sets the author.
  9003. </summary>
  9004. <value>The author.</value>
  9005. </member>
  9006. <member name="P:NPOI.HPSF.SummaryInformation.Keywords">
  9007. <summary>
  9008. Gets or sets the keywords.
  9009. </summary>
  9010. <value>The keywords.</value>
  9011. </member>
  9012. <member name="P:NPOI.HPSF.SummaryInformation.Comments">
  9013. <summary>
  9014. Gets or sets the comments.
  9015. </summary>
  9016. <value>The comments.</value>
  9017. </member>
  9018. <member name="P:NPOI.HPSF.SummaryInformation.Template">
  9019. <summary>
  9020. Gets or sets the template.
  9021. </summary>
  9022. <value>The template.</value>
  9023. </member>
  9024. <member name="P:NPOI.HPSF.SummaryInformation.LastAuthor">
  9025. <summary>
  9026. Gets or sets the last author.
  9027. </summary>
  9028. <value>The last author.</value>
  9029. </member>
  9030. <member name="P:NPOI.HPSF.SummaryInformation.RevNumber">
  9031. <summary>
  9032. Gets or sets the rev number.
  9033. </summary>
  9034. <value>The rev number.</value>
  9035. </member>
  9036. <member name="P:NPOI.HPSF.SummaryInformation.EditTime">
  9037. <summary>
  9038. Returns the Total time spent in editing the document (or 0).
  9039. </summary>
  9040. <value>The Total time spent in editing the document or 0 if the {@link
  9041. SummaryInformation} does not contain this information.</value>
  9042. </member>
  9043. <member name="P:NPOI.HPSF.SummaryInformation.LastPrinted">
  9044. <summary>
  9045. Gets or sets the last printed time
  9046. </summary>
  9047. <value>The last printed time</value>
  9048. Returns the last printed time (or <c>null</c>).
  9049. </member>
  9050. <member name="P:NPOI.HPSF.SummaryInformation.CreateDateTime">
  9051. <summary>
  9052. Gets or sets the create date time.
  9053. </summary>
  9054. <value>The create date time.</value>
  9055. </member>
  9056. <member name="P:NPOI.HPSF.SummaryInformation.LastSaveDateTime">
  9057. <summary>
  9058. Gets or sets the last save date time.
  9059. </summary>
  9060. <value>The last save date time.</value>
  9061. </member>
  9062. <member name="P:NPOI.HPSF.SummaryInformation.PageCount">
  9063. <summary>
  9064. Gets or sets the page count or 0 if the {@link SummaryInformation} does
  9065. not contain a page count.
  9066. </summary>
  9067. <value>The page count or 0 if the {@link SummaryInformation} does not
  9068. contain a page count.</value>
  9069. </member>
  9070. <member name="P:NPOI.HPSF.SummaryInformation.WordCount">
  9071. <summary>
  9072. Gets or sets the word count or 0 if the {@link SummaryInformation} does
  9073. not contain a word count.
  9074. </summary>
  9075. <value>The word count.</value>
  9076. </member>
  9077. <member name="P:NPOI.HPSF.SummaryInformation.CharCount">
  9078. <summary>
  9079. Gets or sets the character count or 0 if the {@link SummaryInformation}
  9080. does not contain a char count.
  9081. </summary>
  9082. <value>The character count.</value>
  9083. </member>
  9084. <member name="P:NPOI.HPSF.SummaryInformation.Thumbnail">
  9085. <summary>
  9086. Gets or sets the thumbnail (or <c>null</c>) <strong>when this
  9087. method is implemented. Please note that the return type is likely To
  9088. Change!</strong>
  9089. <strong>Hint To developers:</strong> Drew Varner &lt;Drew.Varner
  9090. -at- sc.edu&gt; said that this is an image in WMF or Clipboard (BMP?)
  9091. format. However, we won't do any conversion into any image type but
  9092. instead just return a byte array.
  9093. </summary>
  9094. <value>The thumbnail.</value>
  9095. </member>
  9096. <member name="P:NPOI.HPSF.SummaryInformation.ApplicationName">
  9097. <summary>
  9098. Gets or sets the name of the application.
  9099. </summary>
  9100. <value>The name of the application.</value>
  9101. </member>
  9102. <member name="P:NPOI.HPSF.SummaryInformation.Security">
  9103. <summary>
  9104. Gets or sets a security code which is one of the following values:
  9105. <ul>
  9106. <li>0 if the {@link SummaryInformation} does not contain a
  9107. security field or if there is no security on the document. Use
  9108. {@link PropertySet#wasNull()} To distinguish between the two
  9109. cases!</li>
  9110. <li>1 if the document is password protected</li>
  9111. <li>2 if the document is Read-only recommended</li>
  9112. <li>4 if the document is Read-only enforced</li>
  9113. <li>8 if the document is locked for annotations</li>
  9114. </ul>
  9115. </summary>
  9116. <value>The security code</value>
  9117. </member>
  9118. <member name="T:NPOI.HPSF.Thumbnail">
  9119. <summary>
  9120. Class To manipulate data in the Clipboard Variant (Variant#VT_CF VT_CF) format.
  9121. @author Drew Varner (Drew.Varner inOrAround sc.edu)
  9122. @since 2002-04-29
  9123. </summary>
  9124. </member>
  9125. <member name="F:NPOI.HPSF.Thumbnail.OFFSet_CFTAG">
  9126. <summary>
  9127. OffSet in bytes where the Clipboard Format Tag starts in the <c>byte[]</c> returned by SummaryInformation#GetThumbnail()
  9128. </summary>
  9129. </member>
  9130. <member name="F:NPOI.HPSF.Thumbnail.OFFSet_CF">
  9131. <summary>
  9132. OffSet in bytes where the Clipboard Format starts in the <c>byte[]</c> returned by SummaryInformation#GetThumbnail()
  9133. </summary>
  9134. <remarks>This is only valid if the Clipboard Format Tag is CFTAG_WINDOWS</remarks>
  9135. </member>
  9136. <member name="F:NPOI.HPSF.Thumbnail.OFFSet_WMFDATA">
  9137. <summary>
  9138. OffSet in bytes where the Windows Metafile (WMF) image data starts in the <c>byte[]</c> returned by SummaryInformation#GetThumbnail()
  9139. There is only WMF data at this point in the
  9140. <c>byte[]</c> if the Clipboard Format Tag is
  9141. CFTAG_WINDOWS and the Clipboard Format is
  9142. CF_METAFILEPICT.
  9143. </summary>
  9144. <remarks>Note: The <c>byte[]</c> that starts at
  9145. <c>OFFSet_WMFDATA</c> and ends at
  9146. <c>GetThumbnail().Length - 1</c> forms a complete WMF
  9147. image. It can be saved To disk with a <c>.wmf</c> file
  9148. type and Read using a WMF-capable image viewer.</remarks>
  9149. </member>
  9150. <member name="F:NPOI.HPSF.Thumbnail.CFTAG_WINDOWS">
  9151. <summary>
  9152. Clipboard Format Tag - Windows clipboard format
  9153. </summary>
  9154. <remarks>A <c>DWORD</c> indicating a built-in Windows clipboard format value</remarks>
  9155. </member>
  9156. <member name="F:NPOI.HPSF.Thumbnail.CFTAG_MACINTOSH">
  9157. <summary>
  9158. Clipboard Format Tag - Macintosh clipboard format
  9159. </summary>
  9160. <remarks>A <c>DWORD</c> indicating a Macintosh clipboard format value</remarks>
  9161. </member>
  9162. <member name="F:NPOI.HPSF.Thumbnail.CFTAG_FMTID">
  9163. <summary>
  9164. Clipboard Format Tag - Format ID
  9165. </summary>
  9166. <remarks>A GUID containing a format identifier (FMTID). This is rarely used.</remarks>
  9167. </member>
  9168. <member name="F:NPOI.HPSF.Thumbnail.CFTAG_NODATA">
  9169. <summary>
  9170. Clipboard Format Tag - No Data
  9171. </summary>
  9172. <remarks>A <c>DWORD</c> indicating No data. This is rarely used.</remarks>
  9173. </member>
  9174. <member name="F:NPOI.HPSF.Thumbnail.CF_METAFILEPICT">
  9175. <summary>
  9176. Clipboard Format - Windows metafile format. This is the recommended way To store thumbnails in Property Streams.
  9177. </summary>
  9178. <remarks>Note:This is not the same format used in
  9179. regular WMF images. The clipboard version of this format has an
  9180. extra clipboard-specific header.</remarks>
  9181. </member>
  9182. <member name="F:NPOI.HPSF.Thumbnail.CF_DIB">
  9183. <summary>
  9184. Clipboard Format - Device Independent Bitmap
  9185. </summary>
  9186. </member>
  9187. <member name="F:NPOI.HPSF.Thumbnail.CF_ENHMETAFILE">
  9188. <summary>
  9189. Clipboard Format - Enhanced Windows metafile format
  9190. </summary>
  9191. </member>
  9192. <member name="F:NPOI.HPSF.Thumbnail.CF_BITMAP">
  9193. <summary>
  9194. Clipboard Format - Bitmap
  9195. </summary>
  9196. <remarks>see msdn.microsoft.com/library/en-us/dnw98bk/html/clipboardoperations.asp</remarks>
  9197. </member>
  9198. <member name="F:NPOI.HPSF.Thumbnail.thumbnailData">
  9199. A <c>byte[]</c> To hold a thumbnail image in (
  9200. Variant#VT_CF VT_CF) format.
  9201. </member>
  9202. <member name="M:NPOI.HPSF.Thumbnail.#ctor">
  9203. <summary>
  9204. Default Constructor. If you use it then one you'll have To Add
  9205. the thumbnail <c>byte[]</c> from {@link
  9206. SummaryInformation#GetThumbnail()} To do any useful
  9207. manipulations, otherwise you'll Get a
  9208. <c>NullPointerException</c>.
  9209. </summary>
  9210. </member>
  9211. <member name="M:NPOI.HPSF.Thumbnail.#ctor(System.Byte[])">
  9212. <summary>
  9213. Initializes a new instance of the <see cref="T:NPOI.HPSF.Thumbnail"/> class.
  9214. </summary>
  9215. <param name="thumbnailData">The thumbnail data.</param>
  9216. </member>
  9217. <member name="M:NPOI.HPSF.Thumbnail.GetClipboardFormat">
  9218. <summary>
  9219. Returns an <c>int</c> representing the Clipboard
  9220. Format
  9221. Will throw an exception if the Thumbnail's Clipboard Format
  9222. Tag is not {@link Thumbnail#CFTAG_WINDOWS CFTAG_WINDOWS}.
  9223. Possible return values are:
  9224. <ul>
  9225. <li>{@link #CF_METAFILEPICT CF_METAFILEPICT}</li>
  9226. <li>{@link #CF_DIB CF_DIB}</li>
  9227. <li>{@link #CF_ENHMETAFILE CF_ENHMETAFILE}</li>
  9228. <li>{@link #CF_BITMAP CF_BITMAP}</li>
  9229. </ul>
  9230. </summary>
  9231. <returns>a flag indicating the Clipboard Format</returns>
  9232. </member>
  9233. <member name="M:NPOI.HPSF.Thumbnail.GetThumbnailAsWMF">
  9234. <summary>
  9235. Returns the Thumbnail as a <c>byte[]</c> of WMF data
  9236. if the Thumbnail's Clipboard Format Tag is {@link
  9237. #CFTAG_WINDOWS CFTAG_WINDOWS} and its Clipboard Format is
  9238. {@link #CF_METAFILEPICT CF_METAFILEPICT}
  9239. This
  9240. <c>byte[]</c> is in the traditional WMF file, not the
  9241. clipboard-specific version with special headers.
  9242. See <a href="http://www.wvware.com/caolan/ora-wmf.html" tarGet="_blank">http://www.wvware.com/caolan/ora-wmf.html</a>
  9243. for more information on the WMF image format.
  9244. @return A WMF image of the Thumbnail
  9245. @throws HPSFException if the Thumbnail isn't CFTAG_WINDOWS and
  9246. CF_METAFILEPICT
  9247. </summary>
  9248. <returns></returns>
  9249. </member>
  9250. <member name="P:NPOI.HPSF.Thumbnail.ThumbnailData">
  9251. <summary>
  9252. Gets or sets the thumbnail as a <c>byte[]</c> in {@link
  9253. Variant#VT_CF VT_CF} format.
  9254. </summary>
  9255. <value>The thumbnail value</value>
  9256. </member>
  9257. <member name="P:NPOI.HPSF.Thumbnail.ClipboardFormatTag">
  9258. <summary>
  9259. Returns an <c>int</c> representing the Clipboard
  9260. Format Tag
  9261. Possible return values are:
  9262. <ul>
  9263. <li>{@link #CFTAG_WINDOWS CFTAG_WINDOWS}</li>
  9264. <li>{@link #CFTAG_MACINTOSH CFTAG_MACINTOSH}</li>
  9265. <li>{@link #CFTAG_FMTID CFTAG_FMTID}</li>
  9266. <li>{@link #CFTAG_NODATA CFTAG_NODATA}</li>
  9267. </ul>
  9268. </summary>
  9269. <returns>A flag indicating the Clipboard Format Tag</returns>
  9270. </member>
  9271. <member name="T:NPOI.HPSF.TypeWriter">
  9272. <summary>
  9273. Class for writing little-endian data and more.
  9274. @author Rainer Klute
  9275. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  9276. @since 2003-02-20
  9277. </summary>
  9278. </member>
  9279. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.Int16)">
  9280. <summary>
  9281. Writes a two-byte value (short) To an output stream.
  9282. </summary>
  9283. <param name="out1">The stream To Write To..</param>
  9284. <param name="n">The number of bytes that have been written.</param>
  9285. <returns></returns>
  9286. </member>
  9287. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.Int32)">
  9288. Writes a four-byte value To an output stream.
  9289. @param out The stream To Write To.
  9290. @param n The value To Write.
  9291. @exception IOException if an I/O error occurs
  9292. @return The number of bytes written To the output stream.
  9293. </member>
  9294. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.UInt32)">
  9295. Writes a four-byte value To an output stream.
  9296. @param out The stream To Write To.
  9297. @param n The value To Write.
  9298. @exception IOException if an I/O error occurs
  9299. @return The number of bytes written To the output stream.
  9300. </member>
  9301. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.Int64)">
  9302. Writes a eight-byte value To an output stream.
  9303. @param out The stream To Write To.
  9304. @param n The value To Write.
  9305. @exception IOException if an I/O error occurs
  9306. @return The number of bytes written To the output stream.
  9307. </member>
  9308. <member name="M:NPOI.HPSF.TypeWriter.WriteUShortToStream(System.IO.Stream,System.Int32)">
  9309. Writes an unsigned two-byte value To an output stream.
  9310. @param out The stream To Write To
  9311. @param n The value To Write
  9312. @exception IOException if an I/O error occurs
  9313. </member>
  9314. <member name="M:NPOI.HPSF.TypeWriter.WriteUIntToStream(System.IO.Stream,System.UInt32)">
  9315. Writes an unsigned four-byte value To an output stream.
  9316. @param out The stream To Write To.
  9317. @param n The value To Write.
  9318. @return The number of bytes that have been written To the output stream.
  9319. @exception IOException if an I/O error occurs
  9320. </member>
  9321. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,NPOI.Util.ClassID)">
  9322. Writes a 16-byte {@link ClassID} To an output stream.
  9323. @param out The stream To Write To
  9324. @param n The value To Write
  9325. @return The number of bytes written
  9326. @exception IOException if an I/O error occurs
  9327. </member>
  9328. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,NPOI.HPSF.Property[],System.Int32)">
  9329. Writes an array of {@link Property} instances To an output stream
  9330. according To the Horrible Property Format.
  9331. @param out The stream To Write To
  9332. @param properties The array To Write To the stream
  9333. @param codepage The codepage number To use for writing strings
  9334. @exception IOException if an I/O error occurs
  9335. @throws UnsupportedVariantTypeException if HPSF does not support some
  9336. variant type.
  9337. </member>
  9338. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.Double)">
  9339. Writes a double value value To an output stream.
  9340. @param out The stream To Write To.
  9341. @param n The value To Write.
  9342. @exception IOException if an I/O error occurs
  9343. @return The number of bytes written To the output stream.
  9344. </member>
  9345. <member name="T:NPOI.HPSF.UnexpectedPropertySetTypeException">
  9346. <summary>
  9347. This exception is thrown if a certain type of property Set Is
  9348. expected (e.g. a Document Summary Information) but the provided
  9349. property Set is not of that type.
  9350. The constructors of this class are analogous To those of its
  9351. superclass and documented there.
  9352. @author Rainer Klute
  9353. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  9354. @since 2002-02-09
  9355. </summary>
  9356. </member>
  9357. <member name="M:NPOI.HPSF.UnexpectedPropertySetTypeException.#ctor">
  9358. <summary>
  9359. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnexpectedPropertySetTypeException"/> class.
  9360. </summary>
  9361. </member>
  9362. <member name="M:NPOI.HPSF.UnexpectedPropertySetTypeException.#ctor(System.String)">
  9363. <summary>
  9364. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnexpectedPropertySetTypeException"/> class.
  9365. </summary>
  9366. <param name="msg">The message string.</param>
  9367. </member>
  9368. <member name="M:NPOI.HPSF.UnexpectedPropertySetTypeException.#ctor(System.Exception)">
  9369. <summary>
  9370. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnexpectedPropertySetTypeException"/> class.
  9371. </summary>
  9372. <param name="reason">The reason, i.e. a throwable that indirectly
  9373. caused this exception.</param>
  9374. </member>
  9375. <member name="M:NPOI.HPSF.UnexpectedPropertySetTypeException.#ctor(System.String,System.Exception)">
  9376. <summary>
  9377. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnexpectedPropertySetTypeException"/> class.
  9378. </summary>
  9379. <param name="msg">The message string.</param>
  9380. <param name="reason">The reason, i.e. a throwable that indirectly
  9381. caused this exception.</param>
  9382. </member>
  9383. <member name="T:NPOI.HPSF.Util">
  9384. <summary>
  9385. Provides various static utility methods.
  9386. @author Rainer Klute (klute@rainer-klute.de)
  9387. @since 2002-02-09
  9388. </summary>
  9389. </member>
  9390. <member name="M:NPOI.HPSF.Util.Copy(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
  9391. <summary>
  9392. Copies a part of a byte array into another byte array.
  9393. </summary>
  9394. <param name="src">The source byte array.</param>
  9395. <param name="srcOffSet">OffSet in the source byte array.</param>
  9396. <param name="Length">The number of bytes To Copy.</param>
  9397. <param name="dst">The destination byte array.</param>
  9398. <param name="dstOffSet">OffSet in the destination byte array.</param>
  9399. </member>
  9400. <member name="M:NPOI.HPSF.Util.Cat(System.Byte[][])">
  9401. <summary>
  9402. Concatenates the contents of several byte arrays into a
  9403. single one.
  9404. </summary>
  9405. <param name="byteArrays">The byte arrays To be conCatened.</param>
  9406. <returns>A new byte array containing the conCatenated byte arrays.</returns>
  9407. </member>
  9408. <member name="M:NPOI.HPSF.Util.Copy(System.Byte[],System.Int32,System.Int32)">
  9409. <summary>
  9410. Copies bytes from a source byte array into a new byte
  9411. array.
  9412. </summary>
  9413. <param name="src">Copy from this byte array.</param>
  9414. <param name="offset">Start Copying here.</param>
  9415. <param name="Length">Copy this many bytes.</param>
  9416. <returns>The new byte array. Its Length is number of copied bytes.</returns>
  9417. </member>
  9418. <member name="F:NPOI.HPSF.Util.EPOCH_DIFF">
  9419. The difference between the Windows epoch (1601-01-01
  9420. 00:00:00) and the Unix epoch (1970-01-01 00:00:00) in
  9421. milliseconds: 11644473600000L. (Use your favorite spReadsheet
  9422. program To verify the correctness of this value. By the way,
  9423. did you notice that you can tell from the epochs which
  9424. operating system is the modern one? :-))
  9425. </member>
  9426. <member name="M:NPOI.HPSF.Util.FiletimeToDate(System.Int32,System.Int32)">
  9427. <summary>
  9428. Converts a Windows FILETIME into a {@link DateTime}. The Windows
  9429. FILETIME structure holds a DateTime and time associated with a
  9430. file. The structure identifies a 64-bit integer specifying the
  9431. number of 100-nanosecond intervals which have passed since
  9432. January 1, 1601. This 64-bit value is split into the two double
  9433. words stored in the structure.
  9434. </summary>
  9435. <param name="high">The higher double word of the FILETIME structure.</param>
  9436. <param name="low">The lower double word of the FILETIME structure.</param>
  9437. <returns>The Windows FILETIME as a {@link DateTime}.</returns>
  9438. </member>
  9439. <member name="M:NPOI.HPSF.Util.FiletimeToDate(System.Int64)">
  9440. <summary>
  9441. Converts a Windows FILETIME into a {@link DateTime}. The Windows
  9442. FILETIME structure holds a DateTime and time associated with a
  9443. file. The structure identifies a 64-bit integer specifying the
  9444. number of 100-nanosecond intervals which have passed since
  9445. January 1, 1601.
  9446. </summary>
  9447. <param name="filetime">The filetime To Convert.</param>
  9448. <returns>The Windows FILETIME as a {@link DateTime}.</returns>
  9449. </member>
  9450. <member name="M:NPOI.HPSF.Util.DateToFileTime(System.DateTime)">
  9451. <summary>
  9452. Converts a {@link DateTime} into a filetime.
  9453. </summary>
  9454. <param name="dateTime">The DateTime To be Converted</param>
  9455. <returns>The filetime</returns>
  9456. </member>
  9457. <member name="M:NPOI.HPSF.Util.AreEqual(System.Collections.IList,System.Collections.IList)">
  9458. <summary>
  9459. Compares To object arrays with regarding the objects' order. For
  9460. example, [1, 2, 3] and [2, 1, 3] are equal.
  9461. </summary>
  9462. <param name="c1">The first object array.</param>
  9463. <param name="c2">The second object array.</param>
  9464. <returns><c>true</c>
  9465. if the object arrays are equal,
  9466. <c>false</c>
  9467. if they are not.</returns>
  9468. </member>
  9469. <member name="M:NPOI.HPSF.Util.internalEquals(System.Collections.IList,System.Collections.IList)">
  9470. <summary>
  9471. Internals the equals.
  9472. </summary>
  9473. <param name="c1">The c1.</param>
  9474. <param name="c2">The c2.</param>
  9475. <returns></returns>
  9476. </member>
  9477. <member name="M:NPOI.HPSF.Util.Pad4(System.Byte[])">
  9478. <summary>
  9479. Pads a byte array with 0x00 bytes so that its Length is a multiple of
  9480. 4.
  9481. </summary>
  9482. <param name="ba">The byte array To pad.</param>
  9483. <returns>The padded byte array.</returns>
  9484. </member>
  9485. <member name="M:NPOI.HPSF.Util.Pad4(System.Char[])">
  9486. <summary>
  9487. Pads a character array with 0x0000 characters so that its Length is a
  9488. multiple of 4.
  9489. </summary>
  9490. <param name="ca">The character array To pad.</param>
  9491. <returns>The padded character array.</returns>
  9492. </member>
  9493. <member name="M:NPOI.HPSF.Util.Pad4(System.String)">
  9494. <summary>
  9495. Pads a string with 0x0000 characters so that its Length is a
  9496. multiple of 4.
  9497. </summary>
  9498. <param name="s">The string To pad.</param>
  9499. <returns> The padded string as a character array.</returns>
  9500. </member>
  9501. <member name="T:NPOI.HPSF.Variant">
  9502. <summary>
  9503. The <em>Variant</em> types as defined by Microsoft's COM. I
  9504. found this information in <a href="http://www.marin.clara.net/COM/variant_type_definitions.htm">
  9505. http://www.marin.clara.net/COM/variant_type_definitions.htm</a>.
  9506. In the variant types descriptions the following shortcuts are
  9507. used: <strong> [V]</strong> - may appear in a VARIANT,
  9508. <strong>[T]</strong> - may appear in a TYPEDESC,
  9509. <strong>[P]</strong> - may appear in an OLE property Set,
  9510. <strong>[S]</strong> - may appear in a Safe Array.
  9511. @author Rainer Klute (klute@rainer-klute.de)
  9512. @since 2002-02-09
  9513. </summary>
  9514. </member>
  9515. <member name="F:NPOI.HPSF.Variant.VT_EMPTY">
  9516. [V][P] Nothing, i.e. not a single byte of data.
  9517. </member>
  9518. <member name="F:NPOI.HPSF.Variant.VT_NULL">
  9519. [V][P] SQL style Null.
  9520. </member>
  9521. <member name="F:NPOI.HPSF.Variant.VT_I2">
  9522. [V][T][P][S] 2 byte signed int.
  9523. </member>
  9524. <member name="F:NPOI.HPSF.Variant.VT_I4">
  9525. [V][T][P][S] 4 byte signed int.
  9526. </member>
  9527. <member name="F:NPOI.HPSF.Variant.VT_R4">
  9528. [V][T][P][S] 4 byte real.
  9529. </member>
  9530. <member name="F:NPOI.HPSF.Variant.VT_R8">
  9531. [V][T][P][S] 8 byte real.
  9532. </member>
  9533. <member name="F:NPOI.HPSF.Variant.VT_CY">
  9534. [V][T][P][S] currency. <span style="background-color:
  9535. #ffff00">How long is this? How is it To be
  9536. interpreted?</span>
  9537. </member>
  9538. <member name="F:NPOI.HPSF.Variant.VT_DATE">
  9539. [V][T][P][S] DateTime. <span style="background-color:
  9540. #ffff00">How long is this? How is it To be
  9541. interpreted?</span>
  9542. </member>
  9543. <member name="F:NPOI.HPSF.Variant.VT_BSTR">
  9544. [V][T][P][S] OLE Automation string. <span
  9545. style="background-color: #ffff00">How long is this? How is it
  9546. To be interpreted?</span>
  9547. </member>
  9548. <member name="F:NPOI.HPSF.Variant.VT_DISPATCH">
  9549. [V][T][P][S] IDispatch *. <span style="background-color:
  9550. #ffff00">How long is this? How is it To be
  9551. interpreted?</span>
  9552. </member>
  9553. <member name="F:NPOI.HPSF.Variant.VT_ERROR">
  9554. [V][T][S] SCODE. <span style="background-color: #ffff00">How
  9555. long is this? How is it To be interpreted?</span>
  9556. </member>
  9557. <member name="F:NPOI.HPSF.Variant.VT_BOOL">
  9558. [V][T][P][S] True=-1, False=0.
  9559. </member>
  9560. <member name="F:NPOI.HPSF.Variant.VT_VARIANT">
  9561. [V][T][P][S] VARIANT *. <span style="background-color:
  9562. #ffff00">How long is this? How is it To be
  9563. interpreted?</span>
  9564. </member>
  9565. <member name="F:NPOI.HPSF.Variant.VT_UNKNOWN">
  9566. [V][T][S] IUnknown *. <span style="background-color:
  9567. #ffff00">How long is this? How is it To be
  9568. interpreted?</span>
  9569. </member>
  9570. <member name="F:NPOI.HPSF.Variant.VT_DECIMAL">
  9571. [V][T][S] 16 byte fixed point.
  9572. </member>
  9573. <member name="F:NPOI.HPSF.Variant.VT_I1">
  9574. [T] signed char.
  9575. </member>
  9576. <member name="F:NPOI.HPSF.Variant.VT_UI1">
  9577. [V][T][P][S] unsigned char.
  9578. </member>
  9579. <member name="F:NPOI.HPSF.Variant.VT_UI2">
  9580. [T][P] unsigned short.
  9581. </member>
  9582. <member name="F:NPOI.HPSF.Variant.VT_UI4">
  9583. [T][P] unsigned int.
  9584. </member>
  9585. <member name="F:NPOI.HPSF.Variant.VT_I8">
  9586. [T][P] signed 64-bit int.
  9587. </member>
  9588. <member name="F:NPOI.HPSF.Variant.VT_UI8">
  9589. [T][P] unsigned 64-bit int.
  9590. </member>
  9591. <member name="F:NPOI.HPSF.Variant.VT_INT">
  9592. [T] signed machine int.
  9593. </member>
  9594. <member name="F:NPOI.HPSF.Variant.VT_UINT">
  9595. [T] unsigned machine int.
  9596. </member>
  9597. <member name="F:NPOI.HPSF.Variant.VT_VOID">
  9598. [T] C style void.
  9599. </member>
  9600. <member name="F:NPOI.HPSF.Variant.VT_HRESULT">
  9601. [T] Standard return type. <span style="background-color:
  9602. #ffff00">How long is this? How is it To be
  9603. interpreted?</span>
  9604. </member>
  9605. <member name="F:NPOI.HPSF.Variant.VT_PTR">
  9606. [T] pointer type. <span style="background-color:
  9607. #ffff00">How long is this? How is it To be
  9608. interpreted?</span>
  9609. </member>
  9610. <member name="F:NPOI.HPSF.Variant.VT_SAFEARRAY">
  9611. [T] (use VT_ARRAY in VARIANT).
  9612. </member>
  9613. <member name="F:NPOI.HPSF.Variant.VT_CARRAY">
  9614. [T] C style array. <span style="background-color:
  9615. #ffff00">How long is this? How is it To be
  9616. interpreted?</span>
  9617. </member>
  9618. <member name="F:NPOI.HPSF.Variant.VT_USERDEFINED">
  9619. [T] user defined type. <span style="background-color:
  9620. #ffff00">How long is this? How is it To be
  9621. interpreted?</span>
  9622. </member>
  9623. <member name="F:NPOI.HPSF.Variant.VT_LPSTR">
  9624. [T][P] null terminated string.
  9625. </member>
  9626. <member name="F:NPOI.HPSF.Variant.VT_LPWSTR">
  9627. [T][P] wide (Unicode) null terminated string.
  9628. </member>
  9629. <member name="F:NPOI.HPSF.Variant.VT_FILETIME">
  9630. [P] FILETIME. The FILETIME structure holds a DateTime and time
  9631. associated with a file. The structure identifies a 64-bit
  9632. integer specifying the number of 100-nanosecond intervals which
  9633. have passed since January 1, 1601. This 64-bit value is split
  9634. into the two dwords stored in the structure.
  9635. </member>
  9636. <member name="F:NPOI.HPSF.Variant.VT_BLOB">
  9637. [P] Length prefixed bytes.
  9638. </member>
  9639. <member name="F:NPOI.HPSF.Variant.VT_STREAM">
  9640. [P] Name of the stream follows.
  9641. </member>
  9642. <member name="F:NPOI.HPSF.Variant.VT_STORAGE">
  9643. [P] Name of the storage follows.
  9644. </member>
  9645. <member name="F:NPOI.HPSF.Variant.VT_STREAMED_OBJECT">
  9646. [P] Stream Contains an object. <span
  9647. style="background-color: #ffff00"> How long is this? How is it
  9648. To be interpreted?</span>
  9649. </member>
  9650. <member name="F:NPOI.HPSF.Variant.VT_STORED_OBJECT">
  9651. [P] Storage Contains an object. <span
  9652. style="background-color: #ffff00"> How long is this? How is it
  9653. To be interpreted?</span>
  9654. </member>
  9655. <member name="F:NPOI.HPSF.Variant.VT_BLOB_OBJECT">
  9656. [P] Blob Contains an object. <span style="background-color:
  9657. #ffff00">How long is this? How is it To be
  9658. interpreted?</span>
  9659. </member>
  9660. <member name="F:NPOI.HPSF.Variant.VT_CF">
  9661. [P] Clipboard format. <span style="background-color:
  9662. #ffff00">How long is this? How is it To be
  9663. interpreted?</span>
  9664. </member>
  9665. <member name="F:NPOI.HPSF.Variant.VT_CLSID">
  9666. [P] A Class ID.
  9667. It consists of a 32 bit unsigned integer indicating the size
  9668. of the structure, a 32 bit signed integer indicating (Clipboard
  9669. Format Tag) indicating the type of data that it Contains, and
  9670. then a byte array containing the data.
  9671. The valid Clipboard Format Tags are:
  9672. <ul>
  9673. <li>{@link Thumbnail#CFTAG_WINDOWS}</li>
  9674. <li>{@link Thumbnail#CFTAG_MACINTOSH}</li>
  9675. <li>{@link Thumbnail#CFTAG_NODATA}</li>
  9676. <li>{@link Thumbnail#CFTAG_FMTID}</li>
  9677. </ul>
  9678. <pre>typedef struct tagCLIPDATA {
  9679. // cbSize is the size of the buffer pointed To
  9680. // by pClipData, plus sizeof(ulClipFmt)
  9681. ULONG cbSize;
  9682. long ulClipFmt;
  9683. BYTE* pClipData;
  9684. } CLIPDATA;</pre>
  9685. See <a
  9686. href="msdn.microsoft.com/library/en-us/com/stgrstrc_0uwk.asp"
  9687. tarGet="_blank">
  9688. msdn.microsoft.com/library/en-us/com/stgrstrc_0uwk.asp</a>.
  9689. </member>
  9690. <member name="F:NPOI.HPSF.Variant.VT_VERSIONED_STREAM">
  9691. "MUST be a VersionedStream. The storage representing the (non-simple)
  9692. property set MUST have a stream element with the name in the StreamName
  9693. field." -- [MS-OLEPS] -- v20110920; Object Linking and Embedding (OLE)
  9694. Property Set Data Structures; page 24 / 63
  9695. </member>
  9696. <member name="F:NPOI.HPSF.Variant.VT_VECTOR">
  9697. [P] simple counted array. <span style="background-color:
  9698. #ffff00">How long is this? How is it To be
  9699. interpreted?</span>
  9700. </member>
  9701. <member name="F:NPOI.HPSF.Variant.VT_ARRAY">
  9702. [V] SAFEARRAY*. <span style="background-color: #ffff00">How
  9703. long is this? How is it To be interpreted?</span>
  9704. </member>
  9705. <member name="F:NPOI.HPSF.Variant.VT_BYREF">
  9706. [V] void* for local use. <span style="background-color:
  9707. #ffff00">How long is this? How is it To be
  9708. interpreted?</span>
  9709. </member>
  9710. <member name="F:NPOI.HPSF.Variant.VT_RESERVED">
  9711. FIXME (3): Document this!
  9712. </member>
  9713. <member name="F:NPOI.HPSF.Variant.VT_ILLEGAL">
  9714. FIXME (3): Document this!
  9715. </member>
  9716. <member name="F:NPOI.HPSF.Variant.VT_ILLEGALMASKED">
  9717. FIXME (3): Document this!
  9718. </member>
  9719. <member name="F:NPOI.HPSF.Variant.VT_TYPEMASK">
  9720. FIXME (3): Document this!
  9721. </member>
  9722. <member name="F:NPOI.HPSF.Variant.Length_UNKNOWN">
  9723. Denotes a variant type with a Length that is unknown To HPSF yet.
  9724. </member>
  9725. <member name="F:NPOI.HPSF.Variant.Length_VARIABLE">
  9726. Denotes a variant type with a variable Length.
  9727. </member>
  9728. <member name="F:NPOI.HPSF.Variant.Length_0">
  9729. Denotes a variant type with a Length of 0 bytes.
  9730. </member>
  9731. <member name="F:NPOI.HPSF.Variant.Length_2">
  9732. Denotes a variant type with a Length of 2 bytes.
  9733. </member>
  9734. <member name="F:NPOI.HPSF.Variant.Length_4">
  9735. Denotes a variant type with a Length of 4 bytes.
  9736. </member>
  9737. <member name="F:NPOI.HPSF.Variant.Length_8">
  9738. Denotes a variant type with a Length of 8 bytes.
  9739. </member>
  9740. <member name="F:NPOI.HPSF.Variant.numberToName">
  9741. Maps the numbers denoting the variant types To their corresponding
  9742. variant type names.
  9743. </member>
  9744. <member name="M:NPOI.HPSF.Variant.GetVariantName(System.Int64)">
  9745. <summary>
  9746. Returns the variant type name associated with a variant type
  9747. number.
  9748. </summary>
  9749. <param name="variantType">The variant type number.</param>
  9750. <returns>The variant type name or the string "unknown variant type"</returns>
  9751. </member>
  9752. <member name="M:NPOI.HPSF.Variant.GetVariantLength(System.Int64)">
  9753. <summary>
  9754. Returns a variant type's Length.
  9755. </summary>
  9756. <param name="variantType">The variant type number.</param>
  9757. <returns>The Length of the variant type's data in bytes. If the Length Is
  9758. variable, i.e. the Length of a string, -1 is returned. If HPSF does not
  9759. know the Length, -2 is returned. The latter usually indicates an
  9760. unsupported variant type.</returns>
  9761. </member>
  9762. <member name="T:NPOI.HPSF.VariantSupport">
  9763. <summary>
  9764. Supports Reading and writing of variant data.
  9765. <strong>FIXME (3):</strong>
  9766. Reading and writing should be made more
  9767. uniform than it is now. The following items should be resolved:
  9768. Reading requires a Length parameter that is 4 byte greater than the
  9769. actual data, because the variant type field is included.
  9770. Reading Reads from a byte array while writing Writes To an byte array
  9771. output stream.
  9772. @author Rainer Klute
  9773. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  9774. @since 2003-08-08
  9775. </summary>
  9776. </member>
  9777. <member name="F:NPOI.HPSF.VariantSupport.unsupportedMessage">
  9778. Keeps a list of the variant types an "unsupported" message has alReady
  9779. been issued for.
  9780. </member>
  9781. <member name="M:NPOI.HPSF.VariantSupport.WriteUnsupportedTypeMessage(NPOI.HPSF.UnsupportedVariantTypeException)">
  9782. <summary>
  9783. Writes a warning To System.err that a variant type Is
  9784. unsupported by HPSF. Such a warning is written only once for each variant
  9785. type. Log messages can be turned on or off by
  9786. </summary>
  9787. <param name="ex">The exception To log</param>
  9788. </member>
  9789. <member name="F:NPOI.HPSF.VariantSupport.SUPPORTED_TYPES">
  9790. HPSF is able To Read these {@link Variant} types.
  9791. </member>
  9792. <member name="M:NPOI.HPSF.VariantSupport.IsSupportedType(System.Int32)">
  9793. <summary>
  9794. Checks whether HPSF supports the specified variant type. Unsupported
  9795. types should be implemented included in the {@link #SUPPORTED_TYPES}
  9796. array.
  9797. </summary>
  9798. <param name="variantType">the variant type To check</param>
  9799. <returns>
  9800. <c>true</c> if HPFS supports this type,otherwise, <c>false</c>.
  9801. </returns>
  9802. </member>
  9803. <member name="M:NPOI.HPSF.VariantSupport.Read(System.Byte[],System.Int32,System.Int32,System.Int64,System.Int32)">
  9804. <summary>
  9805. Reads a variant type from a byte array
  9806. </summary>
  9807. <param name="src">The byte array</param>
  9808. <param name="offset">The offset in the byte array where the variant starts</param>
  9809. <param name="length">The Length of the variant including the variant type field</param>
  9810. <param name="type">The variant type To Read</param>
  9811. <param name="codepage">The codepage To use for non-wide strings</param>
  9812. <returns>A Java object that corresponds best To the variant field. For
  9813. example, a VT_I4 is returned as a {@link long}, a VT_LPSTR as a
  9814. {@link String}.</returns>
  9815. </member>
  9816. <member name="M:NPOI.HPSF.VariantSupport.CodepageToEncoding(System.Int32)">
  9817. <p>Turns a codepage number into the equivalent character encoding's
  9818. name.</p>
  9819. @param codepage The codepage number
  9820. @return The character encoding's name. If the codepage number is 65001,
  9821. the encoding name is "UTF-8". All other positive numbers are mapped to
  9822. "cp" followed by the number, e.g. if the codepage number is 1252 the
  9823. returned character encoding name will be "cp1252".
  9824. @exception UnsupportedEncodingException if the specified codepage is
  9825. less than zero.
  9826. </member>
  9827. <member name="M:NPOI.HPSF.VariantSupport.Write(System.IO.Stream,System.Int64,System.Object,System.Int32)">
  9828. <summary>
  9829. Writes a variant value To an output stream. This method ensures that
  9830. always a multiple of 4 bytes is written.
  9831. If the codepage is UTF-16, which is encouraged, strings
  9832. <strong>must</strong> always be written as {@link Variant#VT_LPWSTR}
  9833. strings, not as {@link Variant#VT_LPSTR} strings. This method ensure this
  9834. by Converting strings appropriately, if needed.
  9835. </summary>
  9836. <param name="out1">The stream To Write the value To.</param>
  9837. <param name="type">The variant's type.</param>
  9838. <param name="value">The variant's value.</param>
  9839. <param name="codepage">The codepage To use To Write non-wide strings</param>
  9840. <returns>The number of entities that have been written. In many cases an
  9841. "entity" is a byte but this is not always the case.</returns>
  9842. </member>
  9843. <member name="P:NPOI.HPSF.VariantSupport.IsLogUnsupportedTypes">
  9844. <summary>
  9845. Checks whether logging of unsupported variant types warning is turned
  9846. on or off.
  9847. </summary>
  9848. <value>
  9849. <c>true</c> if logging is turned on; otherwise, <c>false</c>.
  9850. </value>
  9851. </member>
  9852. <member name="T:NPOI.HPSF.Wellknown.PropertyIDMap">
  9853. <summary>
  9854. This is a dictionary which maps property ID values To property
  9855. ID strings.
  9856. The methods {@link #GetSummaryInformationProperties} and {@link
  9857. #GetDocumentSummaryInformationProperties} return singleton {@link
  9858. PropertyIDMap}s. An application that wants To extend these maps
  9859. should treat them as unmodifiable, copy them and modifiy the
  9860. copies.
  9861. @author Rainer Klute
  9862. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  9863. @since 2002-02-09
  9864. </summary>
  9865. </member>
  9866. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_TITLE">
  9867. ID of the property that denotes the document's title
  9868. </member>
  9869. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_SUBJECT">
  9870. ID of the property that denotes the document's subject
  9871. </member>
  9872. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_AUTHOR">
  9873. ID of the property that denotes the document's author
  9874. </member>
  9875. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_KEYWORDS">
  9876. ID of the property that denotes the document's keywords
  9877. </member>
  9878. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_COMMENTS">
  9879. ID of the property that denotes the document's comments
  9880. </member>
  9881. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_TEMPLATE">
  9882. ID of the property that denotes the document's template
  9883. </member>
  9884. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LASTAUTHOR">
  9885. ID of the property that denotes the document's last author
  9886. </member>
  9887. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_REVNUMBER">
  9888. ID of the property that denotes the document's revision number
  9889. </member>
  9890. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_EDITTIME">
  9891. ID of the property that denotes the document's edit time
  9892. </member>
  9893. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LASTPRINTED">
  9894. ID of the property that denotes the DateTime and time the document was
  9895. last printed
  9896. </member>
  9897. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_Create_DTM">
  9898. ID of the property that denotes the DateTime and time the document was
  9899. Created.
  9900. </member>
  9901. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LASTSAVE_DTM">
  9902. ID of the property that denotes the DateTime and time the document was
  9903. saved
  9904. </member>
  9905. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_PAGECOUNT">
  9906. ID of the property that denotes the number of pages in the
  9907. document
  9908. </member>
  9909. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_WORDCOUNT">
  9910. ID of the property that denotes the number of words in the
  9911. document
  9912. </member>
  9913. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CHARCOUNT">
  9914. ID of the property that denotes the number of characters in the
  9915. document
  9916. </member>
  9917. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_THUMBNAIL">
  9918. ID of the property that denotes the document's thumbnail
  9919. </member>
  9920. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_APPNAME">
  9921. ID of the property that denotes the application that Created the
  9922. document
  9923. </member>
  9924. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_SECURITY">
  9925. ID of the property that denotes whether Read/Write access To the
  9926. document is allowed or whether is should be opened as Read-only. It can
  9927. have the following values:
  9928. <table>
  9929. <tbody>
  9930. <tr>
  9931. <th>Value</th>
  9932. <th>Description</th>
  9933. </tr>
  9934. <tr>
  9935. <th>0</th>
  9936. <th>No restriction</th>
  9937. </tr>
  9938. <tr>
  9939. <th>2</th>
  9940. <th>Read-only recommended</th>
  9941. </tr>
  9942. <tr>
  9943. <th>4</th>
  9944. <th>Read-only enforced</th>
  9945. </tr>
  9946. </tbody>
  9947. </table>
  9948. </member>
  9949. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_DICTIONARY">
  9950. The entry is a dictionary.
  9951. </member>
  9952. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CODEPAGE">
  9953. The entry denotes a code page.
  9954. </member>
  9955. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CATEGORY">
  9956. The entry is a string denoting the category the file belongs
  9957. To, e.g. review, memo, etc. This is useful To Find documents of
  9958. same type.
  9959. </member>
  9960. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_PRESFORMAT">
  9961. TarGet format for power point presentation, e.g. 35mm,
  9962. printer, video etc.
  9963. </member>
  9964. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_BYTECOUNT">
  9965. Number of bytes.
  9966. </member>
  9967. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LINECOUNT">
  9968. Number of lines.
  9969. </member>
  9970. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_PARCOUNT">
  9971. Number of paragraphs.
  9972. </member>
  9973. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_SLIDECOUNT">
  9974. Number of slides in a power point presentation.
  9975. </member>
  9976. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_NOTECOUNT">
  9977. Number of slides with notes.
  9978. </member>
  9979. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_HIDDENCOUNT">
  9980. Number of hidden slides.
  9981. </member>
  9982. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_MMCLIPCOUNT">
  9983. Number of multimedia clips, e.g. sound or video.
  9984. </member>
  9985. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_SCALE">
  9986. This entry is Set To -1 when scaling of the thumbnail Is
  9987. desired. Otherwise the thumbnail should be cropped.
  9988. </member>
  9989. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_HEADINGPAIR">
  9990. This entry denotes an internally used property. It is a
  9991. vector of variants consisting of pairs of a string (VT_LPSTR)
  9992. and a number (VT_I4). The string is a heading name, and the
  9993. number tells how many document parts are under that
  9994. heading.
  9995. </member>
  9996. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_DOCPARTS">
  9997. This entry Contains the names of document parts (word: names
  9998. of the documents in the master document, excel: sheet names,
  9999. power point: slide titles, binder: document names).
  10000. </member>
  10001. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_MANAGER">
  10002. This entry Contains the name of the project manager.
  10003. </member>
  10004. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_COMPANY">
  10005. This entry Contains the company name.
  10006. </member>
  10007. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LINKSDIRTY">
  10008. If this entry is -1 the links are dirty and should be
  10009. re-evaluated.
  10010. </member>
  10011. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_MAX">
  10012. The highest well-known property ID. Applications are free To use higher values for custom purposes.
  10013. </member>
  10014. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.summaryInformationProperties">
  10015. Contains the summary information property ID values and
  10016. associated strings. See the overall HPSF documentation for
  10017. details!
  10018. </member>
  10019. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.documentSummaryInformationProperties">
  10020. Contains the summary information property ID values and
  10021. associated strings. See the overall HPSF documentation for
  10022. details!
  10023. </member>
  10024. <member name="M:NPOI.HPSF.Wellknown.PropertyIDMap.#ctor(System.Int32,System.Single)">
  10025. <summary>
  10026. Initializes a new instance of the <see cref="T:NPOI.HPSF.Wellknown.PropertyIDMap"/> class.
  10027. </summary>
  10028. <param name="initialCapacity">initialCapacity The initial capacity as defined for
  10029. {@link HashMap}</param>
  10030. <param name="loadFactor">The load factor as defined for {@link HashMap}</param>
  10031. </member>
  10032. <member name="M:NPOI.HPSF.Wellknown.PropertyIDMap.#ctor(System.Collections.IDictionary)">
  10033. <summary>
  10034. Initializes a new instance of the <see cref="T:NPOI.HPSF.Wellknown.PropertyIDMap"/> class.
  10035. </summary>
  10036. <param name="map">The instance To be Created is backed by this map.</param>
  10037. </member>
  10038. <member name="M:NPOI.HPSF.Wellknown.PropertyIDMap.Put(System.Int64,System.String)">
  10039. <summary>
  10040. Puts a ID string for an ID into the {@link
  10041. PropertyIDMap}.
  10042. </summary>
  10043. <param name="id">The ID string.</param>
  10044. <param name="idString">The id string.</param>
  10045. <returns>As specified by the {@link java.util.Map} interface, this method
  10046. returns the previous value associated with the specified id</returns>
  10047. </member>
  10048. <member name="M:NPOI.HPSF.Wellknown.PropertyIDMap.Get(System.Int64)">
  10049. <summary>
  10050. Gets the ID string for an ID from the {@link
  10051. PropertyIDMap}.
  10052. </summary>
  10053. <param name="id">The ID.</param>
  10054. <returns>The ID string associated with id</returns>
  10055. </member>
  10056. <member name="P:NPOI.HPSF.Wellknown.PropertyIDMap.SummaryInformationProperties">
  10057. <summary>
  10058. Gets the Summary Information properties singleton
  10059. </summary>
  10060. <returns></returns>
  10061. </member>
  10062. <member name="P:NPOI.HPSF.Wellknown.PropertyIDMap.DocumentSummaryInformationProperties">
  10063. <summary>
  10064. Gets the Document Summary Information properties
  10065. singleton.
  10066. </summary>
  10067. <returns>The Document Summary Information properties singleton.</returns>
  10068. </member>
  10069. <member name="T:NPOI.HPSF.Wellknown.SectionIDMap">
  10070. <summary>
  10071. Maps section format IDs To {@link PropertyIDMap}s. It Is
  10072. initialized with two well-known section format IDs: those of the
  10073. <c>\005SummaryInformation</c> stream and the
  10074. <c>\005DocumentSummaryInformation</c> stream.
  10075. If you have a section format ID you can use it as a key To query
  10076. this map. If you Get a {@link PropertyIDMap} returned your section
  10077. is well-known and you can query the {@link PropertyIDMap} for PID
  10078. strings. If you Get back <c>null</c> you are on your own.
  10079. This {@link java.util.Map} expects the byte arrays of section format IDs
  10080. as keys. A key maps To a {@link PropertyIDMap} describing the
  10081. property IDs in sections with the specified section format ID.
  10082. @author Rainer Klute (klute@rainer-klute.de)
  10083. @since 2002-02-09
  10084. </summary>
  10085. </member>
  10086. <member name="F:NPOI.HPSF.Wellknown.SectionIDMap.UNDEFINED">
  10087. A property without a known name is described by this string.
  10088. </member>
  10089. <member name="F:NPOI.HPSF.Wellknown.SectionIDMap.SUMMARY_INFORMATION_ID">
  10090. The SummaryInformation's section's format ID.
  10091. </member>
  10092. <member name="F:NPOI.HPSF.Wellknown.SectionIDMap.DOCUMENT_SUMMARY_INFORMATION_ID1">
  10093. The DocumentSummaryInformation's first and second sections' format
  10094. ID.
  10095. </member>
  10096. <member name="F:NPOI.HPSF.Wellknown.SectionIDMap.defaultMap">
  10097. The default section ID map. It maps section format IDs To
  10098. {@link PropertyIDMap}s.
  10099. </member>
  10100. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.GetInstance">
  10101. <summary>
  10102. Returns the singleton instance of the default {@link
  10103. SectionIDMap}.
  10104. </summary>
  10105. <returns>The instance value</returns>
  10106. </member>
  10107. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.GetPIDString(System.Byte[],System.Int64)">
  10108. <summary>
  10109. Returns the property ID string that is associated with a
  10110. given property ID in a section format ID's namespace.
  10111. </summary>
  10112. <param name="sectionFormatID">Each section format ID has its own name
  10113. space of property ID strings and thus must be specified.</param>
  10114. <param name="pid">The property ID</param>
  10115. <returns>The well-known property ID string associated with the
  10116. property ID pid in the name space spanned by sectionFormatID If the pid
  10117. sectionFormatID combination is not well-known, the
  10118. string "[undefined]" is returned.
  10119. </returns>
  10120. </member>
  10121. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.Get(System.Byte[])">
  10122. <summary>
  10123. Returns the {@link PropertyIDMap} for a given section format
  10124. ID.
  10125. </summary>
  10126. <param name="sectionFormatID">The section format ID.</param>
  10127. <returns>the property ID map</returns>
  10128. </member>
  10129. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.Get(System.Object)">
  10130. <summary>
  10131. Returns the {@link PropertyIDMap} for a given section format
  10132. ID.
  10133. </summary>
  10134. <param name="sectionFormatID">A section format ID as a
  10135. <c>byte[]</c></param>
  10136. <returns>the property ID map</returns>
  10137. </member>
  10138. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.Put(System.Byte[],NPOI.HPSF.Wellknown.PropertyIDMap)">
  10139. <summary>
  10140. Associates a section format ID with a {@link
  10141. PropertyIDMap}.
  10142. </summary>
  10143. <param name="sectionFormatID">the section format ID</param>
  10144. <param name="propertyIDMap">The property ID map.</param>
  10145. <returns></returns>
  10146. </member>
  10147. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.Put(System.Object,System.Object)">
  10148. <summary>
  10149. Puts the specified key.
  10150. </summary>
  10151. <param name="key">This parameter remains undocumented since the method Is
  10152. deprecated.</param>
  10153. <param name="value">This parameter remains undocumented since the method Is
  10154. deprecated.</param>
  10155. <returns>The return value remains undocumented since the method Is
  10156. deprecated.</returns>
  10157. </member>
  10158. <member name="T:NPOI.HPSF.WritingNotSupportedException">
  10159. <summary>
  10160. This exception is thrown when trying To Write a (yet) unsupported variant
  10161. type.
  10162. @see ReadingNotSupportedException
  10163. @see UnsupportedVariantTypeException
  10164. @author Rainer Klute
  10165. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  10166. @since 2003-08-08
  10167. </summary>
  10168. </member>
  10169. <member name="M:NPOI.HPSF.WritingNotSupportedException.#ctor(System.Int64,System.Object)">
  10170. <summary>
  10171. Initializes a new instance of the <see cref="T:NPOI.HPSF.WritingNotSupportedException"/> class.
  10172. </summary>
  10173. <param name="variantType">The unsupported variant type.</param>
  10174. <param name="value">The value</param>
  10175. </member>
  10176. <member name="T:NPOI.HSSF.EventModel.IERFListener">
  10177. An ERFListener Is registered with the EventRecordFactory.
  10178. An ERFListener listens for Records coming from the stream
  10179. via the EventRecordFactory
  10180. @see EventRecordFactory
  10181. @author Andrew C. Oliver acoliver@apache.org
  10182. </member>
  10183. <member name="M:NPOI.HSSF.EventModel.IERFListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  10184. Process a Record. This method Is called by the
  10185. EventRecordFactory when a record Is returned.
  10186. @return bool specifying whether the effort was a success.
  10187. </member>
  10188. <member name="T:NPOI.HSSF.EventModel.EventRecordFactory">
  10189. Event-based record factory. As opposed to RecordFactory
  10190. this refactored version throws record events as it comes
  10191. accross the records. I throws the "lazily" one record behind
  10192. to ensure that ContinueRecords are Processed first.
  10193. @author Andrew C. Oliver (acoliver@apache.org) - probably to blame for the bugs (so yank his chain on the list)
  10194. @author Marc Johnson (mjohnson at apache dot org) - methods taken from RecordFactory
  10195. @author Glen Stampoultzis (glens at apache.org) - methods taken from RecordFactory
  10196. @author Csaba Nagy (ncsaba at yahoo dot com)
  10197. </member>
  10198. <member name="M:NPOI.HSSF.EventModel.EventRecordFactory.#ctor(NPOI.HSSF.EventModel.IERFListener,System.Collections.ArrayList)">
  10199. Create an EventRecordFactory
  10200. @param abortable specifies whether the return from the listener
  10201. handler functions are obeyed. False means they are ignored. True
  10202. means the event loop exits on error.
  10203. </member>
  10204. <member name="M:NPOI.HSSF.EventModel.EventRecordFactory.ProcessRecord(NPOI.HSSF.Record.Record)">
  10205. sends the record event to all registered listeners.
  10206. @param record the record to be thrown.
  10207. @return <c>false</c> to abort. This aborts
  10208. out of the event loop should the listener return false
  10209. </member>
  10210. <member name="M:NPOI.HSSF.EventModel.EventRecordFactory.ProcessRecords(System.IO.Stream)">
  10211. Create an array of records from an input stream
  10212. @param in the InputStream from which the records will be
  10213. obtained
  10214. @exception RecordFormatException on error Processing the
  10215. InputStream
  10216. </member>
  10217. <member name="T:NPOI.HSSF.EventUserModel.AbortableHSSFListener">
  10218. Interface for use with the HSSFRequest and HSSFEventFactory. Users should Create
  10219. a listener supporting this interface and register it with the HSSFRequest (associating
  10220. it with Record SID's).
  10221. @see org.apache.poi.hssf.eventusermodel.HSSFEventFactory
  10222. @see org.apache.poi.hssf.eventusermodel.HSSFRequest
  10223. @see org.apache.poi.hssf.eventusermodel.HSSFUserException
  10224. @author Carey Sublette (careysub@earthling.net)
  10225. </member>
  10226. <member name="T:NPOI.HSSF.EventUserModel.IHSSFListener">
  10227. <summary>
  10228. Interface for use with the HSSFRequest and HSSFEventFactory. Users should Create
  10229. a listener supporting this interface and register it with the HSSFRequest (associating
  10230. it with Record SID's).
  10231. @author acoliver@apache.org
  10232. </summary>
  10233. </member>
  10234. <member name="M:NPOI.HSSF.EventUserModel.IHSSFListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  10235. <summary>
  10236. Process an HSSF Record. Called when a record occurs in an HSSF file.
  10237. </summary>
  10238. <param name="record">The record.</param>
  10239. </member>
  10240. <member name="M:NPOI.HSSF.EventUserModel.AbortableHSSFListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  10241. This method, inherited from HSSFListener Is implemented as a stub.
  10242. It Is never called by HSSFEventFActory or HSSFRequest.
  10243. </member>
  10244. <member name="M:NPOI.HSSF.EventUserModel.AbortableHSSFListener.AbortableProcessRecord(NPOI.HSSF.Record.Record)">
  10245. Process an HSSF Record. Called when a record occurs in an HSSF file.
  10246. Provides two options for halting the Processing of the HSSF file.
  10247. The return value provides a means of non-error termination with a
  10248. user-defined result code. A value of zero must be returned to
  10249. continue Processing, any other value will halt Processing by
  10250. <c>HSSFEventFactory</c> with the code being passed back by
  10251. its abortable Process events methods.
  10252. Error termination can be done by throwing the HSSFUserException.
  10253. Note that HSSFEventFactory will not call the inherited Process
  10254. @return result code of zero for continued Processing.
  10255. @throws HSSFUserException User code can throw this to abort
  10256. file Processing by HSSFEventFactory and return diagnostic information.
  10257. </member>
  10258. <member name="T:NPOI.HSSF.EventUserModel.DummyRecord.LastCellOfRowDummyRecord">
  10259. A dummy record to indicate that we've now had the last
  10260. cell record for this row.
  10261. </member>
  10262. <member name="P:NPOI.HSSF.EventUserModel.DummyRecord.LastCellOfRowDummyRecord.Row">
  10263. Returns the (0 based) number of the row we are
  10264. currently working on.
  10265. </member>
  10266. <member name="P:NPOI.HSSF.EventUserModel.DummyRecord.LastCellOfRowDummyRecord.LastColumnNumber">
  10267. Returns the (0 based) number of the last column
  10268. seen for this row. You should have alReady been
  10269. called with that record.
  10270. This Is -1 in the case of there being no columns
  10271. for the row.
  10272. </member>
  10273. <member name="T:NPOI.HSSF.EventUserModel.DummyRecord.MissingCellDummyRecord">
  10274. A dummy record for when we're missing a cell in a row,
  10275. but still want to trigger something
  10276. </member>
  10277. <member name="T:NPOI.HSSF.EventUserModel.DummyRecord.MissingRowDummyRecord">
  10278. A dummy record for when we're missing a row, but still
  10279. want to trigger something
  10280. </member>
  10281. <member name="T:NPOI.HSSF.EventUserModel.EventWorkbookBuilder">
  10282. <summary>
  10283. When working with the EventUserModel, if you want to
  10284. Process formulas, you need an instance of
  10285. Workbook to pass to a HSSFWorkbook,
  10286. to finally give to HSSFFormulaParser,
  10287. and this will build you stub ones.
  10288. Since you're working with the EventUserModel, you
  10289. wouldn't want to Get a full Workbook and
  10290. HSSFWorkbook, as they would eat too much memory.
  10291. Instead, you should collect a few key records as they
  10292. go past, then call this once you have them to build a
  10293. stub Workbook, and from that a stub
  10294. HSSFWorkbook, to use with the HSSFFormulaParser.
  10295. The records you should collect are:
  10296. ExternSheetRecord
  10297. BoundSheetRecord
  10298. You should probably also collect SSTRecord,
  10299. but it's not required to pass this in.
  10300. To help, this class includes a HSSFListener wrapper
  10301. that will do the collecting for you.
  10302. </summary>
  10303. </member>
  10304. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.CreateStubWorkbook(NPOI.HSSF.Record.ExternSheetRecord[],NPOI.HSSF.Record.BoundSheetRecord[],NPOI.HSSF.Record.SSTRecord)">
  10305. <summary>
  10306. Creates a stub Workbook from the supplied records,
  10307. suitable for use with the {@link HSSFFormulaParser}
  10308. </summary>
  10309. <param name="externs">The ExternSheetRecords in your file</param>
  10310. <param name="bounds">The BoundSheetRecords in your file</param>
  10311. <param name="sst">TThe SSTRecord in your file.</param>
  10312. <returns>A stub Workbook suitable for use with HSSFFormulaParser</returns>
  10313. </member>
  10314. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.CreateStubWorkbook(NPOI.HSSF.Record.ExternSheetRecord[],NPOI.HSSF.Record.BoundSheetRecord[])">
  10315. <summary>
  10316. Creates a stub workbook from the supplied records,
  10317. suitable for use with the HSSFFormulaParser
  10318. </summary>
  10319. <param name="externs">The ExternSheetRecords in your file</param>
  10320. <param name="bounds">A stub Workbook suitable for use with HSSFFormulaParser</param>
  10321. <returns>A stub Workbook suitable for use with {@link HSSFFormulaParser}</returns>
  10322. </member>
  10323. <member name="T:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener">
  10324. <summary>
  10325. A wrapping HSSFListener which will collect
  10326. BoundSheetRecords and {@link ExternSheetRecord}s as
  10327. they go past, so you can Create a Stub {@link Workbook} from
  10328. them once required.
  10329. </summary>
  10330. </member>
  10331. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.#ctor(NPOI.HSSF.EventUserModel.IHSSFListener)">
  10332. <summary>
  10333. Initializes a new instance of the <see cref="T:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener"/> class.
  10334. </summary>
  10335. <param name="childListener">The child listener.</param>
  10336. </member>
  10337. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.GetBoundSheetRecords">
  10338. <summary>
  10339. Gets the bound sheet records.
  10340. </summary>
  10341. <returns></returns>
  10342. </member>
  10343. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.GetExternSheetRecords">
  10344. <summary>
  10345. Gets the extern sheet records.
  10346. </summary>
  10347. <returns></returns>
  10348. </member>
  10349. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.GetSSTRecord">
  10350. <summary>
  10351. Gets the SST record.
  10352. </summary>
  10353. <returns></returns>
  10354. </member>
  10355. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.GetStubHSSFWorkbook">
  10356. <summary>
  10357. Gets the stub HSSF workbook.
  10358. </summary>
  10359. <returns></returns>
  10360. </member>
  10361. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.GetStubWorkbook">
  10362. <summary>
  10363. Gets the stub workbook.
  10364. </summary>
  10365. <returns></returns>
  10366. </member>
  10367. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  10368. <summary>
  10369. Process this record ourselves, and then
  10370. pass it on to our child listener
  10371. </summary>
  10372. <param name="record">The record.</param>
  10373. </member>
  10374. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.ProcessRecordInternally(NPOI.HSSF.Record.Record)">
  10375. <summary>
  10376. Process the record ourselves, but do not
  10377. pass it on to the child Listener.
  10378. </summary>
  10379. <param name="record">The record.</param>
  10380. </member>
  10381. <member name="T:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener">
  10382. A proxy HSSFListener that keeps track of the document
  10383. formatting records, and provides an easy way to look
  10384. up the format strings used by cells from their ids.
  10385. </member>
  10386. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  10387. Process this record ourselves, and then
  10388. pass it on to our child listener
  10389. </member>
  10390. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.ProcessRecordInternally(NPOI.HSSF.Record.Record)">
  10391. Process the record ourselves, but do not
  10392. pass it on to the child Listener.
  10393. @param record
  10394. </member>
  10395. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.FormatNumberDateCell(NPOI.HSSF.Record.CellValueRecordInterface)">
  10396. Formats the given numeric of date Cell's contents
  10397. as a String, in as close as we can to the way
  10398. that Excel would do so.
  10399. Uses the various format records to manage this.
  10400. TODO - move this to a central class in such a
  10401. way that hssf.usermodel can make use of it too
  10402. </member>
  10403. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.GetFormatString(System.Int32)">
  10404. Returns the format string, eg $##.##, for the
  10405. given number format index.
  10406. </member>
  10407. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.GetFormatString(NPOI.HSSF.Record.CellValueRecordInterface)">
  10408. Returns the format string, eg $##.##, used
  10409. by your cell
  10410. </member>
  10411. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.GetFormatIndex(NPOI.HSSF.Record.CellValueRecordInterface)">
  10412. Returns the index of the format string, used by your cell,
  10413. or -1 if none found
  10414. </member>
  10415. <member name="T:NPOI.HSSF.EventUserModel.HSSFEventFactory">
  10416. <summary>
  10417. Low level event based HSSF Reader. Pass either a DocumentInputStream to
  10418. Process events along with a request object or pass a POIFS POIFSFileSystem to
  10419. ProcessWorkbookEvents along with a request.
  10420. This will cause your file to be Processed a record at a time. Each record with
  10421. a static id matching one that you have registed in your HSSFRequest will be passed
  10422. to your associated HSSFListener.
  10423. @author Andrew C. Oliver (acoliver at apache dot org)
  10424. @author Carey Sublette (careysub@earthling.net)
  10425. </summary>
  10426. </member>
  10427. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.#ctor">
  10428. <summary>
  10429. Creates a new instance of HSSFEventFactory
  10430. </summary>
  10431. </member>
  10432. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.ProcessWorkbookEvents(NPOI.HSSF.EventUserModel.HSSFRequest,NPOI.POIFS.FileSystem.POIFSFileSystem)">
  10433. <summary>
  10434. Processes a file into essentially record events.
  10435. </summary>
  10436. <param name="req">an Instance of HSSFRequest which has your registered listeners</param>
  10437. <param name="fs">a POIFS filesystem containing your workbook</param>
  10438. </member>
  10439. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.AbortableProcessWorkbookEvents(NPOI.HSSF.EventUserModel.HSSFRequest,NPOI.POIFS.FileSystem.POIFSFileSystem)">
  10440. <summary>
  10441. Processes a file into essentially record events.
  10442. </summary>
  10443. <param name="req">an Instance of HSSFRequest which has your registered listeners</param>
  10444. <param name="fs">a POIFS filesystem containing your workbook</param>
  10445. <returns>numeric user-specified result code.</returns>
  10446. </member>
  10447. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.ProcessEvents(NPOI.HSSF.EventUserModel.HSSFRequest,System.IO.Stream)">
  10448. <summary>
  10449. Processes a DocumentInputStream into essentially Record events.
  10450. If an
  10451. <c>AbortableHSSFListener</c>
  10452. causes a halt to Processing during this call
  10453. the method will return just as with
  10454. <c>abortableProcessEvents</c>
  10455. , but no
  10456. user code or
  10457. <c>HSSFUserException</c>
  10458. will be passed back.
  10459. </summary>
  10460. <param name="req">an Instance of HSSFRequest which has your registered listeners</param>
  10461. <param name="in1">a DocumentInputStream obtained from POIFS's POIFSFileSystem object</param>
  10462. </member>
  10463. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.AbortableProcessEvents(NPOI.HSSF.EventUserModel.HSSFRequest,System.IO.Stream)">
  10464. <summary>
  10465. Processes a DocumentInputStream into essentially Record events.
  10466. </summary>
  10467. <param name="req">an Instance of HSSFRequest which has your registered listeners</param>
  10468. <param name="in1">a DocumentInputStream obtained from POIFS's POIFSFileSystem object</param>
  10469. <returns>numeric user-specified result code.</returns>
  10470. </member>
  10471. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.GenericProcessEvents(NPOI.HSSF.EventUserModel.HSSFRequest,NPOI.HSSF.Record.RecordInputStream)">
  10472. <summary>
  10473. Processes a DocumentInputStream into essentially Record events.
  10474. </summary>
  10475. <param name="req">an Instance of HSSFRequest which has your registered listeners</param>
  10476. <param name="in1">a DocumentInputStream obtained from POIFS's POIFSFileSystem object</param>
  10477. <returns>numeric user-specified result code.</returns>
  10478. </member>
  10479. <member name="T:NPOI.HSSF.EventUserModel.HSSFRecordStream">
  10480. <summary>
  10481. A stream based way to Get at complete records, with
  10482. as low a memory footprint as possible.
  10483. This handles Reading from a RecordInputStream, turning
  10484. the data into full records, Processing continue records
  10485. etc.
  10486. Most users should use HSSFEventFactory
  10487. HSSFListener and have new records pushed to
  10488. them, but this does allow for a "pull" style of coding.
  10489. </summary>
  10490. </member>
  10491. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.hitEOS">
  10492. Have we run out of records on the stream?
  10493. </member>
  10494. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.complete">
  10495. Have we returned all the records there are?
  10496. </member>
  10497. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.bonusRecords">
  10498. Sometimes we end up with a bunch of
  10499. records. When we do, these should
  10500. be returned before the next normal
  10501. record Processing occurs (i.e. before
  10502. we Check for continue records and
  10503. return rec)
  10504. </member>
  10505. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.rec">
  10506. The next record to return, which may need to have its
  10507. continue records passed to it before we do
  10508. </member>
  10509. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.lastRec">
  10510. The most recent record that we gave to the user
  10511. </member>
  10512. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.lastDrawingRecord">
  10513. The most recent DrawingRecord seen
  10514. </member>
  10515. <member name="M:NPOI.HSSF.EventUserModel.HSSFRecordStream.NextRecord">
  10516. <summary>
  10517. Returns the next (complete) record from the
  10518. stream, or null if there are no more.
  10519. </summary>
  10520. <returns></returns>
  10521. </member>
  10522. <member name="M:NPOI.HSSF.EventUserModel.HSSFRecordStream.GetBonusRecord">
  10523. <summary>
  10524. If there are any "bonus" records, that should
  10525. be returned before Processing new ones,
  10526. grabs the next and returns it.
  10527. If not, returns null;
  10528. </summary>
  10529. <returns></returns>
  10530. </member>
  10531. <member name="M:NPOI.HSSF.EventUserModel.HSSFRecordStream.GetNextRecord">
  10532. <summary>
  10533. Returns the next available record, or null if
  10534. this pass didn't return a record that's
  10535. suitable for returning (eg was a continue record).
  10536. </summary>
  10537. <returns></returns>
  10538. </member>
  10539. <member name="T:NPOI.HSSF.EventUserModel.HSSFRequest">
  10540. <summary>
  10541. An HSSFRequest object should be constructed registering an instance or multiple
  10542. instances of HSSFListener with each Record.sid you wish to listen for.
  10543. @author Andrew C. Oliver (acoliver at apache dot org)
  10544. @author Carey Sublette (careysub@earthling.net)
  10545. </summary>
  10546. </member>
  10547. <member name="M:NPOI.HSSF.EventUserModel.HSSFRequest.#ctor">
  10548. <summary>
  10549. Creates a new instance of HSSFRequest
  10550. </summary>
  10551. </member>
  10552. <member name="M:NPOI.HSSF.EventUserModel.HSSFRequest.AddListener(NPOI.HSSF.EventUserModel.IHSSFListener,System.Int16)">
  10553. <summary>
  10554. Add an event listener for a particular record type. The trick Is you have to know
  10555. what the records are for or just start with our examples and build on them. Alternatively,
  10556. you CAN call AddListenerForAllRecords and you'll recieve ALL record events in one listener,
  10557. but if you like to squeeze every last byte of efficiency out of life you my not like this.
  10558. (its sure as heck what I plan to do)
  10559. </summary>
  10560. <param name="lsnr">for the event</param>
  10561. <param name="sid">identifier for the record type this Is the .sid static member on the individual records</param>
  10562. </member>
  10563. <member name="M:NPOI.HSSF.EventUserModel.HSSFRequest.AddListenerForAllRecords(NPOI.HSSF.EventUserModel.IHSSFListener)">
  10564. <summary>
  10565. This Is the equivilent of calling AddListener(myListener, sid) for EVERY
  10566. record in the org.apache.poi.hssf.record package. This Is for lazy
  10567. people like me. You can call this more than once with more than one listener, but
  10568. that seems like a bad thing to do from a practice-perspective Unless you have a
  10569. compelling reason to do so (like maybe you send the event two places or log it or
  10570. something?).
  10571. </summary>
  10572. <param name="lsnr">a single listener to associate with ALL records</param>
  10573. </member>
  10574. <member name="M:NPOI.HSSF.EventUserModel.HSSFRequest.ProcessRecord(NPOI.HSSF.Record.Record)">
  10575. <summary>
  10576. Called by HSSFEventFactory, passes the Record to each listener associated with
  10577. a record.sid.
  10578. Exception and return value Added 2002-04-19 by Carey Sublette
  10579. </summary>
  10580. <param name="rec">The record.</param>
  10581. <returns>numeric user-specified result code. If zero continue Processing.</returns>
  10582. </member>
  10583. <member name="T:NPOI.HSSF.EventUserModel.HSSFUserException">
  10584. <summary>
  10585. This exception Is provided as a way for API users to throw
  10586. exceptions from their event handling code. By doing so they
  10587. abort file Processing by the HSSFEventFactory and by
  10588. catching it from outside the HSSFEventFactory.ProcessEvents
  10589. method they can diagnose the cause for the abort.
  10590. The HSSFUserException supports a nested "reason"
  10591. throwable, i.e. an exception that caused this one to be thrown.
  10592. The HSSF package does not itself throw any of these
  10593. exceptions.
  10594. </summary>
  10595. <remarks>
  10596. @author Rainer Klute (klute@rainer-klute.de)
  10597. @author Carey Sublette (careysub@earthling.net)
  10598. </remarks>
  10599. </member>
  10600. <member name="M:NPOI.HSSF.EventUserModel.HSSFUserException.#ctor">
  10601. <summary>
  10602. Creates a new HSSFUserException
  10603. </summary>
  10604. </member>
  10605. <member name="M:NPOI.HSSF.EventUserModel.HSSFUserException.#ctor(System.String)">
  10606. <summary>
  10607. Creates a new HSSFUserException with a message
  10608. string.
  10609. </summary>
  10610. <param name="msg">The MSG.</param>
  10611. </member>
  10612. <member name="M:NPOI.HSSF.EventUserModel.HSSFUserException.#ctor(System.Exception)">
  10613. <summary>
  10614. Creates a new HSSFUserException with a reason.
  10615. </summary>
  10616. <param name="reason">The reason.</param>
  10617. </member>
  10618. <member name="M:NPOI.HSSF.EventUserModel.HSSFUserException.#ctor(System.String,System.Exception)">
  10619. <summary>
  10620. Creates a new HSSFUserException with a message string
  10621. and a reason.
  10622. </summary>
  10623. <param name="msg">The MSG.</param>
  10624. <param name="reason">The reason.</param>
  10625. </member>
  10626. <member name="T:NPOI.HSSF.EventUserModel.MissingRecordAwareHSSFListener">
  10627. <summary>
  10628. A HSSFListener which tracks rows and columns, and will
  10629. trigger your HSSFListener for all rows and cells,
  10630. even the ones that aren't actually stored in the file.
  10631. This allows your code to have a more "Excel" like
  10632. view of the data in the file, and not have to worry
  10633. (as much) about if a particular row/cell Is in the
  10634. file, or was skipped from being written as it was
  10635. blank.
  10636. </summary>
  10637. </member>
  10638. <member name="M:NPOI.HSSF.EventUserModel.MissingRecordAwareHSSFListener.#ctor(NPOI.HSSF.EventUserModel.IHSSFListener)">
  10639. <summary>
  10640. Constructs a new MissingRecordAwareHSSFListener, which
  10641. will fire ProcessRecord on the supplied child
  10642. HSSFListener for all Records, and missing records.
  10643. </summary>
  10644. <param name="listener">The HSSFListener to pass records on to</param>
  10645. </member>
  10646. <member name="M:NPOI.HSSF.EventUserModel.MissingRecordAwareHSSFListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  10647. <summary>
  10648. Process an HSSF Record. Called when a record occurs in an HSSF file.
  10649. </summary>
  10650. <param name="record"></param>
  10651. </member>
  10652. <member name="T:NPOI.HSSF.Extractor.EventBasedExcelExtractor">
  10653. <summary>
  10654. A text extractor for Excel files, that is based
  10655. on the hssf eventusermodel api.
  10656. It will typically use less memory than
  10657. ExcelExtractor, but may not provide
  10658. the same richness of formatting.
  10659. Returns the textual content of the file, suitable for
  10660. indexing by something like Lucene, but not really
  10661. intended for display to the user.
  10662. </summary>
  10663. </member>
  10664. <member name="T:NPOI.POIOLE2TextExtractor">
  10665. <summary>
  10666. Common Parent for OLE2 based Text Extractors
  10667. of POI Documents, such as .doc, .xls
  10668. You will typically find the implementation of
  10669. a given format's text extractor under NPOI.Format.Extractor
  10670. </summary>
  10671. <remarks>
  10672. @see org.apache.poi.hssf.extractor.ExcelExtractor
  10673. @see org.apache.poi.hslf.extractor.PowerPointExtractor
  10674. @see org.apache.poi.hdgf.extractor.VisioTextExtractor
  10675. @see org.apache.poi.hwpf.extractor.WordExtractor
  10676. </remarks>
  10677. </member>
  10678. <member name="M:NPOI.POIOLE2TextExtractor.#ctor(NPOI.POIDocument)">
  10679. <summary>
  10680. Creates a new text extractor for the given document
  10681. </summary>
  10682. <param name="document"></param>
  10683. </member>
  10684. <member name="P:NPOI.POIOLE2TextExtractor.DocSummaryInformation">
  10685. <summary>
  10686. Returns the document information metadata for the document
  10687. </summary>
  10688. <value>The doc summary information.</value>
  10689. </member>
  10690. <member name="P:NPOI.POIOLE2TextExtractor.SummaryInformation">
  10691. <summary>
  10692. Returns the summary information metadata for the document
  10693. </summary>
  10694. <value>The summary information.</value>
  10695. </member>
  10696. <member name="P:NPOI.POIOLE2TextExtractor.MetadataTextExtractor">
  10697. <summary>
  10698. Returns an HPSF powered text extractor for the
  10699. document properties metadata, such as title and author.
  10700. </summary>
  10701. <value></value>
  10702. </member>
  10703. <member name="M:NPOI.HSSF.Extractor.EventBasedExcelExtractor.TriggerExtraction">
  10704. <summary>
  10705. Triggers the extraction.
  10706. </summary>
  10707. <returns></returns>
  10708. </member>
  10709. <member name="P:NPOI.HSSF.Extractor.EventBasedExcelExtractor.DocSummaryInformation">
  10710. <summary>
  10711. Would return the document information metadata for the document,
  10712. if we supported it
  10713. </summary>
  10714. <value>The doc summary information.</value>
  10715. </member>
  10716. <member name="P:NPOI.HSSF.Extractor.EventBasedExcelExtractor.SummaryInformation">
  10717. <summary>
  10718. Would return the summary information metadata for the document,
  10719. if we supported it
  10720. </summary>
  10721. <value>The summary information.</value>
  10722. </member>
  10723. <member name="P:NPOI.HSSF.Extractor.EventBasedExcelExtractor.IncludeSheetNames">
  10724. <summary>
  10725. Should sheet names be included? Default is true
  10726. </summary>
  10727. <value>if set to <c>true</c> [include sheet names].</value>
  10728. </member>
  10729. <member name="P:NPOI.HSSF.Extractor.EventBasedExcelExtractor.FormulasNotResults">
  10730. <summary>
  10731. Should we return the formula itself, and not
  10732. the result it produces? Default is false
  10733. </summary>
  10734. <value>if set to <c>true</c> [formulas not results].</value>
  10735. </member>
  10736. <member name="P:NPOI.HSSF.Extractor.EventBasedExcelExtractor.Text">
  10737. <summary>
  10738. Retreives the text contents of the file
  10739. </summary>
  10740. <value>All the text from the document.</value>
  10741. </member>
  10742. <member name="M:NPOI.HSSF.Extractor.EventBasedExcelExtractor.TextListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  10743. <summary>
  10744. Process an HSSF Record. Called when a record occurs in an HSSF file.
  10745. </summary>
  10746. <param name="record"></param>
  10747. </member>
  10748. <member name="M:NPOI.HSSF.Extractor.EventBasedExcelExtractor.TextListener.FormatNumberDateCell(NPOI.HSSF.Record.CellValueRecordInterface,System.Double)">
  10749. <summary>
  10750. Formats a number or date cell, be that a real number, or the
  10751. answer to a formula
  10752. </summary>
  10753. <param name="cell">The cell.</param>
  10754. <param name="value">The value.</param>
  10755. <returns></returns>
  10756. </member>
  10757. <member name="T:NPOI.HSSF.Extractor.ExcelExtractor">
  10758. <summary>
  10759. A text extractor for Excel files.
  10760. Returns the textual content of the file, suitable for
  10761. indexing by something like Lucene, but not really
  10762. intended for display to the user.
  10763. </summary>
  10764. </member>
  10765. <member name="T:NPOI.SS.Extractor.IExcelExtractor">
  10766. Common interface for Excel text extractors, covering
  10767. HSSF and XSSF
  10768. </member>
  10769. <member name="P:NPOI.SS.Extractor.IExcelExtractor.Text">
  10770. Retreives the text contents of the file
  10771. </member>
  10772. <member name="M:NPOI.HSSF.Extractor.ExcelExtractor.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook)">
  10773. <summary>
  10774. Initializes a new instance of the <see cref="T:NPOI.HSSF.Extractor.ExcelExtractor"/> class.
  10775. </summary>
  10776. <param name="wb">The wb.</param>
  10777. </member>
  10778. <member name="M:NPOI.HSSF.Extractor.ExcelExtractor.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  10779. <summary>
  10780. Initializes a new instance of the <see cref="T:NPOI.HSSF.Extractor.ExcelExtractor"/> class.
  10781. </summary>
  10782. <param name="fs">The fs.</param>
  10783. </member>
  10784. <member name="M:NPOI.HSSF.Extractor.ExcelExtractor.ExtractHeaderFooter(NPOI.SS.UserModel.IHeaderFooter)">
  10785. <summary>
  10786. Extracts the header footer.
  10787. </summary>
  10788. <param name="hf">The header or footer</param>
  10789. <returns></returns>
  10790. </member>
  10791. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.IncludeHeaderFooter">
  10792. <summary>
  10793. Should header and footer be included? Default is true
  10794. </summary>
  10795. </member>
  10796. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.IncludeSheetNames">
  10797. <summary>
  10798. Should sheet names be included? Default is true
  10799. </summary>
  10800. <value>if set to <c>true</c> [include sheet names].</value>
  10801. </member>
  10802. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.FormulasNotResults">
  10803. <summary>
  10804. Should we return the formula itself, and not
  10805. the result it produces? Default is false
  10806. </summary>
  10807. <value>if set to <c>true</c> [formulas not results].</value>
  10808. </member>
  10809. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.IncludeCellComments">
  10810. <summary>
  10811. Should cell comments be included? Default is false
  10812. </summary>
  10813. <value>if set to <c>true</c> [include cell comments].</value>
  10814. </member>
  10815. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.IncludeBlankCells">
  10816. <summary>
  10817. Should blank cells be output? Default is to only
  10818. output cells that are present in the file and are
  10819. non-blank.
  10820. </summary>
  10821. <value>if set to <c>true</c> [include blank cells].</value>
  10822. </member>
  10823. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.Text">
  10824. <summary>
  10825. Retreives the text contents of the file
  10826. </summary>
  10827. <value>All the text from the document.</value>
  10828. </member>
  10829. <member name="T:NPOI.HSSF.Model.AbstractShape">
  10830. <summary>
  10831. An abstract shape Is the lowlevel model for a shape.
  10832. @author Glen Stampoultzis (glens at apache.org)
  10833. </summary>
  10834. </member>
  10835. <member name="M:NPOI.HSSF.Model.AbstractShape.CreateShape(NPOI.HSSF.UserModel.HSSFShape,System.Int32)">
  10836. <summary>
  10837. Create a new shape object used to Create the escher records.
  10838. </summary>
  10839. <param name="hssfShape">The simple shape this Is based on.</param>
  10840. <param name="shapeId">The shape id.</param>
  10841. <returns></returns>
  10842. </member>
  10843. <member name="M:NPOI.HSSF.Model.AbstractShape.CreateAnchor(NPOI.HSSF.UserModel.HSSFAnchor)">
  10844. <summary>
  10845. Creates an escher anchor record from a HSSFAnchor.
  10846. </summary>
  10847. <param name="userAnchor">The high level anchor to Convert.</param>
  10848. <returns>An escher anchor record.</returns>
  10849. </member>
  10850. <member name="M:NPOI.HSSF.Model.AbstractShape.AddStandardOptions(NPOI.HSSF.UserModel.HSSFShape,NPOI.DDF.EscherOptRecord)">
  10851. <summary>
  10852. Add standard properties to the opt record. These properties effect
  10853. all records.
  10854. </summary>
  10855. <param name="shape">The user model shape.</param>
  10856. <param name="opt">The opt record to Add the properties to.</param>
  10857. <returns>The number of options Added.</returns>
  10858. </member>
  10859. <member name="M:NPOI.HSSF.Model.AbstractShape.GetCmoObjectId(System.Int32)">
  10860. <summary>
  10861. Generate id for the CommonObjectDataSubRecord that stands behind this shape
  10862. </summary>
  10863. <param name="shapeId">shape id as generated by drawing manager</param>
  10864. <returns>object id that will be assigned to the Obj record</returns>
  10865. </member>
  10866. <member name="P:NPOI.HSSF.Model.AbstractShape.SpContainer">
  10867. <summary>
  10868. The shape container and it's children that can represent this
  10869. shape.
  10870. </summary>
  10871. <value>The sp container.</value>
  10872. </member>
  10873. <member name="P:NPOI.HSSF.Model.AbstractShape.ObjRecord">
  10874. <summary>
  10875. The object record that Is associated with this shape.
  10876. </summary>
  10877. <value>The obj record.</value>
  10878. </member>
  10879. <member name="M:NPOI.HSSF.Model.ComboboxShape.#ctor(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  10880. Creates the low evel records for a combobox.
  10881. @param hssfShape The highlevel shape.
  10882. @param shapeId The shape id to use for this shape.
  10883. </member>
  10884. <member name="M:NPOI.HSSF.Model.ComboboxShape.CreateObjRecord(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  10885. Creates the low level OBJ record for this shape.
  10886. </member>
  10887. <member name="M:NPOI.HSSF.Model.ComboboxShape.CreateSpContainer(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  10888. Generates the escher shape records for this shape.
  10889. </member>
  10890. <member name="T:NPOI.HSSF.Model.CommentShape">
  10891. <summary>
  10892. Represents a cell comment.
  10893. This class Converts highlevel model data from HSSFComment
  10894. to low-level records.
  10895. @author Yegor Kozlov
  10896. </summary>
  10897. </member>
  10898. <member name="T:NPOI.HSSF.Model.TextboxShape">
  10899. <summary>
  10900. Represents an textbox shape and Converts between the highlevel records
  10901. and lowlevel records for an oval.
  10902. @author Glen Stampoultzis (glens at apache.org)
  10903. </summary>
  10904. </member>
  10905. <member name="M:NPOI.HSSF.Model.TextboxShape.#ctor(NPOI.HSSF.UserModel.HSSFTextbox,System.Int32)">
  10906. <summary>
  10907. Creates the low evel records for a textbox.
  10908. </summary>
  10909. <param name="hssfShape">The highlevel shape.</param>
  10910. <param name="shapeId">The shape id to use for this shape.</param>
  10911. </member>
  10912. <member name="M:NPOI.HSSF.Model.TextboxShape.CreateObjRecord(NPOI.HSSF.UserModel.HSSFTextbox,System.Int32)">
  10913. <summary>
  10914. Creates the lowerlevel OBJ records for this shape.
  10915. </summary>
  10916. <param name="hssfShape">The HSSF shape.</param>
  10917. <param name="shapeId">The shape id.</param>
  10918. <returns></returns>
  10919. </member>
  10920. <member name="M:NPOI.HSSF.Model.TextboxShape.CreateSpContainer(NPOI.HSSF.UserModel.HSSFTextbox,System.Int32)">
  10921. <summary>
  10922. Creates the lowerlevel escher records for this shape.
  10923. </summary>
  10924. <param name="hssfShape">The HSSF shape.</param>
  10925. <param name="shapeId">The shape id.</param>
  10926. <returns></returns>
  10927. </member>
  10928. <member name="M:NPOI.HSSF.Model.TextboxShape.CreateTextObjectRecord(NPOI.HSSF.UserModel.HSSFTextbox,System.Int32)">
  10929. <summary>
  10930. Textboxes also have an extra TXO record associated with them that most
  10931. other shapes dont have.
  10932. </summary>
  10933. <param name="hssfShape">The HSSF shape.</param>
  10934. <param name="shapeId">The shape id.</param>
  10935. <returns></returns>
  10936. </member>
  10937. <member name="P:NPOI.HSSF.Model.TextboxShape.SpContainer">
  10938. <summary>
  10939. The shape container and it's children that can represent this
  10940. shape.
  10941. </summary>
  10942. <value></value>
  10943. </member>
  10944. <member name="P:NPOI.HSSF.Model.TextboxShape.ObjRecord">
  10945. <summary>
  10946. The object record that is associated with this shape.
  10947. </summary>
  10948. <value></value>
  10949. </member>
  10950. <member name="P:NPOI.HSSF.Model.TextboxShape.TextObjectRecord">
  10951. <summary>
  10952. The TextObject record that is associated with this shape.
  10953. </summary>
  10954. <value></value>
  10955. </member>
  10956. <member name="P:NPOI.HSSF.Model.TextboxShape.EscherTextbox">
  10957. <summary>
  10958. Gets the EscherTextbox record.
  10959. </summary>
  10960. <value>The EscherTextbox record.</value>
  10961. </member>
  10962. <member name="M:NPOI.HSSF.Model.CommentShape.#ctor(NPOI.HSSF.UserModel.HSSFComment,System.Int32)">
  10963. <summary>
  10964. Creates the low-level records for a comment.
  10965. </summary>
  10966. <param name="hssfShape">The highlevel shape.</param>
  10967. <param name="shapeId">The shape id to use for this shape.</param>
  10968. </member>
  10969. <member name="M:NPOI.HSSF.Model.CommentShape.CreateNoteRecord(NPOI.HSSF.UserModel.HSSFComment,System.Int32)">
  10970. <summary>
  10971. Creates the low level NoteRecord
  10972. which holds the comment attributes.
  10973. </summary>
  10974. <param name="shape">The shape.</param>
  10975. <param name="shapeId">The shape id.</param>
  10976. <returns></returns>
  10977. </member>
  10978. <member name="M:NPOI.HSSF.Model.CommentShape.AddStandardOptions(NPOI.HSSF.UserModel.HSSFShape,NPOI.DDF.EscherOptRecord)">
  10979. <summary>
  10980. Sets standard escher options for a comment.
  10981. This method is responsible for Setting default background,
  10982. shading and other comment properties.
  10983. </summary>
  10984. <param name="shape">The highlevel shape.</param>
  10985. <param name="opt">The escher records holding the proerties</param>
  10986. <returns>The number of escher options added</returns>
  10987. </member>
  10988. <member name="P:NPOI.HSSF.Model.CommentShape.NoteRecord">
  10989. <summary>
  10990. Gets the NoteRecord holding the comment attributes
  10991. </summary>
  10992. <value>The NoteRecord</value>
  10993. </member>
  10994. <member name="M:NPOI.HSSF.Model.ConvertAnchor.CreateAnchor(NPOI.HSSF.UserModel.HSSFAnchor)">
  10995. <summary>
  10996. Creates the anchor.
  10997. </summary>
  10998. <param name="userAnchor">The user anchor.</param>
  10999. <returns></returns>
  11000. </member>
  11001. <member name="T:NPOI.HSSF.Model.DrawingManager">
  11002. Provides utilities to manage drawing Groups.
  11003. @author Glen Stampoultzis (glens at apache.org)
  11004. </member>
  11005. <member name="M:NPOI.HSSF.Model.DrawingManager.AllocateShapeId(System.Int16)">
  11006. Allocates new shape id for the new drawing Group id.
  11007. @return a new shape id.
  11008. </member>
  11009. <member name="T:NPOI.HSSF.Model.DrawingManager2">
  11010. <summary>
  11011. Provides utilities to manage drawing Groups.
  11012. </summary>
  11013. <remarks>
  11014. Glen Stampoultzis (glens at apache.org)
  11015. </remarks>
  11016. </member>
  11017. <member name="M:NPOI.HSSF.Model.DrawingManager2.ClearDrawingGroups">
  11018. <summary>
  11019. Clears the cached list of drawing Groups
  11020. </summary>
  11021. </member>
  11022. <member name="M:NPOI.HSSF.Model.DrawingManager2.AllocateShapeId(System.Int16)">
  11023. <summary>
  11024. Allocates new shape id for the new drawing Group id.
  11025. </summary>
  11026. <param name="drawingGroupId"></param>
  11027. <returns>a new shape id.</returns>
  11028. </member>
  11029. <member name="M:NPOI.HSSF.Model.DrawingManager2.AllocateShapeId(System.Int16,NPOI.DDF.EscherDgRecord)">
  11030. <summary>
  11031. Allocates new shape id for the new drawing group id.
  11032. </summary>
  11033. <param name="drawingGroupId"></param>
  11034. <param name="dg"></param>
  11035. <returns>a new shape id.</returns>
  11036. </member>
  11037. <member name="M:NPOI.HSSF.Model.DrawingManager2.FindNewDrawingGroupId">
  11038. <summary>
  11039. Finds the next available (1 based) drawing Group id
  11040. </summary>
  11041. <returns></returns>
  11042. </member>
  11043. <member name="T:NPOI.HSSF.Model.HSSFFormulaParser">
  11044. HSSF wrapper for the {@link FormulaParser} and {@link FormulaRenderer}
  11045. @author Josh Micich
  11046. </member>
  11047. <member name="M:NPOI.HSSF.Model.HSSFFormulaParser.Parse(System.String,NPOI.HSSF.UserModel.HSSFWorkbook)">
  11048. Convenience method for parsing cell formulas. see {@link #parse(String, HSSFWorkbook, int)}
  11049. </member>
  11050. <member name="M:NPOI.HSSF.Model.HSSFFormulaParser.Parse(System.String,NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.SS.Formula.FormulaType)">
  11051. @param formulaType a constant from {@link FormulaType}
  11052. @return the parsed formula tokens
  11053. </member>
  11054. <member name="M:NPOI.HSSF.Model.HSSFFormulaParser.Parse(System.String,NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.SS.Formula.FormulaType,System.Int32)">
  11055. @param formula the formula to parse
  11056. @param workbook the parent workbook
  11057. @param formulaType a constant from {@link FormulaType}
  11058. @param sheetIndex the 0-based index of the sheet this formula belongs to.
  11059. The sheet index is required to resolve sheet-level names. <code>-1</code> means that
  11060. the scope of the name will be ignored and the parser will match named ranges only by name
  11061. @return the parsed formula tokens
  11062. </member>
  11063. <member name="M:NPOI.HSSF.Model.HSSFFormulaParser.ToFormulaString(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.SS.Formula.PTG.Ptg[])">
  11064. Static method to convert an array of {@link Ptg}s in RPN order
  11065. to a human readable string format in infix mode.
  11066. @param book used for defined names and 3D references
  11067. @param ptgs must not be <c>null</c>
  11068. @return a human readable String
  11069. </member>
  11070. <member name="T:NPOI.HSSF.Model.LineShape">
  11071. <summary>
  11072. Represents a line shape and Creates all the line specific low level records.
  11073. @author Glen Stampoultzis (glens at apache.org)
  11074. </summary>
  11075. </member>
  11076. <member name="M:NPOI.HSSF.Model.LineShape.#ctor(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  11077. <summary>
  11078. Creates the line shape from the highlevel user shape. All low level
  11079. records are Created at this point.
  11080. </summary>
  11081. <param name="hssfShape">The user model shape</param>
  11082. <param name="shapeId">The identifier to use for this shape.</param>
  11083. </member>
  11084. <member name="M:NPOI.HSSF.Model.LineShape.CreateSpContainer(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  11085. <summary>
  11086. Creates the lowerlevel escher records for this shape.
  11087. </summary>
  11088. <param name="hssfShape">The HSSF shape.</param>
  11089. <param name="shapeId">The shape id.</param>
  11090. <returns></returns>
  11091. </member>
  11092. <member name="M:NPOI.HSSF.Model.LineShape.CreateObjRecord(NPOI.HSSF.UserModel.HSSFShape,System.Int32)">
  11093. <summary>
  11094. Creates the low level OBJ record for this shape.
  11095. </summary>
  11096. <param name="hssfShape">The HSSF shape.</param>
  11097. <param name="shapeId">The shape id.</param>
  11098. <returns></returns>
  11099. </member>
  11100. <member name="P:NPOI.HSSF.Model.LineShape.SpContainer">
  11101. <summary>
  11102. The shape container and it's children that can represent this
  11103. shape.
  11104. </summary>
  11105. <value></value>
  11106. </member>
  11107. <member name="P:NPOI.HSSF.Model.LineShape.ObjRecord">
  11108. <summary>
  11109. The object record that is associated with this shape.
  11110. </summary>
  11111. <value></value>
  11112. </member>
  11113. <member name="T:NPOI.HSSF.Model.LinkTable">
  11114. Link Table (OOO pdf reference: 4.10.3 ) <p/>
  11115. The main data of all types of references is stored in the Link Table inside the Workbook Globals
  11116. Substream (4.2.5). The Link Table itself is optional and occurs only, if there are any
  11117. references in the document.
  11118. <p/>
  11119. In BIFF8 the Link Table consists of
  11120. <ul>
  11121. <li>zero or more EXTERNALBOOK Blocks<p/>
  11122. each consisting of
  11123. <ul>
  11124. <li>exactly one EXTERNALBOOK (0x01AE) record</li>
  11125. <li>zero or more EXTERNALNAME (0x0023) records</li>
  11126. <li>zero or more CRN Blocks<p/>
  11127. each consisting of
  11128. <ul>
  11129. <li>exactly one XCT (0x0059)record</li>
  11130. <li>zero or more CRN (0x005A) records (documentation says one or more)</li>
  11131. </ul>
  11132. </li>
  11133. </ul>
  11134. </li>
  11135. <li>zero or one EXTERNSHEET (0x0017) record</li>
  11136. <li>zero or more DEFINEDNAME (0x0018) records</li>
  11137. </ul>
  11138. @author Josh Micich
  11139. </member>
  11140. <member name="M:NPOI.HSSF.Model.LinkTable.GetFirstInternalSheetIndexForExtIndex(System.Int32)">
  11141. @param extRefIndex as from a {@link Ref3DPtg} or {@link Area3DPtg}
  11142. @return -1 if the reference is to an external book
  11143. </member>
  11144. <member name="M:NPOI.HSSF.Model.LinkTable.GetLastInternalSheetIndexForExtIndex(System.Int32)">
  11145. @param extRefIndex as from a {@link Ref3DPtg} or {@link Area3DPtg}
  11146. @return -1 if the reference is to an external book
  11147. </member>
  11148. <member name="M:NPOI.HSSF.Model.LinkTable.GetNameXPtg(System.String,System.Int32)">
  11149. Finds the external name definition for the given name,
  11150. optionally restricted by externsheet index, and returns
  11151. (if found) as a NameXPtg.
  11152. @param sheetRefIndex The Extern Sheet Index to look for, or -1 if any
  11153. </member>
  11154. <member name="M:NPOI.HSSF.Model.LinkTable.AddNameXPtg(System.String)">
  11155. Register an external name in this workbook
  11156. @param name the name to register
  11157. @return a NameXPtg describing this name
  11158. </member>
  11159. <member name="M:NPOI.HSSF.Model.LinkTable.FindFirstRecordLocBySid(System.Int16)">
  11160. copied from Workbook
  11161. </member>
  11162. <member name="M:NPOI.HSSF.Model.LinkTable.ChangeExternalReference(System.String,System.String)">
  11163. Changes an external referenced file to another file.
  11164. A formular in Excel which refers a cell in another file is saved in two parts:
  11165. The referenced file is stored in an reference table. the row/cell information is saved separate.
  11166. This method invokation will only change the reference in the lookup-table itself.
  11167. @param oldUrl The old URL to search for and which is to be replaced
  11168. @param newUrl The URL replacement
  11169. @return true if the oldUrl was found and replaced with newUrl. Otherwise false
  11170. </member>
  11171. <member name="P:NPOI.HSSF.Model.LinkTable.RecordCount">
  11172. TODO - would not be required if calling code used RecordStream or similar
  11173. </member>
  11174. <member name="M:NPOI.HSSF.Model.LinkTable.ExternalBookBlock.#ctor">
  11175. Create a new block for registering add-in functions
  11176. @see org.apache.poi.hssf.model.LinkTable#addNameXPtg(String)
  11177. </member>
  11178. <member name="M:NPOI.HSSF.Model.LinkTable.ExternalBookBlock.#ctor(System.String,System.String[])">
  11179. Create a new block for external references.
  11180. </member>
  11181. <member name="M:NPOI.HSSF.Model.LinkTable.ExternalBookBlock.#ctor(System.Int32)">
  11182. Create a new block for internal references. It is called when constructing a new LinkTable.
  11183. @see org.apache.poi.hssf.model.LinkTable#LinkTable(int, WorkbookRecordList)
  11184. </member>
  11185. <member name="M:NPOI.HSSF.Model.LinkTable.ExternalBookBlock.GetIndexOfName(System.String)">
  11186. Performs case-insensitive search
  11187. @return -1 if not found
  11188. </member>
  11189. <member name="T:NPOI.HSSF.Model.ParseNode">
  11190. Represents a syntactic element from a formula by encapsulating the corresponding <c>Ptg</c>
  11191. token. Each <c>ParseNode</c> may have child <c>ParseNode</c>s in the case when the wrapped
  11192. <c>Ptg</c> is non-atomic.
  11193. @author Josh Micich
  11194. </member>
  11195. <member name="M:NPOI.HSSF.Model.ParseNode.ToTokenArray(NPOI.HSSF.Model.ParseNode)">
  11196. <summary>
  11197. Collects the array of Ptg
  11198. tokens for the specified tree.
  11199. </summary>
  11200. <param name="rootNode">The root node.</param>
  11201. <returns></returns>
  11202. </member>
  11203. <member name="M:NPOI.HSSF.Model.ParseNode.CollectIfPtgs(NPOI.HSSF.Model.ParseNode.TokenCollector)">
  11204. <summary>
  11205. The IF() function Gets marked up with two or three tAttr tokens.
  11206. Similar logic will be required for CHOOSE() when it is supported
  11207. See excelfileformat.pdf sec 3.10.5 "tAttr (19H)
  11208. </summary>
  11209. <param name="temp">The temp.</param>
  11210. </member>
  11211. <member name="T:NPOI.HSSF.Model.PictureShape">
  11212. <summary>
  11213. Represents a picture shape and Creates all specific low level records.
  11214. @author Glen Stampoultzis (glens at apache.org)
  11215. </summary>
  11216. </member>
  11217. <member name="M:NPOI.HSSF.Model.PictureShape.#ctor(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  11218. <summary>
  11219. Creates the line shape from the highlevel user shape. All low level
  11220. records are Created at this point.
  11221. </summary>
  11222. <param name="hssfShape">The user model shape.</param>
  11223. <param name="shapeId">The identifier to use for this shape.</param>
  11224. </member>
  11225. <member name="M:NPOI.HSSF.Model.PictureShape.CreateSpContainer(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  11226. <summary>
  11227. Creates the lowerlevel escher records for this shape.
  11228. </summary>
  11229. <param name="hssfShape">The HSSF shape.</param>
  11230. <param name="shapeId">The shape id.</param>
  11231. <returns></returns>
  11232. </member>
  11233. <member name="M:NPOI.HSSF.Model.PictureShape.CreateObjRecord(NPOI.HSSF.UserModel.HSSFShape,System.Int32)">
  11234. <summary>
  11235. Creates the low level OBJ record for this shape.
  11236. </summary>
  11237. <param name="hssfShape">The HSSFShape.</param>
  11238. <param name="shapeId">The shape id.</param>
  11239. <returns></returns>
  11240. </member>
  11241. <member name="P:NPOI.HSSF.Model.PictureShape.SpContainer">
  11242. <summary>
  11243. The shape container and it's children that can represent this
  11244. shape.
  11245. </summary>
  11246. <value></value>
  11247. </member>
  11248. <member name="P:NPOI.HSSF.Model.PictureShape.ObjRecord">
  11249. <summary>
  11250. The object record that is associated with this shape.
  11251. </summary>
  11252. <value></value>
  11253. </member>
  11254. <member name="M:NPOI.HSSF.Model.PolygonShape.#ctor(NPOI.HSSF.UserModel.HSSFPolygon,System.Int32)">
  11255. <summary>
  11256. Creates the low evel records for an polygon.
  11257. </summary>
  11258. <param name="hssfShape">The highlevel shape.</param>
  11259. <param name="shapeId">The shape id to use for this shape.</param>
  11260. </member>
  11261. <member name="M:NPOI.HSSF.Model.PolygonShape.CreateSpContainer(NPOI.HSSF.UserModel.HSSFPolygon,System.Int32)">
  11262. <summary>
  11263. Creates the lowerlevel escher records for this shape.
  11264. </summary>
  11265. <param name="hssfShape">The HSSF shape.</param>
  11266. <param name="shapeId">The shape id.</param>
  11267. <returns></returns>
  11268. </member>
  11269. <member name="M:NPOI.HSSF.Model.PolygonShape.CreateObjRecord(NPOI.HSSF.UserModel.HSSFShape,System.Int32)">
  11270. <summary>
  11271. Creates the lowerlevel OBJ records for this shape.
  11272. </summary>
  11273. <param name="hssfShape">The HSSF shape.</param>
  11274. <param name="shapeId">The shape id.</param>
  11275. <returns></returns>
  11276. </member>
  11277. <member name="P:NPOI.HSSF.Model.PolygonShape.SpContainer">
  11278. <summary>
  11279. The shape container and it's children that can represent this
  11280. shape.
  11281. </summary>
  11282. <value></value>
  11283. </member>
  11284. <member name="P:NPOI.HSSF.Model.PolygonShape.ObjRecord">
  11285. <summary>
  11286. The object record that is associated with this shape.
  11287. </summary>
  11288. <value></value>
  11289. </member>
  11290. <member name="T:NPOI.HSSF.Model.RecordOrderer">
  11291. Finds correct insert positions for records in workbook streams<p/>
  11292. See OOO excelfileformat.pdf sec. 4.2.5 'Record Order in a BIFF8 Workbook Stream'
  11293. @author Josh Micich
  11294. </member>
  11295. <member name="M:NPOI.HSSF.Model.RecordOrderer.AddNewSheetRecord(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase},NPOI.HSSF.Record.RecordBase)">
  11296. Adds the specified new record in the correct place in sheet records list
  11297. </member>
  11298. <member name="M:NPOI.HSSF.Model.RecordOrderer.GetWorksheetProtectionBlockInsertPos(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  11299. <summary>
  11300. Finds the index where the protection block should be inserted
  11301. </summary>
  11302. <param name="records">the records for this sheet</param>
  11303. <returns></returns>
  11304. <remark>
  11305. + BOF
  11306. o INDEX
  11307. o Calculation Settings Block
  11308. o PRINTHEADERS
  11309. o PRINTGRIDLINES
  11310. o GRIDSET
  11311. o GUTS
  11312. o DEFAULTROWHEIGHT
  11313. o SHEETPR
  11314. o Page Settings Block
  11315. o Worksheet Protection Block
  11316. o DEFCOLWIDTH
  11317. oo COLINFO
  11318. o SORT
  11319. + DIMENSION
  11320. </remark>
  11321. </member>
  11322. <member name="M:NPOI.HSSF.Model.RecordOrderer.IsProtectionSubsequentRecord(System.Object)">
  11323. <summary>
  11324. These records may occur between the 'Worksheet Protection Block' and DIMENSION:
  11325. </summary>
  11326. <param name="rb"></param>
  11327. <returns></returns>
  11328. <remarks>
  11329. o DEFCOLWIDTH
  11330. oo COLINFO
  11331. o SORT
  11332. </remarks>
  11333. </member>
  11334. <member name="M:NPOI.HSSF.Model.RecordOrderer.FindInsertPosForNewCondFormatTable(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  11335. <summary>
  11336. Find correct position to add new CFHeader record
  11337. </summary>
  11338. <param name="records"></param>
  11339. <returns></returns>
  11340. </member>
  11341. <member name="M:NPOI.HSSF.Model.RecordOrderer.FindDataValidationTableInsertPos(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  11342. Finds the index where the sheet validations header record should be inserted
  11343. @param records the records for this sheet
  11344. + WINDOW2
  11345. o SCL
  11346. o PANE
  11347. oo SELECTION
  11348. o STANDARDWIDTH
  11349. oo MERGEDCELLS
  11350. o LABELRANGES
  11351. o PHONETICPR
  11352. o Conditional Formatting Table
  11353. o Hyperlink Table
  11354. o Data Validity Table
  11355. o SHEETLAYOUT
  11356. o SHEETPROTECTION
  11357. o RANGEPROTECTION
  11358. + EOF
  11359. </member>
  11360. <member name="M:NPOI.HSSF.Model.RecordOrderer.GetDimensionsIndex(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  11361. DIMENSIONS record is always present
  11362. </member>
  11363. <member name="M:NPOI.HSSF.Model.RecordOrderer.IsEndOfRowBlock(System.Int32)">
  11364. <summary>
  11365. if the specified record ID terminates a sequence of Row block records
  11366. It is assumed that at least one row or cell value record has been found prior to the current
  11367. record
  11368. </summary>
  11369. <param name="sid"></param>
  11370. <returns></returns>
  11371. </member>
  11372. <member name="M:NPOI.HSSF.Model.RecordOrderer.IsRowBlockRecord(System.Int32)">
  11373. <summary>
  11374. Whether the specified record id normally appears in the row blocks section of the sheet records
  11375. </summary>
  11376. <param name="sid"></param>
  11377. <returns></returns>
  11378. </member>
  11379. <member name="T:NPOI.HSSF.Model.RecordStream">
  11380. <summary>
  11381. Simplifies iteration over a sequence of Record objects.
  11382. @author Josh Micich
  11383. </summary>
  11384. </member>
  11385. <member name="M:NPOI.HSSF.Model.RecordStream.HasNext">
  11386. <summary>
  11387. Determines whether this instance has next.
  11388. </summary>
  11389. <returns>
  11390. <c>true</c> if this instance has next; otherwise, <c>false</c>.
  11391. </returns>
  11392. </member>
  11393. <member name="M:NPOI.HSSF.Model.RecordStream.GetNext">
  11394. <summary>
  11395. Gets the next record
  11396. </summary>
  11397. <returns></returns>
  11398. </member>
  11399. <member name="M:NPOI.HSSF.Model.RecordStream.PeekNextSid">
  11400. <summary>
  11401. Peeks the next sid.
  11402. </summary>
  11403. <returns>-1 if at end of records</returns>
  11404. </member>
  11405. <member name="M:NPOI.HSSF.Model.RecordStream.PeekNextClass">
  11406. <summary>
  11407. Peeks the next class.
  11408. </summary>
  11409. <returns>the class of the next Record.return null if this stream Is exhausted.</returns>
  11410. </member>
  11411. <member name="T:NPOI.HSSF.Model.RowBlocksReader">
  11412. Segregates the 'Row Blocks' section of a single sheet into plain row/cell records and
  11413. shared formula records.
  11414. @author Josh Micich
  11415. </member>
  11416. <member name="M:NPOI.HSSF.Model.RowBlocksReader.#ctor(NPOI.HSSF.Model.RecordStream)">
  11417. Also collects any loose MergeCellRecords and puts them in the supplied
  11418. mergedCellsTable
  11419. </member>
  11420. <member name="P:NPOI.HSSF.Model.RowBlocksReader.LooseMergedCells">
  11421. Some unconventional apps place {@link MergeCellsRecord}s within the row block. They
  11422. actually should be in the {@link MergedCellsTable} which is much later (see bug 45699).
  11423. @return any loose <c>MergeCellsRecord</c>s found
  11424. </member>
  11425. <member name="P:NPOI.HSSF.Model.RowBlocksReader.PlainRecordStream">
  11426. @return a {@link RecordStream} containing all the non-{@link SharedFormulaRecord}
  11427. non-{@link ArrayRecord} and non-{@link TableRecord} Records.
  11428. </member>
  11429. <member name="T:NPOI.HSSF.Model.InternalSheet">
  11430. <summary>
  11431. Low level model implementation of a Sheet (one workbook Contains many sheets)
  11432. This file Contains the low level binary records starting at the sheets BOF and
  11433. ending with the sheets EOF. Use HSSFSheet for a high level representation.
  11434. The structures of the highlevel API use references to this to perform most of their
  11435. operations. Its probably Unwise to use these low level structures directly Unless you
  11436. really know what you're doing. I recommend you Read the Microsoft Excel 97 Developer's
  11437. Kit (Microsoft Press) and the documentation at http://sc.openoffice.org/excelfileformat.pdf
  11438. before even attempting to use this.
  11439. </summary>
  11440. <remarks>
  11441. @author Andrew C. Oliver (acoliver at apache dot org)
  11442. @author Glen Stampoultzis (glens at apache.org)
  11443. @author Shawn Laubach (slaubach at apache dot org) Gridlines, Headers, Footers, PrintSetup, and Setting Default Column Styles
  11444. @author Jason Height (jheight at chariot dot net dot au) Clone support. DBCell and Index Record writing support
  11445. @author Brian Sanders (kestrel at burdell dot org) Active Cell support
  11446. @author Jean-Pierre Paris (jean-pierre.paris at m4x dot org) (Just a little)
  11447. </remarks>
  11448. </member>
  11449. <member name="F:NPOI.HSSF.Model.InternalSheet._mergedCellsTable">
  11450. java object always present, but if empty no BIFF records are written
  11451. </member>
  11452. <member name="F:NPOI.HSSF.Model.InternalSheet._dimensions">
  11453. the DimensionsRecord is always present
  11454. </member>
  11455. <member name="F:NPOI.HSSF.Model.InternalSheet._isUncalced">
  11456. Add an UncalcedRecord if not true indicating formulas have not been calculated
  11457. </member>
  11458. <member name="M:NPOI.HSSF.Model.InternalSheet.CloneSheet">
  11459. <summary>
  11460. Clones the low level records of this sheet and returns the new sheet instance.
  11461. This method is implemented by Adding methods for deep cloning to all records that
  11462. can be Added to a sheet. The Record object does not implement Cloneable.
  11463. When Adding a new record, implement a public Clone method if and only if the record
  11464. belongs to a sheet.
  11465. </summary>
  11466. <returns></returns>
  11467. </member>
  11468. <member name="M:NPOI.HSSF.Model.InternalSheet.GetValueRecords">
  11469. <summary>
  11470. get the NEXT value record (from LOC). The first record that is a value record
  11471. (starting at LOC) will be returned.
  11472. This method is "loc" sensitive. Meaning you need to set LOC to where you
  11473. want it to start searching. If you don't know do this: setLoc(getDimsLoc).
  11474. When adding several rows you can just start at the last one by leaving loc
  11475. at what this sets it to. For this method, set loc to dimsloc to start with,
  11476. subsequent calls will return values in (physical) sequence or NULL when you get to the end.
  11477. </summary>
  11478. <returns>the next value record or NULL if there are no more</returns>
  11479. </member>
  11480. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSheet(NPOI.HSSF.Model.RecordStream)">
  11481. <summary>
  11482. Creates the sheet.
  11483. </summary>
  11484. <param name="rs">The stream.</param>
  11485. <returns></returns>
  11486. </member>
  11487. <member name="M:NPOI.HSSF.Model.InternalSheet.#ctor(NPOI.HSSF.Model.RecordStream)">
  11488. <summary>
  11489. Initializes a new instance of the <see cref="T:NPOI.HSSF.Model.InternalSheet"/> class.
  11490. </summary>
  11491. <param name="rs">The stream.</param>
  11492. </member>
  11493. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSheet">
  11494. <summary>
  11495. Creates a sheet with all the usual records minus values and the "index"
  11496. record (not required). Sets the location pointer to where the first value
  11497. records should go. Use this to Create a sheet from "scratch".
  11498. </summary>
  11499. <returns>Sheet object with all values Set to defaults</returns>
  11500. </member>
  11501. <member name="M:NPOI.HSSF.Model.InternalSheet.AddMergedRegion(System.Int32,System.Int32,System.Int32,System.Int32)">
  11502. <summary>
  11503. Adds the merged region.
  11504. </summary>
  11505. <param name="rowFrom">the row index From </param>
  11506. <param name="colFrom">The column index From.</param>
  11507. <param name="rowTo">The row index To</param>
  11508. <param name="colTo">The column To.</param>
  11509. <returns></returns>
  11510. </member>
  11511. <member name="M:NPOI.HSSF.Model.InternalSheet.RemoveMergedRegion(System.Int32)">
  11512. <summary>
  11513. Removes the merged region.
  11514. </summary>
  11515. <param name="index">The index.</param>
  11516. </member>
  11517. <member name="M:NPOI.HSSF.Model.InternalSheet.GetMergedRegionAt(System.Int32)">
  11518. <summary>
  11519. Gets the merged region at.
  11520. </summary>
  11521. <param name="index">The index.</param>
  11522. <returns></returns>
  11523. </member>
  11524. <member name="M:NPOI.HSSF.Model.InternalSheet.SetDimensions(System.Int32,System.Int16,System.Int32,System.Int16)">
  11525. <summary>
  11526. Per an earlier reported bug in working with Andy Khan's excel Read library. This
  11527. Sets the values in the sheet's DimensionsRecord object to be correct. Excel doesn't
  11528. really care, but we want to play nice with other libraries.
  11529. </summary>
  11530. <param name="firstrow">The first row.</param>
  11531. <param name="firstcol">The first column.</param>
  11532. <param name="lastrow">The last row.</param>
  11533. <param name="lastcol">The last column.</param>
  11534. </member>
  11535. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateRow(System.Int32)">
  11536. <summary>
  11537. Create a row record. (does not Add it to the records contained in this sheet)
  11538. </summary>
  11539. <param name="row">row number</param>
  11540. <returns>RowRecord Created for the passed in row number</returns>
  11541. </member>
  11542. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateLabelSST(System.Int32,System.Int16,System.Int32)">
  11543. <summary>
  11544. Create a LABELSST Record (does not Add it to the records contained in this sheet)
  11545. </summary>
  11546. <param name="row">the row the LabelSST Is a member of</param>
  11547. <param name="col">the column the LabelSST defines</param>
  11548. <param name="index">the index of the string within the SST (use workbook AddSSTString method)</param>
  11549. <returns>LabelSSTRecord newly Created containing your SST Index, row,col.</returns>
  11550. </member>
  11551. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateNumber(System.Int32,System.Int16,System.Double)">
  11552. <summary>
  11553. Create a NUMBER Record (does not Add it to the records contained in this sheet)
  11554. </summary>
  11555. <param name="row">the row the NumberRecord is a member of</param>
  11556. <param name="col">the column the NumberRecord defines</param>
  11557. <param name="value">value for the number record</param>
  11558. <returns>NumberRecord for that row, col containing that value as Added to the sheet</returns>
  11559. </member>
  11560. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateBlank(System.Int32,System.Int16)">
  11561. <summary>
  11562. Create a BLANK record (does not Add it to the records contained in this sheet)
  11563. </summary>
  11564. <param name="row">the row the BlankRecord is a member of</param>
  11565. <param name="col">the column the BlankRecord is a member of</param>
  11566. <returns></returns>
  11567. </member>
  11568. <member name="M:NPOI.HSSF.Model.InternalSheet.AddValueRecord(System.Int32,NPOI.HSSF.Record.CellValueRecordInterface)">
  11569. <summary>
  11570. Adds a value record to the sheet's contained binary records
  11571. (i.e. LabelSSTRecord or NumberRecord).
  11572. This method is "loc" sensitive. Meaning you need to Set LOC to where you
  11573. want it to start searching. If you don't know do this: SetLoc(GetDimsLoc).
  11574. When Adding several rows you can just start at the last one by leaving loc
  11575. at what this Sets it to.
  11576. </summary>
  11577. <param name="row">the row to Add the cell value to</param>
  11578. <param name="col">the cell value record itself.</param>
  11579. </member>
  11580. <member name="M:NPOI.HSSF.Model.InternalSheet.RemoveValueRecord(System.Int32,NPOI.HSSF.Record.CellValueRecordInterface)">
  11581. <summary>
  11582. Remove a value record from the records array.
  11583. This method is not loc sensitive, it Resets loc to = dimsloc so no worries.
  11584. </summary>
  11585. <param name="row">the row of the value record you wish to Remove</param>
  11586. <param name="col">a record supporting the CellValueRecordInterface.</param>
  11587. </member>
  11588. <member name="M:NPOI.HSSF.Model.InternalSheet.ReplaceValueRecord(NPOI.HSSF.Record.CellValueRecordInterface)">
  11589. <summary>
  11590. Replace a value record from the records array.
  11591. This method is not loc sensitive, it Resets loc to = dimsloc so no worries.
  11592. </summary>
  11593. <param name="newval">a record supporting the CellValueRecordInterface. this will Replace
  11594. the cell value with the same row and column. If there Isn't one, one will
  11595. be Added.</param>
  11596. </member>
  11597. <member name="M:NPOI.HSSF.Model.InternalSheet.AddRow(NPOI.HSSF.Record.RowRecord)">
  11598. <summary>
  11599. Adds a row record to the sheet
  11600. This method is "loc" sensitive. Meaning you need to Set LOC to where you
  11601. want it to start searching. If you don't know do this: SetLoc(GetDimsLoc).
  11602. When Adding several rows you can just start at the last one by leaving loc
  11603. at what this Sets it to.
  11604. </summary>
  11605. <param name="row">the row record to be Added</param>
  11606. </member>
  11607. <member name="M:NPOI.HSSF.Model.InternalSheet.RemoveRow(NPOI.HSSF.Record.RowRecord)">
  11608. <summary>
  11609. Removes a row record
  11610. This method is not loc sensitive, it Resets loc to = dimsloc so no worries.
  11611. </summary>
  11612. <param name="row">the row record to Remove</param>
  11613. </member>
  11614. <member name="M:NPOI.HSSF.Model.InternalSheet.GetRow(System.Int32)">
  11615. <summary>
  11616. Get the NEXT (from LOC) RowRecord where rownumber matches the given rownum.
  11617. The first record that is a Row record (starting at LOC) that has the
  11618. same rownum as the given rownum will be returned.
  11619. This method is "loc" sensitive. Meaning you need to Set LOC to where you
  11620. want it to start searching. If you don't know do this: SetLoc(GetDimsLoc).
  11621. When Adding several rows you can just start at the last one by leaving loc
  11622. at what this Sets it to. For this method, Set loc to dimsloc to start with.
  11623. subsequent calls will return rows in (physical) sequence or NULL when you Get to the end.
  11624. </summary>
  11625. <param name="rownum">which row to return (careful with LOC)</param>
  11626. <returns>RowRecord representing the next row record or NULL if there are no more</returns>
  11627. </member>
  11628. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateBOF">
  11629. <summary>
  11630. Creates the BOF record
  11631. </summary>
  11632. <returns>record containing a BOFRecord</returns>
  11633. </member>
  11634. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateIndex">
  11635. <summary>
  11636. Creates the Index record - not currently used
  11637. </summary>
  11638. <returns>record containing a IndexRecord</returns>
  11639. </member>
  11640. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateCalcMode">
  11641. <summary>
  11642. Creates the CalcMode record and Sets it to 1 (automatic formula caculation)
  11643. </summary>
  11644. <returns>record containing a CalcModeRecord</returns>
  11645. </member>
  11646. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateCalcCount">
  11647. <summary>
  11648. Creates the CalcCount record and Sets it to 0x64 (default number of iterations)
  11649. </summary>
  11650. <returns>record containing a CalcCountRecord</returns>
  11651. </member>
  11652. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateRefMode">
  11653. <summary>
  11654. Creates the RefMode record and Sets it to A1 Mode (default reference mode)
  11655. </summary>
  11656. <returns>record containing a RefModeRecord</returns>
  11657. </member>
  11658. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateIteration">
  11659. <summary>
  11660. Creates the Iteration record and Sets it to false (don't iteratively calculate formulas)
  11661. </summary>
  11662. <returns>record containing a IterationRecord</returns>
  11663. </member>
  11664. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateDelta">
  11665. <summary>
  11666. Creates the Delta record and Sets it to 0.0010 (default accuracy)
  11667. </summary>
  11668. <returns>record containing a DeltaRecord</returns>
  11669. </member>
  11670. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSaveRecalc">
  11671. <summary>
  11672. Creates the SaveRecalc record and Sets it to true (recalculate before saving)
  11673. </summary>
  11674. <returns>record containing a SaveRecalcRecord</returns>
  11675. </member>
  11676. <member name="M:NPOI.HSSF.Model.InternalSheet.CreatePrintHeaders">
  11677. <summary>
  11678. Creates the PrintHeaders record and Sets it to false (we don't Create headers yet so why print them)
  11679. </summary>
  11680. <returns>record containing a PrintHeadersRecord</returns>
  11681. </member>
  11682. <member name="M:NPOI.HSSF.Model.InternalSheet.CreatePrintGridlines">
  11683. <summary>
  11684. Creates the PrintGridlines record and Sets it to false (that makes for ugly sheets). As far as I can
  11685. tell this does the same thing as the GridsetRecord
  11686. </summary>
  11687. <returns>record containing a PrintGridlinesRecord</returns>
  11688. </member>
  11689. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateGridset">
  11690. <summary>
  11691. Creates the GridSet record and Sets it to true (user has mucked with the gridlines)
  11692. </summary>
  11693. <returns>record containing a GridsetRecord</returns>
  11694. </member>
  11695. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateGuts">
  11696. <summary>
  11697. Creates the Guts record and Sets leftrow/topcol guttter and rowlevelmax/collevelmax to 0
  11698. </summary>
  11699. <returns>record containing a GutsRecordRecord</returns>
  11700. </member>
  11701. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateDefaultRowHeight">
  11702. <summary>
  11703. Creates the DefaultRowHeight Record and Sets its options to 0 and rowheight to 0xff
  11704. </summary>
  11705. <see cref="T:NPOI.HSSF.Record.DefaultRowHeightRecord"/>
  11706. <see cref="T:NPOI.HSSF.Record.Record"/>
  11707. <returns>record containing a DefaultRowHeightRecord</returns>
  11708. </member>
  11709. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateWSBool">
  11710. Creates the WSBoolRecord and Sets its values to defaults
  11711. @see org.apache.poi.hssf.record.WSBoolRecord
  11712. @see org.apache.poi.hssf.record.Record
  11713. @return record containing a WSBoolRecord
  11714. </member>
  11715. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateHCenter">
  11716. Creates the HCenter Record and Sets it to false (don't horizontally center)
  11717. @see org.apache.poi.hssf.record.HCenterRecord
  11718. @see org.apache.poi.hssf.record.Record
  11719. @return record containing a HCenterRecord
  11720. </member>
  11721. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateVCenter">
  11722. Creates the VCenter Record and Sets it to false (don't horizontally center)
  11723. @see org.apache.poi.hssf.record.VCenterRecord
  11724. @see org.apache.poi.hssf.record.Record
  11725. @return record containing a VCenterRecord
  11726. </member>
  11727. <member name="M:NPOI.HSSF.Model.InternalSheet.CreatePrintSetup">
  11728. Creates the PrintSetup Record and Sets it to defaults and marks it invalid
  11729. @see org.apache.poi.hssf.record.PrintSetupRecord
  11730. @see org.apache.poi.hssf.record.Record
  11731. @return record containing a PrintSetupRecord
  11732. </member>
  11733. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateDefaultColWidth">
  11734. Creates the DefaultColWidth Record and Sets it to 8
  11735. @see org.apache.poi.hssf.record.DefaultColWidthRecord
  11736. @see org.apache.poi.hssf.record.Record
  11737. @return record containing a DefaultColWidthRecord
  11738. </member>
  11739. <member name="M:NPOI.HSSF.Model.InternalSheet.GetColumnWidth(System.Int32)">
  11740. Get the width of a given column in Units of 1/256th of a Char width
  11741. @param column index
  11742. @see org.apache.poi.hssf.record.DefaultColWidthRecord
  11743. @see org.apache.poi.hssf.record.ColumnInfoRecord
  11744. @see #SetColumnWidth(short,short)
  11745. @return column width in Units of 1/256th of a Char width
  11746. </member>
  11747. <member name="M:NPOI.HSSF.Model.InternalSheet.GetXFIndexForColAt(System.Int16)">
  11748. Get the index to the ExtendedFormatRecord "associated" with
  11749. the column at specified 0-based index. (In this case, an
  11750. ExtendedFormatRecord index is actually associated with a
  11751. ColumnInfoRecord which spans 1 or more columns)
  11752. <br/>
  11753. Returns the index to the default ExtendedFormatRecord (0xF)
  11754. if no ColumnInfoRecord exists that includes the column
  11755. index specified.
  11756. @param column
  11757. @return index of ExtendedFormatRecord associated with
  11758. ColumnInfoRecord that includes the column index or the
  11759. index of the default ExtendedFormatRecord (0xF)
  11760. </member>
  11761. <member name="M:NPOI.HSSF.Model.InternalSheet.SetColumnWidth(System.Int32,System.Int32)">
  11762. Set the width for a given column in 1/256th of a Char width Units
  11763. @param column - the column number
  11764. @param width (in Units of 1/256th of a Char width)
  11765. </member>
  11766. <member name="M:NPOI.HSSF.Model.InternalSheet.IsColumnHidden(System.Int32)">
  11767. Get the hidden property for a given column.
  11768. @param column index
  11769. @see org.apache.poi.hssf.record.DefaultColWidthRecord
  11770. @see org.apache.poi.hssf.record.ColumnInfoRecord
  11771. @see #SetColumnHidden(short,bool)
  11772. @return whether the column is hidden or not.
  11773. </member>
  11774. <member name="M:NPOI.HSSF.Model.InternalSheet.SetColumnHidden(System.Int32,System.Boolean)">
  11775. Get the hidden property for a given column.
  11776. @param column - the column number
  11777. @param hidden - whether the column is hidden or not
  11778. </member>
  11779. <member name="M:NPOI.HSSF.Model.InternalSheet.GroupColumnRange(System.Int32,System.Int32,System.Boolean)">
  11780. Creates an outline Group for the specified columns.
  11781. @param fromColumn Group from this column (inclusive)
  11782. @param toColumn Group to this column (inclusive)
  11783. @param indent if true the Group will be indented by one level,
  11784. if false indenting will be Removed by one level.
  11785. </member>
  11786. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateDimensions">
  11787. Creates the Dimensions Record and Sets it to bogus values (you should Set this yourself
  11788. or let the high level API do it for you)
  11789. @see org.apache.poi.hssf.record.DimensionsRecord
  11790. @see org.apache.poi.hssf.record.Record
  11791. @return record containing a DimensionsRecord
  11792. </member>
  11793. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateWindowTwo">
  11794. Creates the WindowTwo Record and Sets it to:
  11795. options = 0x6b6
  11796. toprow = 0
  11797. leftcol = 0
  11798. headercolor = 0x40
  11799. pagebreakzoom = 0x0
  11800. normalzoom = 0x0
  11801. @see org.apache.poi.hssf.record.WindowTwoRecord
  11802. @see org.apache.poi.hssf.record.Record
  11803. @return record containing a WindowTwoRecord
  11804. </member>
  11805. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSelection">
  11806. <summary>
  11807. Creates the Selection record and Sets it to nothing selected
  11808. </summary>
  11809. <returns>record containing a SelectionRecord</returns>
  11810. </member>
  11811. <member name="M:NPOI.HSSF.Model.InternalSheet.SetActiveCell(System.Int32,System.Int32)">
  11812. <summary>
  11813. Sets the active cell.
  11814. </summary>
  11815. <param name="row">The row.</param>
  11816. <param name="column">The column.</param>
  11817. </member>
  11818. <member name="M:NPOI.HSSF.Model.InternalSheet.SetActiveCellRange(System.Int32,System.Int32,System.Int32,System.Int32)">
  11819. <summary>
  11820. Sets the active cell range.
  11821. </summary>
  11822. <param name="firstRow">The firstrow.</param>
  11823. <param name="lastRow">The lastrow.</param>
  11824. <param name="firstColumn">The firstcolumn.</param>
  11825. <param name="lastColumn">The lastcolumn.</param>
  11826. </member>
  11827. <member name="M:NPOI.HSSF.Model.InternalSheet.SetActiveCellRange(System.Collections.Generic.List{NPOI.SS.Util.CellRangeAddress8Bit},System.Int32,System.Int32,System.Int32)">
  11828. <summary>
  11829. Sets the active cell range.
  11830. </summary>
  11831. <param name="cellranges">The cellranges.</param>
  11832. <param name="activeRange">The index of the active range.</param>
  11833. <param name="activeRow">The active row in the active range</param>
  11834. <param name="activeColumn">The active column in the active range</param>
  11835. </member>
  11836. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateEOF">
  11837. <summary>
  11838. Creates the EOF record
  11839. </summary>
  11840. <returns>record containing a EOFRecord</returns>
  11841. </member>
  11842. <member name="M:NPOI.HSSF.Model.InternalSheet.FindFirstRecordBySid(System.Int16)">
  11843. <summary>
  11844. Returns the first occurance of a record matching a particular sid.
  11845. </summary>
  11846. <param name="sid">The sid.</param>
  11847. <returns></returns>
  11848. </member>
  11849. <member name="M:NPOI.HSSF.Model.InternalSheet.SetSCLRecord(NPOI.HSSF.Record.SCLRecord)">
  11850. <summary>
  11851. Sets the SCL record or Creates it in the correct place if it does not
  11852. already exist.
  11853. </summary>
  11854. <param name="sclRecord">The record to set.</param>
  11855. </member>
  11856. <member name="M:NPOI.HSSF.Model.InternalSheet.FindFirstRecordLocBySid(System.Int16)">
  11857. Finds the first occurance of a record matching a particular sid and
  11858. returns it's position.
  11859. @param sid the sid to search for
  11860. @return the record position of the matching record or -1 if no match
  11861. is made.
  11862. </member>
  11863. <member name="M:NPOI.HSSF.Model.InternalSheet.SetSelected(System.Boolean)">
  11864. Sets whether the sheet is selected
  11865. @param sel True to select the sheet, false otherwise.
  11866. </member>
  11867. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateFreezePane(System.Int32,System.Int32,System.Int32,System.Int32)">
  11868. Creates a split (freezepane). Any existing freezepane or split pane Is overwritten.
  11869. @param colSplit Horizonatal position of split.
  11870. @param rowSplit Vertical position of split.
  11871. @param topRow Top row visible in bottom pane
  11872. @param leftmostColumn Left column visible in right pane.
  11873. </member>
  11874. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSplitPane(System.Int32,System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  11875. Creates a split pane. Any existing freezepane or split pane is overwritten.
  11876. @param xSplitPos Horizonatal position of split (in 1/20th of a point).
  11877. @param ySplitPos Vertical position of split (in 1/20th of a point).
  11878. @param topRow Top row visible in bottom pane
  11879. @param leftmostColumn Left column visible in right pane.
  11880. @param activePane Active pane. One of: PANE_LOWER_RIGHT,
  11881. PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT
  11882. @see #PANE_LOWER_LEFT
  11883. @see #PANE_LOWER_RIGHT
  11884. @see #PANE_UPPER_LEFT
  11885. @see #PANE_UPPER_RIGHT
  11886. </member>
  11887. <member name="M:NPOI.HSSF.Model.InternalSheet.CreatePassword">
  11888. creates a Password record with password set to 00.
  11889. </member>
  11890. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateProtect">
  11891. creates a Protect record with protect set to false.
  11892. </member>
  11893. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateObjectProtect">
  11894. Creates an ObjectProtect record with protect Set to false.
  11895. @see org.apache.poi.hssf.record.ObjectProtectRecord
  11896. @see org.apache.poi.hssf.record.Record
  11897. @return an ObjectProtectRecord
  11898. </member>
  11899. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateScenarioProtect">
  11900. Creates a ScenarioProtect record with protect Set to false.
  11901. @see org.apache.poi.hssf.record.ScenarioProtectRecord
  11902. @see org.apache.poi.hssf.record.Record
  11903. @return a ScenarioProtectRecord
  11904. </member>
  11905. <member name="M:NPOI.HSSF.Model.InternalSheet.AggregateDrawingRecords(NPOI.HSSF.Model.DrawingManager2,System.Boolean)">
  11906. <summary>
  11907. Finds the DrawingRecord for our sheet, and attaches it to the DrawingManager (which knows about
  11908. the overall DrawingGroup for our workbook).
  11909. If requested, will Create a new DrawRecord if none currently exist
  11910. </summary>
  11911. <param name="drawingManager">The DrawingManager2 for our workbook</param>
  11912. <param name="CreateIfMissing">Should one be Created if missing?</param>
  11913. <returns>location of EscherAggregate record. if no EscherAggregate record is found return -1</returns>
  11914. </member>
  11915. <member name="M:NPOI.HSSF.Model.InternalSheet.Preserialize">
  11916. Perform any work necessary before the sheet is about to be Serialized.
  11917. For instance the escher aggregates size needs to be calculated before
  11918. serialization so that the dgg record (which occurs first) can be written.
  11919. </member>
  11920. <member name="M:NPOI.HSSF.Model.InternalSheet.ShiftBreaks(NPOI.HSSF.Record.PageBreakRecord,System.Int16,System.Int16,System.Int32)">
  11921. Shifts all the page breaks in the range "count" number of rows/columns
  11922. @param breaks The page record to be Shifted
  11923. @param start Starting "main" value to Shift breaks
  11924. @param stop Ending "main" value to Shift breaks
  11925. @param count number of Units (rows/columns) to Shift by
  11926. </member>
  11927. <member name="M:NPOI.HSSF.Model.InternalSheet.ShiftRowBreaks(System.Int32,System.Int32,System.Int32)">
  11928. Shifts the horizontal page breaks for the indicated count
  11929. @param startingRow
  11930. @param endingRow
  11931. @param count
  11932. </member>
  11933. <member name="M:NPOI.HSSF.Model.InternalSheet.ShiftColumnBreaks(System.Int16,System.Int16,System.Int16)">
  11934. Shifts the vertical page breaks for the indicated count
  11935. @param startingCol
  11936. @param endingCol
  11937. @param count
  11938. </member>
  11939. <member name="M:NPOI.HSSF.Model.InternalSheet.UpdateFormulasAfterCellShift(NPOI.SS.Formula.FormulaShifter,System.Int32)">
  11940. Updates formulas in cells and conditional formats due to moving of cells
  11941. @param externSheetIndex the externSheet index of this sheet
  11942. </member>
  11943. <member name="M:NPOI.HSSF.Model.InternalSheet.GetSizeOfInitialSheetRecords(System.Int32)">
  11944. 'initial sheet records' are between INDEX and the 'Row Blocks'
  11945. @param bofRecordIndex index of record after which INDEX record is to be placed
  11946. @return count of bytes from end of INDEX record to first ROW record.
  11947. </member>
  11948. <member name="M:NPOI.HSSF.Model.InternalSheet.GetNoteRecords">
  11949. Get the {@link NoteRecord}s (related to cell comments) for this sheet
  11950. @return never <code>null</code>, typically empty array
  11951. </member>
  11952. <member name="P:NPOI.HSSF.Model.InternalSheet.ColumnInfos">
  11953. <summary>
  11954. Gets the column infos.
  11955. </summary>
  11956. <value>The column infos.</value>
  11957. </member>
  11958. <member name="P:NPOI.HSSF.Model.InternalSheet.NumMergedRegions">
  11959. <summary>
  11960. Gets the number of merged regions.
  11961. </summary>
  11962. <value>The number merged regions.</value>
  11963. </member>
  11964. <member name="P:NPOI.HSSF.Model.InternalSheet.NumConditionalFormattings">
  11965. <summary>
  11966. Gets the number of conditional formattings.
  11967. </summary>
  11968. <value>The number of conditional formattings.</value>
  11969. </member>
  11970. <member name="P:NPOI.HSSF.Model.InternalSheet.PreOffset">
  11971. <summary>
  11972. Gets or Sets the preoffset when using DBCELL records (currently Unused) - this Is
  11973. the position of this sheet within the whole file.
  11974. </summary>
  11975. <value>the offset of the sheet's BOF within the file.</value>
  11976. </member>
  11977. <member name="P:NPOI.HSSF.Model.InternalSheet.NextRow">
  11978. <summary>
  11979. Get the NEXT RowRecord (from LOC). The first record that is a Row record
  11980. (starting at LOC) will be returned.
  11981. This method is "loc" sensitive. Meaning you need to Set LOC to where you
  11982. want it to start searching. If you don't know do this: SetLoc(GetDimsLoc).
  11983. When Adding several rows you can just start at the last one by leaving loc
  11984. at what this Sets it to. For this method, Set loc to dimsloc to start with.
  11985. subsequent calls will return rows in (physical) sequence or NULL when you Get to the end.
  11986. </summary>
  11987. <value>RowRecord representing the next row record or NULL if there are no more</value>
  11988. </member>
  11989. <member name="P:NPOI.HSSF.Model.InternalSheet.PageSettings">
  11990. <summary>
  11991. Gets the page settings.
  11992. </summary>
  11993. <returns></returns>
  11994. </member>
  11995. <member name="P:NPOI.HSSF.Model.InternalSheet.DefaultColumnWidth">
  11996. Get the default column width for the sheet (if the columns do not define their own width)
  11997. @return default column width
  11998. </member>
  11999. <member name="P:NPOI.HSSF.Model.InternalSheet.DefaultRowHeight">
  12000. Get the default row height for the sheet (if the rows do not define their own height)
  12001. @return default row height
  12002. </member>
  12003. <member name="P:NPOI.HSSF.Model.InternalSheet.TopRow">
  12004. <summary>
  12005. Gets or sets the top row.
  12006. </summary>
  12007. <value>The top row.</value>
  12008. </member>
  12009. <member name="P:NPOI.HSSF.Model.InternalSheet.LeftCol">
  12010. <summary>
  12011. Gets or sets the left col.
  12012. </summary>
  12013. <value>The left col.</value>
  12014. </member>
  12015. <member name="P:NPOI.HSSF.Model.InternalSheet.ActiveCellRow">
  12016. <summary>
  12017. Returns the active row
  12018. </summary>
  12019. <value>the active row index</value>
  12020. @see org.apache.poi.hssf.record.SelectionRecord
  12021. </member>
  12022. <member name="P:NPOI.HSSF.Model.InternalSheet.ActiveCellCol">
  12023. <summary>
  12024. Gets the active cell col.
  12025. </summary>
  12026. <value>the active column index</value>
  12027. @see org.apache.poi.hssf.record.SelectionRecord
  12028. </member>
  12029. <member name="P:NPOI.HSSF.Model.InternalSheet.GridsetRecord">
  12030. <summary>
  12031. Gets the gridset record for this sheet.
  12032. </summary>
  12033. <value>The gridset record.</value>
  12034. </member>
  12035. <member name="P:NPOI.HSSF.Model.InternalSheet.Header">
  12036. <summary>
  12037. Gets or sets the header.
  12038. </summary>
  12039. <value>the HeaderRecord.</value>
  12040. </member>
  12041. <member name="P:NPOI.HSSF.Model.InternalSheet.IsAutoTabColor">
  12042. <summary>
  12043. Gets or sets a value indicating whether this instance is auto tab color.
  12044. </summary>
  12045. <value>
  12046. <c>true</c> if this instance is auto tab color; otherwise, <c>false</c>.
  12047. </value>
  12048. </member>
  12049. <member name="P:NPOI.HSSF.Model.InternalSheet.Footer">
  12050. <summary>
  12051. Gets or sets the footer.
  12052. </summary>
  12053. <value>FooterRecord for the sheet.</value>
  12054. </member>
  12055. <member name="P:NPOI.HSSF.Model.InternalSheet.PrintSetup">
  12056. Returns the PrintSetupRecord.
  12057. @return PrintSetupRecord for the sheet.
  12058. </member>
  12059. <member name="P:NPOI.HSSF.Model.InternalSheet.IsGridsPrinted">
  12060. @return <c>true</c> if gridlines are printed
  12061. </member>
  12062. <member name="P:NPOI.HSSF.Model.InternalSheet.PrintGridlines">
  12063. Returns the PrintGridlinesRecord.
  12064. @return PrintGridlinesRecord for the sheet.
  12065. </member>
  12066. <member name="P:NPOI.HSSF.Model.InternalSheet.PaneInformation">
  12067. Returns the information regarding the currently configured pane (split or freeze).
  12068. @return null if no pane configured, or the pane information.
  12069. </member>
  12070. <member name="P:NPOI.HSSF.Model.InternalSheet.DisplayGridlines">
  12071. Returns if gridlines are Displayed.
  12072. @return whether gridlines are Displayed
  12073. </member>
  12074. <member name="P:NPOI.HSSF.Model.InternalSheet.DisplayFormulas">
  12075. Returns if formulas are Displayed.
  12076. @return whether formulas are Displayed
  12077. </member>
  12078. <member name="P:NPOI.HSSF.Model.InternalSheet.DisplayRowColHeadings">
  12079. Returns if RowColHeadings are Displayed.
  12080. @return whether RowColHeadings are Displayed
  12081. </member>
  12082. <member name="P:NPOI.HSSF.Model.InternalSheet.IsUncalced">
  12083. @return whether an Uncalced record must be Inserted or not at generation
  12084. </member>
  12085. <member name="T:NPOI.Util.RecordFormatException">
  12086. A common exception thrown by our binary format Parsers
  12087. (especially HSSF and DDF), when they hit invalid
  12088. format or data when Processing a record.
  12089. </member>
  12090. <member name="M:NPOI.HSSF.Model.SimpleFilledShape.#ctor(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  12091. <summary>
  12092. Creates the low evel records for an oval.
  12093. </summary>
  12094. <param name="hssfShape">The highlevel shape.</param>
  12095. <param name="shapeId">The shape id to use for this shape.</param>
  12096. </member>
  12097. <member name="M:NPOI.HSSF.Model.SimpleFilledShape.CreateSpContainer(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  12098. <summary>
  12099. Creates the lowerlevel escher records for this shape.
  12100. </summary>
  12101. <param name="hssfShape">The HSSF shape.</param>
  12102. <param name="shapeId">The shape id.</param>
  12103. <returns></returns>
  12104. </member>
  12105. <member name="M:NPOI.HSSF.Model.SimpleFilledShape.CreateObjRecord(NPOI.HSSF.UserModel.HSSFShape,System.Int32)">
  12106. <summary>
  12107. Creates the lowerlevel OBJ records for this shape.
  12108. </summary>
  12109. <param name="hssfShape">The HSSF shape.</param>
  12110. <param name="shapeId">The shape id.</param>
  12111. <returns></returns>
  12112. </member>
  12113. <member name="P:NPOI.HSSF.Model.SimpleFilledShape.SpContainer">
  12114. <summary>
  12115. The shape container and it's children that can represent this
  12116. shape.
  12117. </summary>
  12118. <value></value>
  12119. </member>
  12120. <member name="P:NPOI.HSSF.Model.SimpleFilledShape.ObjRecord">
  12121. <summary>
  12122. The object record that is associated with this shape.
  12123. </summary>
  12124. <value></value>
  12125. </member>
  12126. <member name="T:NPOI.HSSF.Model.InternalWorkbook">
  12127. Low level model implementation of a Workbook. Provides creational methods
  12128. for Settings and objects contained in the workbook object.
  12129. This file Contains the low level binary records starting at the workbook's BOF and
  12130. ending with the workbook's EOF. Use HSSFWorkbook for a high level representation.
  12131. The structures of the highlevel API use references to this to perform most of their
  12132. operations. Its probably Unwise to use these low level structures directly Unless you
  12133. really know what you're doing. I recommend you Read the Microsoft Excel 97 Developer's
  12134. Kit (Microsoft Press) and the documentation at http://sc.openoffice.org/excelfileformat.pdf
  12135. before even attempting to use this.
  12136. @author Luc Girardin (luc dot girardin at macrofocus dot com)
  12137. @author Sergei Kozello (sergeikozello at mail.ru)
  12138. @author Shawn Laubach (slaubach at apache dot org) (Data Formats)
  12139. @author Andrew C. Oliver (acoliver at apache dot org)
  12140. @author Brian Sanders (bsanders at risklabs dot com) - custom palette
  12141. @author Dan Sherman (dsherman at Isisph.com)
  12142. @author Glen Stampoultzis (glens at apache.org)
  12143. @see org.apache.poi.hssf.usermodel.HSSFWorkbook
  12144. @version 1.0-pre
  12145. </member>
  12146. <member name="F:NPOI.HSSF.Model.InternalWorkbook.MAX_SENSITIVE_SHEET_NAME_LEN">
  12147. Excel silently truncates long sheet names to 31 chars.
  12148. This constant is used to ensure uniqueness in the first 31 chars
  12149. </member>
  12150. <member name="F:NPOI.HSSF.Model.InternalWorkbook.CODEPAGE">
  12151. constant used to Set the "codepage" wherever "codepage" is Set in records
  12152. (which is duplciated in more than one record)
  12153. </member>
  12154. <member name="F:NPOI.HSSF.Model.InternalWorkbook.records">
  12155. this Contains the Worksheet record objects
  12156. </member>
  12157. <member name="F:NPOI.HSSF.Model.InternalWorkbook.sst">
  12158. this Contains a reference to the SSTRecord so that new stings can be Added
  12159. to it.
  12160. </member>
  12161. <member name="F:NPOI.HSSF.Model.InternalWorkbook.boundsheets">
  12162. holds the "boundsheet" records (aka bundlesheet) so that they can have their
  12163. reference to their "BOF" marker
  12164. </member>
  12165. <member name="M:NPOI.HSSF.Model.InternalWorkbook.#ctor">
  12166. Creates new Workbook with no intitialization --useless right now
  12167. @see #CreateWorkbook(List)
  12168. </member>
  12169. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWorkbook(System.Collections.Generic.List{NPOI.HSSF.Record.Record})">
  12170. Read support for low level
  12171. API. Pass in an array of Record objects, A Workbook
  12172. object is constructed and passed back with all of its initialization Set
  12173. to the passed in records and references to those records held. Unlike Sheet
  12174. workbook does not use an offset (its assumed to be 0) since its first in a file.
  12175. If you need an offset then construct a new array with a 0 offset or Write your
  12176. own ;-p.
  12177. @param recs an array of Record objects
  12178. @return Workbook object
  12179. </member>
  12180. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetNameCommentRecord(NPOI.HSSF.Record.NameRecord)">
  12181. gets the name comment record
  12182. @param nameRecord name record who's comment is required.
  12183. @return name comment record or <code>null</code> if there isn't one for the given name.
  12184. </member>
  12185. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWorkbook">
  12186. Creates an empty workbook object with three blank sheets and all the empty
  12187. fields. Use this to Create a workbook from scratch.
  12188. </member>
  12189. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetSpecificBuiltinRecord(System.Byte,System.Int32)">
  12190. Retrieves the Builtin NameRecord that matches the name and index
  12191. There shouldn't be too many names to make the sequential search too slow
  12192. @param name byte representation of the builtin name to match
  12193. @param sheetIndex Index to match
  12194. @return null if no builtin NameRecord matches
  12195. </member>
  12196. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveBuiltinRecord(System.Byte,System.Int32)">
  12197. Removes the specified Builtin NameRecord that matches the name and index
  12198. @param name byte representation of the builtin to match
  12199. @param sheetIndex zero-based sheet reference
  12200. </member>
  12201. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetFontRecordAt(System.Int32)">
  12202. Gets the font record at the given index in the font table. Remember
  12203. "There is No Four" (someone at M$ must have gone to Rocky Horror one too
  12204. many times)
  12205. @param idx the index to look at (0 or greater but NOT 4)
  12206. @return FontRecord located at the given index
  12207. </member>
  12208. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateNewFont">
  12209. Creates a new font record and Adds it to the "font table". This causes the
  12210. boundsheets to move down one, extended formats to move down (so this function moves
  12211. those pointers as well)
  12212. @return FontRecord that was just Created
  12213. </member>
  12214. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CloneDrawings(NPOI.HSSF.Model.InternalSheet)">
  12215. Check if the cloned sheet has drawings. If yes, then allocate a new drawing group ID and
  12216. re-generate shape IDs
  12217. @param sheet the cloned sheet
  12218. </member>
  12219. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetBof(System.Int32,System.Int32)">
  12220. Sets the BOF for a given sheet
  12221. @param sheetnum the number of the sheet to Set the positing of the bof for
  12222. @param pos the actual bof position
  12223. </member>
  12224. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetName(System.Int32,System.String)">
  12225. Sets the name for a given sheet. If the boundsheet record doesn't exist and
  12226. its only one more than we have, go ahead and Create it. If its > 1 more than
  12227. we have, except
  12228. @param sheetnum the sheet number (0 based)
  12229. @param sheetname the name for the sheet
  12230. </member>
  12231. <member name="M:NPOI.HSSF.Model.InternalWorkbook.ContainsSheetName(System.String,System.Int32)">
  12232. Determines whether a workbook Contains the provided sheet name.
  12233. @param name the name to test (case insensitive match)
  12234. @param excludeSheetIdx the sheet to exclude from the Check or -1 to include all sheets in the Check.
  12235. @return true if the sheet Contains the name, false otherwise.
  12236. </member>
  12237. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetName(System.Int32,System.String,System.Int16)">
  12238. Sets the name for a given sheet forcing the encoding. This is STILL A BAD IDEA.
  12239. Poi now automatically detects Unicode
  12240. @deprecated 3-Jan-06 Simply use SetSheetNam e(int sheetnum, String sheetname)
  12241. @param sheetnum the sheet number (0 based)
  12242. @param sheetname the name for the sheet
  12243. </member>
  12244. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetOrder(System.String,System.Int32)">
  12245. Sets the order of appearance for a given sheet.
  12246. @param sheetname the name of the sheet to reorder
  12247. @param pos the position that we want to Insert the sheet into (0 based)
  12248. </member>
  12249. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetSheetName(System.Int32)">
  12250. Gets the name for a given sheet.
  12251. @param sheetnum the sheet number (0 based)
  12252. @return sheetname the name for the sheet
  12253. </member>
  12254. <member name="M:NPOI.HSSF.Model.InternalWorkbook.IsSheetHidden(System.Int32)">
  12255. Gets the hidden flag for a given sheet.
  12256. @param sheetnum the sheet number (0 based)
  12257. @return True if sheet is hidden
  12258. </member>
  12259. <member name="M:NPOI.HSSF.Model.InternalWorkbook.IsSheetVeryHidden(System.Int32)">
  12260. Gets the hidden flag for a given sheet.
  12261. Note that a sheet could instead be
  12262. set to be very hidden, which is different
  12263. ({@link #isSheetVeryHidden(int)})
  12264. @param sheetnum the sheet number (0 based)
  12265. @return True if sheet is hidden
  12266. </member>
  12267. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetHidden(System.Int32,System.Boolean)">
  12268. Hide or Unhide a sheet
  12269. @param sheetnum The sheet number
  12270. @param hidden True to mark the sheet as hidden, false otherwise
  12271. </member>
  12272. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetHidden(System.Int32,System.Int32)">
  12273. Hide or unhide a sheet.
  12274. 0 = not hidden
  12275. 1 = hidden
  12276. 2 = very hidden.
  12277. @param sheetnum The sheet number
  12278. @param hidden 0 for not hidden, 1 for hidden, 2 for very hidden
  12279. </member>
  12280. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetSheetIndex(System.String)">
  12281. Get the sheet's index
  12282. @param name sheet name
  12283. @return sheet index or -1 if it was not found.
  12284. </member>
  12285. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CheckSheets(System.Int32)">
  12286. if we're trying to Address one more sheet than we have, go ahead and Add it! if we're
  12287. trying to Address >1 more than we have throw an exception!
  12288. </member>
  12289. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FixTabIdRecord">
  12290. <summary>
  12291. make the tabid record look like the current situation.
  12292. </summary>
  12293. <returns>number of bytes written in the TabIdRecord</returns>
  12294. </member>
  12295. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetFontIndex(NPOI.HSSF.Record.FontRecord)">
  12296. Retrieves the index of the given font
  12297. </member>
  12298. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetStyleRecord(System.Int32)">
  12299. Returns the StyleRecord for the given
  12300. xfIndex, or null if that ExtendedFormat doesn't
  12301. have a Style set.
  12302. </member>
  12303. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetExFormatAt(System.Int32)">
  12304. Gets the ExtendedFormatRecord at the given 0-based index
  12305. @param index of the Extended format record (0-based)
  12306. @return ExtendedFormatRecord at the given index
  12307. </member>
  12308. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateCellXF">
  12309. Creates a new Cell-type Extneded Format Record and Adds it to the end of
  12310. ExtendedFormatRecords collection
  12311. @return ExtendedFormatRecord that was Created
  12312. </member>
  12313. <member name="M:NPOI.HSSF.Model.InternalWorkbook.AddSSTString(NPOI.HSSF.Record.UnicodeString)">
  12314. Adds a string to the SST table and returns its index (if its a duplicate
  12315. just returns its index and update the counts) ASSUMES compressed Unicode
  12316. (meaning 8bit)
  12317. @param string the string to be Added to the SSTRecord
  12318. @return index of the string within the SSTRecord
  12319. </member>
  12320. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetSSTString(System.Int32)">
  12321. given an index into the SST table, this function returns the corresponding String value
  12322. @return String containing the SST String
  12323. </member>
  12324. <member name="M:NPOI.HSSF.Model.InternalWorkbook.InsertSST">
  12325. use this function to Add a Shared String Table to an existing sheet (say
  12326. generated by a different java api) without an sst....
  12327. @see #CreateSST()
  12328. @see org.apache.poi.hssf.record.SSTRecord
  12329. </member>
  12330. <member name="M:NPOI.HSSF.Model.InternalWorkbook.Serialize(System.Int32,System.Byte[])">
  12331. Serializes all records int the worksheet section into a big byte array. Use
  12332. this to Write the Workbook out.
  12333. @param offset of the data to be written
  12334. @param data array of bytes to Write this to
  12335. </member>
  12336. <member name="M:NPOI.HSSF.Model.InternalWorkbook.PreSerialize">
  12337. Perform any work necessary before the workbook is about to be serialized.
  12338. Include in it ant code that modifies the workbook record stream and affects its size.
  12339. </member>
  12340. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBOF">
  12341. Creates the BOF record
  12342. @see org.apache.poi.hssf.record.BOFRecord
  12343. @see org.apache.poi.hssf.record.Record
  12344. @return record containing a BOFRecord
  12345. </member>
  12346. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateInterfaceHdr">
  12347. Creates the InterfaceHdr record
  12348. @see org.apache.poi.hssf.record.InterfaceHdrRecord
  12349. @see org.apache.poi.hssf.record.Record
  12350. @return record containing a InterfaceHdrRecord
  12351. </member>
  12352. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateMMS">
  12353. Creates an MMS record
  12354. @see org.apache.poi.hssf.record.MMSRecord
  12355. @see org.apache.poi.hssf.record.Record
  12356. @return record containing a MMSRecord
  12357. </member>
  12358. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateInterfaceEnd">
  12359. Creates the InterfaceEnd record
  12360. @see org.apache.poi.hssf.record.InterfaceEndRecord
  12361. @see org.apache.poi.hssf.record.Record
  12362. @return record containing a InterfaceEndRecord
  12363. </member>
  12364. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWriteAccess">
  12365. Creates the WriteAccess record containing the logged in user's name
  12366. @see org.apache.poi.hssf.record.WriteAccessRecord
  12367. @see org.apache.poi.hssf.record.Record
  12368. @return record containing a WriteAccessRecord
  12369. </member>
  12370. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateCodepage">
  12371. Creates the Codepage record containing the constant stored in CODEPAGE
  12372. @see org.apache.poi.hssf.record.CodepageRecord
  12373. @see org.apache.poi.hssf.record.Record
  12374. @return record containing a CodepageRecord
  12375. </member>
  12376. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateDSF">
  12377. Creates the DSF record containing a 0 since HSSF can't even Create Dual Stream Files
  12378. @see org.apache.poi.hssf.record.DSFRecord
  12379. @see org.apache.poi.hssf.record.Record
  12380. @return record containing a DSFRecord
  12381. </member>
  12382. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateTabId">
  12383. Creates the TabId record containing an array of 0,1,2. This release of HSSF
  12384. always has the default three sheets, no less, no more.
  12385. @see org.apache.poi.hssf.record.TabIdRecord
  12386. @see org.apache.poi.hssf.record.Record
  12387. @return record containing a TabIdRecord
  12388. </member>
  12389. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateFnGroupCount">
  12390. Creates the FnGroupCount record containing the Magic number constant of 14.
  12391. @see org.apache.poi.hssf.record.FnGroupCountRecord
  12392. @see org.apache.poi.hssf.record.Record
  12393. @return record containing a FnGroupCountRecord
  12394. </member>
  12395. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWindowProtect">
  12396. Creates the WindowProtect record with protect Set to false.
  12397. @see org.apache.poi.hssf.record.WindowProtectRecord
  12398. @see org.apache.poi.hssf.record.Record
  12399. @return record containing a WindowProtectRecord
  12400. </member>
  12401. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateProtect">
  12402. Creates the Protect record with protect Set to false.
  12403. @see org.apache.poi.hssf.record.ProtectRecord
  12404. @see org.apache.poi.hssf.record.Record
  12405. @return record containing a ProtectRecord
  12406. </member>
  12407. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreatePassword">
  12408. Creates the Password record with password Set to 0.
  12409. @see org.apache.poi.hssf.record.PasswordRecord
  12410. @see org.apache.poi.hssf.record.Record
  12411. @return record containing a PasswordRecord
  12412. </member>
  12413. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateProtectionRev4">
  12414. Creates the ProtectionRev4 record with protect Set to false.
  12415. @see org.apache.poi.hssf.record.ProtectionRev4Record
  12416. @see org.apache.poi.hssf.record.Record
  12417. @return record containing a ProtectionRev4Record
  12418. </member>
  12419. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreatePasswordRev4">
  12420. Creates the PasswordRev4 record with password Set to 0.
  12421. @see org.apache.poi.hssf.record.PasswordRev4Record
  12422. @see org.apache.poi.hssf.record.Record
  12423. @return record containing a PasswordRev4Record
  12424. </member>
  12425. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWindowOne">
  12426. Creates the WindowOne record with the following magic values:
  12427. horizontal hold - 0x168
  12428. vertical hold - 0x10e
  12429. width - 0x3a5c
  12430. height - 0x23be
  12431. options - 0x38
  12432. selected tab - 0
  12433. Displayed tab - 0
  12434. num selected tab- 0
  12435. tab width ratio - 0x258
  12436. @see org.apache.poi.hssf.record.WindowOneRecord
  12437. @see org.apache.poi.hssf.record.Record
  12438. @return record containing a WindowOneRecord
  12439. </member>
  12440. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBackup">
  12441. Creates the Backup record with backup Set to 0. (loose the data, who cares)
  12442. @see org.apache.poi.hssf.record.BackupRecord
  12443. @see org.apache.poi.hssf.record.Record
  12444. @return record containing a BackupRecord
  12445. </member>
  12446. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateHideObj">
  12447. Creates the HideObj record with hide object Set to 0. (don't hide)
  12448. @see org.apache.poi.hssf.record.HideObjRecord
  12449. @see org.apache.poi.hssf.record.Record
  12450. @return record containing a HideObjRecord
  12451. </member>
  12452. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateDateWindow1904">
  12453. Creates the DateWindow1904 record with windowing Set to 0. (don't window)
  12454. @see org.apache.poi.hssf.record.DateWindow1904Record
  12455. @see org.apache.poi.hssf.record.Record
  12456. @return record containing a DateWindow1904Record
  12457. </member>
  12458. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreatePrecision">
  12459. Creates the Precision record with precision Set to true. (full precision)
  12460. @see org.apache.poi.hssf.record.PrecisionRecord
  12461. @see org.apache.poi.hssf.record.Record
  12462. @return record containing a PrecisionRecord
  12463. </member>
  12464. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateRefreshAll">
  12465. Creates the RefreshAll record with refreshAll Set to true. (refresh all calcs)
  12466. @see org.apache.poi.hssf.record.RefreshAllRecord
  12467. @see org.apache.poi.hssf.record.Record
  12468. @return record containing a RefreshAllRecord
  12469. </member>
  12470. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBookBool">
  12471. Creates the BookBool record with saveLinkValues Set to 0. (don't save link values)
  12472. @see org.apache.poi.hssf.record.BookBoolRecord
  12473. @see org.apache.poi.hssf.record.Record
  12474. @return record containing a BookBoolRecord
  12475. </member>
  12476. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateFont">
  12477. Creates a Font record with the following magic values:
  12478. fontheight = 0xc8
  12479. attributes = 0x0
  12480. color palette index = 0x7fff
  12481. bold weight = 0x190
  12482. Font Name Length = 5
  12483. Font Name = Arial
  12484. @see org.apache.poi.hssf.record.FontRecord
  12485. @see org.apache.poi.hssf.record.Record
  12486. @return record containing a FontRecord
  12487. </member>
  12488. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateExtendedFormat(System.Int32)">
  12489. Creates an ExtendedFormatRecord object
  12490. @param id the number of the extended format record to Create (meaning its position in
  12491. a file as MS Excel would Create it.)
  12492. @return record containing an ExtendedFormatRecord
  12493. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  12494. @see org.apache.poi.hssf.record.Record
  12495. </member>
  12496. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateExtendedFormat">
  12497. Creates an default cell type ExtendedFormatRecord object.
  12498. @return ExtendedFormatRecord with intial defaults (cell-type)
  12499. </member>
  12500. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateStyleRecord(System.Int32)">
  12501. Creates a new StyleRecord, for the given Extended
  12502. Format index, and adds it onto the end of the
  12503. records collection
  12504. </member>
  12505. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateStyle(System.Int32)">
  12506. Creates a StyleRecord object
  12507. @param id the number of the style record to Create (meaning its position in
  12508. a file as MS Excel would Create it.
  12509. @return record containing a StyleRecord
  12510. @see org.apache.poi.hssf.record.StyleRecord
  12511. @see org.apache.poi.hssf.record.Record
  12512. </member>
  12513. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreatePalette">
  12514. Creates a palette record initialized to the default palette
  12515. @return a PaletteRecord instance populated with the default colors
  12516. @see org.apache.poi.hssf.record.PaletteRecord
  12517. </member>
  12518. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateUseSelFS">
  12519. Creates the UseSelFS object with the use natural language flag Set to 0 (false)
  12520. @return record containing a UseSelFSRecord
  12521. @see org.apache.poi.hssf.record.UseSelFSRecord
  12522. @see org.apache.poi.hssf.record.Record
  12523. </member>
  12524. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBoundSheet(System.Int32)">
  12525. Create a "bound sheet" or "bundlesheet" (depending who you ask) record
  12526. Always Sets the sheet's bof to 0. You'll need to Set that yourself.
  12527. @param id either sheet 0,1 or 2.
  12528. @return record containing a BoundSheetRecord
  12529. @see org.apache.poi.hssf.record.BoundSheetRecord
  12530. @see org.apache.poi.hssf.record.Record
  12531. </member>
  12532. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateCountry">
  12533. Creates the Country record with the default country Set to 1
  12534. and current country Set to 7 in case of russian locale ("ru_RU") and 1 otherwise
  12535. @return record containing a CountryRecord
  12536. @see org.apache.poi.hssf.record.CountryRecord
  12537. @see org.apache.poi.hssf.record.Record
  12538. </member>
  12539. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateExtendedSST">
  12540. Creates the ExtendedSST record with numstrings per bucket Set to 0x8. HSSF
  12541. doesn't yet know what to do with this thing, but we Create it with nothing in
  12542. it hardly just to make Excel happy and our sheets look like Excel's
  12543. @return record containing an ExtSSTRecord
  12544. @see org.apache.poi.hssf.record.ExtSSTRecord
  12545. @see org.apache.poi.hssf.record.Record
  12546. </member>
  12547. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindSheetFirstNameFromExternSheet(System.Int32)">
  12548. Finds the first sheet name by his extern sheet index
  12549. @param externSheetIndex extern sheet index
  12550. @return first sheet name.
  12551. </member>
  12552. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetFirstSheetIndexFromExternSheetIndex(System.Int32)">
  12553. Finds the (first) sheet index for a particular external sheet number.
  12554. @param externSheetNumber The external sheet number to convert
  12555. @return The index to the sheet found.
  12556. </member>
  12557. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetLastSheetIndexFromExternSheetIndex(System.Int32)">
  12558. Finds the last sheet index for a particular external sheet number,
  12559. which may be the same as the first (except for multi-sheet references)
  12560. @param externSheetNumber The external sheet number to convert
  12561. @return The index to the sheet found.
  12562. </member>
  12563. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CheckExternSheet(System.Int32)">
  12564. Returns the extern sheet number for specific sheet number.
  12565. If this sheet doesn't exist in extern sheet, add it
  12566. @param sheetNumber local sheet number
  12567. @return index to extern sheet
  12568. </member>
  12569. <member name="M:NPOI.HSSF.Model.InternalWorkbook.checkExternSheet(System.Int32,System.Int32)">
  12570. Returns the extern sheet number for specific range of sheets.
  12571. If this sheet range doesn't exist in extern sheet, add it
  12572. @param firstSheetNumber first local sheet number
  12573. @param lastSheetNumber last local sheet number
  12574. @return index to extern sheet
  12575. </member>
  12576. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetNameXPtg(System.String,System.Int32,NPOI.SS.Formula.Udf.UDFFinder)">
  12577. @param name the name of an external function, typically a name of a UDF
  12578. @param sheetRefIndex the sheet ref index, or -1 if not known
  12579. @param udf locator of user-defiend functions to resolve names of VBA and Add-In functions
  12580. @return the external name or null
  12581. </member>
  12582. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetNameRecord(System.Int32)">
  12583. Gets the name record
  12584. @param index name index
  12585. @return name record
  12586. </member>
  12587. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateName">
  12588. Creates new name
  12589. @return new name record
  12590. </member>
  12591. <member name="M:NPOI.HSSF.Model.InternalWorkbook.AddName(NPOI.HSSF.Record.NameRecord)">
  12592. Creates new name
  12593. @return new name record
  12594. </member>
  12595. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBuiltInName(System.Byte,System.Int32)">
  12596. Generates a NameRecord to represent a built-in region
  12597. @return a new NameRecord Unless the index is invalid
  12598. </member>
  12599. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveName(System.Int32)">
  12600. Removes the name
  12601. @param namenum name index
  12602. </member>
  12603. <member name="M:NPOI.HSSF.Model.InternalWorkbook.UpdateNameCommentRecordCache(NPOI.HSSF.Record.NameCommentRecord)">
  12604. If a {@link NameCommentRecord} is added or the name it references
  12605. is renamed, then this will update the lookup cache for it.
  12606. </member>
  12607. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetFormat(System.String,System.Boolean)">
  12608. Returns a format index that matches the passed in format. It does not tie into HSSFDataFormat.
  12609. @param format the format string
  12610. @param CreateIfNotFound Creates a new format if format not found
  12611. @return the format id of a format that matches or -1 if none found and CreateIfNotFound
  12612. </member>
  12613. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateFormat(System.String)">
  12614. Creates a FormatRecord, Inserts it, and returns the index code.
  12615. @param format the format string
  12616. @return the index code of the format record.
  12617. @see org.apache.poi.hssf.record.FormatRecord
  12618. @see org.apache.poi.hssf.record.Record
  12619. </member>
  12620. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateFormat(System.Int32)">
  12621. Creates a FormatRecord object
  12622. @param id the number of the format record to create (meaning its position in
  12623. a file as M$ Excel would create it.)
  12624. </member>
  12625. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindFirstRecordBySid(System.Int16)">
  12626. Returns the first occurance of a record matching a particular sid.
  12627. </member>
  12628. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindFirstRecordLocBySid(System.Int16)">
  12629. Returns the index of a record matching a particular sid.
  12630. @param sid The sid of the record to match
  12631. @return The index of -1 if no match made.
  12632. </member>
  12633. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindNextRecordBySid(System.Int16,System.Int32)">
  12634. Returns the next occurance of a record matching a particular sid.
  12635. </member>
  12636. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindDrawingGroup">
  12637. Finds the primary drawing Group, if one already exists
  12638. </member>
  12639. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateDrawingGroup">
  12640. Creates a primary drawing Group record. If it already
  12641. exists then it's modified.
  12642. </member>
  12643. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveFontRecord(NPOI.HSSF.Record.FontRecord)">
  12644. Removes the given font record from the
  12645. file's list. This will make all
  12646. subsequent font indicies drop by one,
  12647. so you'll need to update those yourself!
  12648. </member>
  12649. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveExFormatRecord(NPOI.HSSF.Record.ExtendedFormatRecord)">
  12650. Removes the given ExtendedFormatRecord record from the
  12651. file's list. This will make all
  12652. subsequent font indicies drop by one,
  12653. so you'll need to update those yourself!
  12654. </member>
  12655. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveExFormatRecord(System.Int32)">
  12656. <summary>
  12657. Removes ExtendedFormatRecord record with given index from the file's list. This will make all
  12658. subsequent font indicies drop by one,so you'll need to update those yourself!
  12659. </summary>
  12660. <param name="index">index of the Extended format record (0-based)</param>
  12661. </member>
  12662. <member name="M:NPOI.HSSF.Model.InternalWorkbook.WriteProtectWorkbook(System.String,System.String)">
  12663. protect a workbook with a password (not encypted, just Sets Writeprotect
  12664. flags and the password.
  12665. @param password to Set
  12666. </member>
  12667. <member name="M:NPOI.HSSF.Model.InternalWorkbook.UnwriteProtectWorkbook">
  12668. Removes the Write protect flag
  12669. </member>
  12670. <member name="M:NPOI.HSSF.Model.InternalWorkbook.ResolveNameXText(System.Int32,System.Int32)">
  12671. @param reFindex Index to REF entry in EXTERNSHEET record in the Link Table
  12672. @param definedNameIndex zero-based to DEFINEDNAME or EXTERNALNAME record
  12673. @return the string representation of the defined or external name
  12674. </member>
  12675. <member name="M:NPOI.HSSF.Model.InternalWorkbook.UpdateNamesAfterCellShift(NPOI.SS.Formula.FormulaShifter)">
  12676. Updates named ranges due to moving of cells
  12677. </member>
  12678. <member name="M:NPOI.HSSF.Model.InternalWorkbook.ChangeExternalReference(System.String,System.String)">
  12679. Changes an external referenced file to another file.
  12680. A formular in Excel which refers a cell in another file is saved in two parts:
  12681. The referenced file is stored in an reference table. the row/cell information is saved separate.
  12682. This method invokation will only change the reference in the lookup-table itself.
  12683. @param oldUrl The old URL to search for and which is to be replaced
  12684. @param newUrl The URL replacement
  12685. @return true if the oldUrl was found and replaced with newUrl. Otherwise false
  12686. </member>
  12687. <member name="P:NPOI.HSSF.Model.InternalWorkbook.NumberOfFontRecords">
  12688. Gets the number of font records
  12689. @return number of font records in the "font table"
  12690. </member>
  12691. <member name="P:NPOI.HSSF.Model.InternalWorkbook.BackupRecord">
  12692. Returns the position of the backup record.
  12693. </member>
  12694. <member name="P:NPOI.HSSF.Model.InternalWorkbook.NumSheets">
  12695. returns the number of boundsheet objects contained in this workbook.
  12696. @return number of BoundSheet records
  12697. </member>
  12698. <member name="P:NPOI.HSSF.Model.InternalWorkbook.NumExFormats">
  12699. Get the number of ExtendedFormat records contained in this workbook.
  12700. @return int count of ExtendedFormat records
  12701. </member>
  12702. <member name="P:NPOI.HSSF.Model.InternalWorkbook.OrCreateLinkTable">
  12703. lazy initialization
  12704. Note - creating the link table causes creation of 1 EXTERNALBOOK and 1 EXTERNALSHEET record
  12705. </member>
  12706. <member name="P:NPOI.HSSF.Model.InternalWorkbook.NumNames">
  12707. Gets the total number of names
  12708. @return number of names
  12709. </member>
  12710. <member name="P:NPOI.HSSF.Model.InternalWorkbook.Formats">
  12711. Returns the list of FormatRecords in the workbook.
  12712. @return ArrayList of FormatRecords in the notebook
  12713. </member>
  12714. <member name="P:NPOI.HSSF.Model.InternalWorkbook.IsUsing1904DateWindowing">
  12715. Whether date windowing is based on 1/2/1904 or 1/1/1900.
  12716. Some versions of Excel (Mac) can save workbooks using 1904 date windowing.
  12717. @return true if using 1904 date windowing
  12718. </member>
  12719. <member name="P:NPOI.HSSF.Model.InternalWorkbook.CustomPalette">
  12720. Returns the custom palette in use for this workbook; if a custom palette record
  12721. does not exist, then it is Created.
  12722. </member>
  12723. <member name="P:NPOI.HSSF.Model.InternalWorkbook.IsWriteProtected">
  12724. is the workbook protected with a password (not encrypted)?
  12725. </member>
  12726. <member name="P:NPOI.HSSF.Model.InternalWorkbook.RecalcId">
  12727. Get or create RecalcIdRecord
  12728. @see org.apache.poi.hssf.usermodel.HSSFWorkbook#setForceFormulaRecalculation(boolean)
  12729. </member>
  12730. <member name="T:NPOI.HSSF.Model.WorkbookRecordList">
  12731. <summary>
  12732. List for records in Workbook
  12733. </summary>
  12734. </member>
  12735. <member name="M:NPOI.HSSF.Model.WorkbookRecordList.Add(System.Int32,NPOI.HSSF.Record.Record)">
  12736. <summary>
  12737. Adds the specified pos.
  12738. </summary>
  12739. <param name="pos">The pos.</param>
  12740. <param name="r">The r.</param>
  12741. </member>
  12742. <member name="M:NPOI.HSSF.Model.WorkbookRecordList.Remove(NPOI.HSSF.Record.Record)">
  12743. <summary>
  12744. Removes the specified record.
  12745. </summary>
  12746. <param name="record">The record.</param>
  12747. </member>
  12748. <member name="M:NPOI.HSSF.Model.WorkbookRecordList.Remove(System.Int32)">
  12749. <summary>
  12750. Removes the specified position.
  12751. </summary>
  12752. <param name="pos">The position.</param>
  12753. </member>
  12754. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Records">
  12755. <summary>
  12756. Gets or sets the records.
  12757. </summary>
  12758. <value>The records.</value>
  12759. </member>
  12760. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Count">
  12761. <summary>
  12762. Gets the count.
  12763. </summary>
  12764. <value>The count.</value>
  12765. </member>
  12766. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Item(System.Int32)">
  12767. <summary>
  12768. Gets the <see cref="T:NPOI.HSSF.Record.Record"/> at the specified index.
  12769. </summary>
  12770. <value></value>
  12771. </member>
  12772. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Protpos">
  12773. <summary>
  12774. Gets or sets the protpos.
  12775. </summary>
  12776. <value>The protpos.</value>
  12777. </member>
  12778. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Bspos">
  12779. <summary>
  12780. Gets or sets the bspos.
  12781. </summary>
  12782. <value>The bspos.</value>
  12783. </member>
  12784. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Tabpos">
  12785. <summary>
  12786. Gets or sets the tabpos.
  12787. </summary>
  12788. <value>The tabpos.</value>
  12789. </member>
  12790. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Fontpos">
  12791. <summary>
  12792. Gets or sets the fontpos.
  12793. </summary>
  12794. <value>The fontpos.</value>
  12795. </member>
  12796. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Xfpos">
  12797. <summary>
  12798. Gets or sets the xfpos.
  12799. </summary>
  12800. <value>The xfpos.</value>
  12801. </member>
  12802. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Backuppos">
  12803. <summary>
  12804. Gets or sets the backuppos.
  12805. </summary>
  12806. <value>The backuppos.</value>
  12807. </member>
  12808. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Palettepos">
  12809. <summary>
  12810. Gets or sets the palettepos.
  12811. </summary>
  12812. <value>The palettepos.</value>
  12813. </member>
  12814. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Namepos">
  12815. <summary>
  12816. Gets or sets the namepos.
  12817. </summary>
  12818. <value>The namepos.</value>
  12819. </member>
  12820. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Supbookpos">
  12821. <summary>
  12822. Gets or sets the supbookpos.
  12823. </summary>
  12824. <value>The supbookpos.</value>
  12825. </member>
  12826. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.ExternsheetPos">
  12827. <summary>
  12828. Gets or sets the externsheet pos.
  12829. </summary>
  12830. <value>The externsheet pos.</value>
  12831. </member>
  12832. <member name="T:NPOI.HSSF.Record.AbstractEscherHolderRecord">
  12833. The escher container record is used to hold escher records. It is abstract and
  12834. must be subclassed for maximum benefit.
  12835. @author Glen Stampoultzis (glens at apache.org)
  12836. @author Michael Zalewski (zalewski at optonline.net)
  12837. </member>
  12838. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12839. Constructs a Bar record and Sets its fields appropriately.
  12840. @param in the RecordInputstream to Read the record from
  12841. </member>
  12842. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.AddEscherRecord(System.Int32,NPOI.DDF.EscherRecord)">
  12843. Clone the current record, via a call to serialise
  12844. it, and another to Create a new record from the
  12845. bytes.
  12846. May only be used for classes which don't have
  12847. internal counts / ids in them. For those which
  12848. do, a full record-aware serialise is needed, which
  12849. allocates new ids / counts as needed.
  12850. </member>
  12851. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.GetEscherContainer">
  12852. If we have a EscherContainerRecord as one of our
  12853. children (and most top level escher holders do),
  12854. then return that.
  12855. </member>
  12856. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.FindFirstWithId(System.Int16)">
  12857. Descends into all our children, returning the
  12858. first EscherRecord with the given id, or null
  12859. if none found
  12860. </member>
  12861. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.Join(NPOI.HSSF.Record.AbstractEscherHolderRecord)">
  12862. Big drawing Group records are split but it's easier to deal with them
  12863. as a whole Group so we need to join them toGether.
  12864. </member>
  12865. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.Decode">
  12866. Convert raw data to escher records.
  12867. </member>
  12868. <member name="P:NPOI.HSSF.Record.AbstractEscherHolderRecord.RecordSize">
  12869. Size of record (including 4 byte header)
  12870. </member>
  12871. <member name="T:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate">
  12872. <summary>
  12873. </summary>
  12874. CFRecordsAggregate - aggregates Conditional Formatting records CFHeaderRecord
  12875. and number of up to three CFRuleRecord records toGether to simplify
  12876. access to them.
  12877. @author Dmitriy Kumshayev
  12878. </member>
  12879. <member name="F:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.MAX_97_2003_CONDTIONAL_FORMAT_RULES">
  12880. Excel allows up to 3 conditional formating rules
  12881. </member>
  12882. <member name="F:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.rules">
  12883. List of CFRuleRecord objects
  12884. </member>
  12885. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.CreateCFAggregate(NPOI.HSSF.Model.RecordStream)">
  12886. <summary>
  12887. Create CFRecordsAggregate from a list of CF Records
  12888. </summary>
  12889. <param name="rs">list of Record objects</param>
  12890. </member>
  12891. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.CreateCFAggregate(System.Collections.IList,System.Int32)">
  12892. <summary>
  12893. Create CFRecordsAggregate from a list of CF Records
  12894. </summary>
  12895. <param name="recs">list of Record objects</param>
  12896. <param name="pOffset">position of CFHeaderRecord object in the list of Record objects</param>
  12897. </member>
  12898. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.CloneCFAggregate">
  12899. <summary>
  12900. Create a deep Clone of the record
  12901. </summary>
  12902. </member>
  12903. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.Serialize(System.Int32,System.Byte[])">
  12904. <summary>
  12905. called by the class that is responsible for writing this sucker.
  12906. Subclasses should implement this so that their data is passed back in a
  12907. byte array.
  12908. </summary>
  12909. <param name="offset">The offset to begin writing at</param>
  12910. <param name="data">The data byte array containing instance data</param>
  12911. <returns> number of bytes written</returns>
  12912. </member>
  12913. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.UpdateFormulasAfterCellShift(NPOI.SS.Formula.FormulaShifter,System.Int32)">
  12914. @return <c>false</c> if this whole {@link CFHeaderRecord} / {@link CFRuleRecord}s should be deleted
  12915. </member>
  12916. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.ToString">
  12917. @return sum of sizes of all aggregated records
  12918. </member>
  12919. <member name="T:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate">
  12920. <summary>
  12921. @author Glen Stampoultzis
  12922. </summary>
  12923. </member>
  12924. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.#ctor">
  12925. <summary>
  12926. Initializes a new instance of the <see cref="T:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate"/> class.
  12927. </summary>
  12928. </member>
  12929. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.#ctor(NPOI.HSSF.Model.RecordStream)">
  12930. <summary>
  12931. Initializes a new instance of the <see cref="T:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate"/> class.
  12932. </summary>
  12933. <param name="rs">The rs.</param>
  12934. </member>
  12935. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.Clone">
  12936. Performs a deep Clone of the record
  12937. </member>
  12938. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.InsertColumn(NPOI.HSSF.Record.ColumnInfoRecord)">
  12939. <summary>
  12940. Inserts a column into the aggregate (at the end of the list).
  12941. </summary>
  12942. <param name="col">The column.</param>
  12943. </member>
  12944. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.InsertColumn(System.Int32,NPOI.HSSF.Record.ColumnInfoRecord)">
  12945. <summary>
  12946. Inserts a column into the aggregate (at the position specified
  12947. by index
  12948. </summary>
  12949. <param name="idx">The index.</param>
  12950. <param name="col">The columninfo.</param>
  12951. </member>
  12952. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.Serialize(System.Int32,System.Byte[])">
  12953. <summary>
  12954. called by the class that is responsible for writing this sucker.
  12955. Subclasses should implement this so that their data is passed back in a
  12956. byte array.
  12957. </summary>
  12958. <param name="offset">offset to begin writing at</param>
  12959. <param name="data">byte array containing instance data</param>
  12960. <returns>number of bytes written</returns>
  12961. </member>
  12962. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.VisitContainedRecords(NPOI.HSSF.Record.Aggregates.RecordVisitor)">
  12963. <summary>
  12964. Visit each of the atomic BIFF records contained in this {@link RecordAggregate} in the order
  12965. that they should be written to file. Implementors may or may not return the actual
  12966. Records being used to manage POI's internal implementation. Callers should not
  12967. assume either way, and therefore only attempt to modify those Records after cloning
  12968. </summary>
  12969. <param name="rv"></param>
  12970. </member>
  12971. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.FindStartOfColumnOutlineGroup(System.Int32)">
  12972. <summary>
  12973. Finds the start of column outline group.
  12974. </summary>
  12975. <param name="idx">The idx.</param>
  12976. <returns></returns>
  12977. </member>
  12978. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.FindEndOfColumnOutlineGroup(System.Int32)">
  12979. <summary>
  12980. Finds the end of column outline group.
  12981. </summary>
  12982. <param name="idx">The idx.</param>
  12983. <returns></returns>
  12984. </member>
  12985. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.GetColInfo(System.Int32)">
  12986. <summary>
  12987. Gets the col info.
  12988. </summary>
  12989. <param name="idx">The idx.</param>
  12990. <returns></returns>
  12991. </member>
  12992. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.IsColumnGroupCollapsed(System.Int32)">
  12993. <summary>
  12994. Determines whether [is column group collapsed] [the specified idx].
  12995. </summary>
  12996. <param name="idx">The idx.</param>
  12997. <returns>
  12998. <c>true</c> if [is column group collapsed] [the specified idx]; otherwise, <c>false</c>.
  12999. </returns>
  13000. </member>
  13001. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.IsColumnGroupHiddenByParent(System.Int32)">
  13002. <summary>
  13003. Determines whether [is column group hidden by parent] [the specified idx].
  13004. </summary>
  13005. <param name="idx">The idx.</param>
  13006. <returns>
  13007. <c>true</c> if [is column group hidden by parent] [the specified idx]; otherwise, <c>false</c>.
  13008. </returns>
  13009. </member>
  13010. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.CollapseColumn(System.Int32)">
  13011. <summary>
  13012. Collapses the column.
  13013. </summary>
  13014. <param name="columnNumber">The column number.</param>
  13015. </member>
  13016. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.ExpandColumn(System.Int32)">
  13017. <summary>
  13018. Expands the column.
  13019. </summary>
  13020. <param name="columnNumber">The column number.</param>
  13021. </member>
  13022. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.SetColumnInfoFields(NPOI.HSSF.Record.ColumnInfoRecord,System.Nullable{System.Int16},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean})">
  13023. Sets all non null fields into the <c>ci</c> parameter.
  13024. </member>
  13025. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.AttemptMergeColInfoRecords(System.Int32)">
  13026. <summary>
  13027. Attempts to merge the col info record at the specified index
  13028. with either or both of its neighbours
  13029. </summary>
  13030. <param name="colInfoIx">The col info ix.</param>
  13031. </member>
  13032. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.MergeColInfoRecords(NPOI.HSSF.Record.ColumnInfoRecord,NPOI.HSSF.Record.ColumnInfoRecord)">
  13033. merges two column info records (if they are adjacent and have the same formatting, etc)
  13034. @return <c>false</c> if the two column records could not be merged
  13035. </member>
  13036. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.SetGroupHidden(System.Int32,System.Int32,System.Boolean)">
  13037. <summary>
  13038. Sets all adjacent columns of the same outline level to the specified hidden status.
  13039. </summary>
  13040. <param name="pIdx">the col info index of the start of the outline group.</param>
  13041. <param name="level">The level.</param>
  13042. <param name="hidden">The hidden.</param>
  13043. <returns>the column index of the last column in the outline group</returns>
  13044. </member>
  13045. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.SetColumn(System.Int32,System.Nullable{System.Int16},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean})">
  13046. <summary>
  13047. Sets the column.
  13048. </summary>
  13049. <param name="targetColumnIx">The target column ix.</param>
  13050. <param name="xfIndex">Index of the xf.</param>
  13051. <param name="width">The width.</param>
  13052. <param name="level">The level.</param>
  13053. <param name="hidden">The hidden.</param>
  13054. <param name="collapsed">The collapsed.</param>
  13055. </member>
  13056. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.SetColumnInfoFields(NPOI.HSSF.Record.ColumnInfoRecord,System.Int16,System.Int16,System.Int32,System.Boolean,System.Boolean)">
  13057. Sets all non null fields into the <c>ci</c> parameter.
  13058. </member>
  13059. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.CollapseColInfoRecords(System.Int32)">
  13060. <summary>
  13061. Collapses the col info records.
  13062. </summary>
  13063. <param name="columnIdx">The column index.</param>
  13064. </member>
  13065. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.GroupColumnRange(System.Int32,System.Int32,System.Boolean)">
  13066. <summary>
  13067. Creates an outline Group for the specified columns.
  13068. </summary>
  13069. <param name="fromColumnIx">Group from this column (inclusive)</param>
  13070. <param name="toColumnIx">Group to this column (inclusive)</param>
  13071. <param name="indent">if true the Group will be indented by one level;if false indenting will be Removed by one level.</param>
  13072. </member>
  13073. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.FindColumnInfo(System.Int32)">
  13074. <summary>
  13075. Finds the ColumnInfoRecord
  13076. which contains the specified columnIndex
  13077. </summary>
  13078. <param name="columnIndex">index of the column (not the index of the ColumnInfoRecord)</param>
  13079. <returns> /// <c>null</c>
  13080. if no column info found for the specified column
  13081. </returns>
  13082. </member>
  13083. <member name="P:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.Sid">
  13084. It's an aggregate... just made something up
  13085. </member>
  13086. <member name="P:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.NumColumns">
  13087. <summary>
  13088. Gets the num columns.
  13089. </summary>
  13090. <value>The num columns.</value>
  13091. </member>
  13092. <member name="P:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.RecordSize">
  13093. <summary>
  13094. Gets the size of the record.
  13095. </summary>
  13096. <value>The size of the record.</value>
  13097. </member>
  13098. <member name="P:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.MaxOutlineLevel">
  13099. <summary>
  13100. Gets the max outline level.
  13101. </summary>
  13102. <value>The max outline level.</value>
  13103. </member>
  13104. <member name="T:NPOI.HSSF.Record.Aggregates.ConditionalFormattingTable">
  13105. Holds all the conditional formatting for a workbook sheet.<p/>
  13106. See OOO exelfileformat.pdf sec 4.12 'Conditional Formatting Table'
  13107. @author Josh Micich
  13108. </member>
  13109. <member name="M:NPOI.HSSF.Record.Aggregates.ConditionalFormattingTable.#ctor">
  13110. Creates an empty ConditionalFormattingTable
  13111. </member>
  13112. <member name="M:NPOI.HSSF.Record.Aggregates.ConditionalFormattingTable.Add(NPOI.HSSF.Record.Aggregates.CFRecordsAggregate)">
  13113. @return index of the newly added CF header aggregate
  13114. </member>
  13115. <member name="T:NPOI.HSSF.Record.Aggregates.CustomViewSettingsRecordAggregate">
  13116. Manages the all the records associated with a 'Custom View Settings' sub-stream.<br/>
  13117. Includes the Initial USERSVIEWBEGIN(0x01AA) and USERSVIEWEND(0x01AB).
  13118. @author Josh Micich
  13119. </member>
  13120. <member name="F:NPOI.HSSF.Record.Aggregates.CustomViewSettingsRecordAggregate._recs">
  13121. All the records between BOF and EOF
  13122. </member>
  13123. <member name="T:NPOI.HSSF.Record.Aggregates.DataValidityTable">
  13124. <summary>
  13125. Manages the DVALRecord and DVRecords for a single sheet
  13126. See OOO excelfileformat.pdf section 4.14
  13127. @author Josh Micich
  13128. </summary>
  13129. </member>
  13130. <member name="F:NPOI.HSSF.Record.Aggregates.DataValidityTable._validationList">
  13131. The list of data validations for the current sheet.
  13132. Note - this may be empty (contrary to OOO documentation)
  13133. </member>
  13134. <member name="T:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate">
  13135. <summary>
  13136. The formula record aggregate is used to join toGether the formula record and it's
  13137. (optional) string record and (optional) Shared Formula Record (template Reads, excel optimization).
  13138. @author Glen Stampoultzis (glens at apache.org)
  13139. </summary>
  13140. </member>
  13141. <member name="T:NPOI.HSSF.Record.CellValueRecordInterface">
  13142. The cell value record interface Is implemented by all classes of type Record that
  13143. contain cell values. It allows the containing sheet to move through them and Compare
  13144. them.
  13145. @author Andrew C. Oliver (acoliver at apache dot org)
  13146. @author Jason Height (jheight at chariot dot net dot au)
  13147. @see org.apache.poi.hssf.model.Sheet
  13148. @see org.apache.poi.hssf.record.Record
  13149. @see org.apache.poi.hssf.record.RecordFactory
  13150. </member>
  13151. <member name="P:NPOI.HSSF.Record.CellValueRecordInterface.Row">
  13152. Get the row this cell occurs on
  13153. @return the row
  13154. </member>
  13155. <member name="P:NPOI.HSSF.Record.CellValueRecordInterface.Column">
  13156. Get the column this cell defines within the row
  13157. @return the column
  13158. </member>
  13159. <member name="F:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate._stringRecord">
  13160. caches the calculated result of the formula
  13161. </member>
  13162. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.#ctor(NPOI.HSSF.Record.FormulaRecord,NPOI.HSSF.Record.StringRecord,NPOI.HSSF.Record.Aggregates.SharedValueManager)">
  13163. <summary>
  13164. Initializes a new instance of the <see cref="T:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate"/> class.
  13165. </summary>
  13166. <param name="formulaRec">The formula rec.</param>
  13167. <param name="stringRec">The string rec.</param>
  13168. <param name="svm">The SVM.</param>
  13169. </member>
  13170. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.NotifyFormulaChanging">
  13171. Should be called by any code which is either deleting this formula cell, or changing
  13172. its type. This method gives the aggregate a chance to unlink any shared formula
  13173. that may be involved with this cell formula.
  13174. </member>
  13175. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.Serialize(System.Int32,System.Byte[])">
  13176. <summary>
  13177. called by the class that is responsible for writing this sucker.
  13178. Subclasses should implement this so that their data is passed back in a
  13179. byte array.
  13180. </summary>
  13181. <param name="offset">offset to begin writing at</param>
  13182. <param name="data">byte array containing instance data.</param>
  13183. <returns>number of bytes written</returns>
  13184. </member>
  13185. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.VisitContainedRecords(NPOI.HSSF.Record.Aggregates.RecordVisitor)">
  13186. <summary>
  13187. Visit each of the atomic BIFF records contained in this {@link RecordAggregate} in the order
  13188. that they should be written to file. Implementors may or may not return the actual
  13189. {@link Record}s being used to manage POI's internal implementation. Callers should not
  13190. assume either way, and therefore only attempt to modify those {@link Record}s after cloning
  13191. </summary>
  13192. <param name="rv"></param>
  13193. </member>
  13194. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.HandleMissingSharedFormulaRecord(NPOI.HSSF.Record.FormulaRecord)">
  13195. <summary>
  13196. Sometimes the shared formula flag "seems" to be erroneously set (because the corresponding
  13197. SharedFormulaRecord does not exist). Normally this would leave no way of determining
  13198. the Ptg tokens for the formula. However as it turns out in these
  13199. cases, Excel encodes the unshared Ptg tokens in the right place (inside the FormulaRecord).
  13200. So the the only thing that needs to be done is to ignore the erroneous
  13201. shared formula flag.
  13202. This method may also be used for setting breakpoints to help diagnose issues regarding the
  13203. abnormally-set 'shared formula' flags.
  13204. </summary>
  13205. <param name="formula">The formula.</param>
  13206. </member>
  13207. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.Equals(System.Object)">
  13208. <summary>
  13209. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  13210. </summary>
  13211. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
  13212. <returns>
  13213. true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
  13214. </returns>
  13215. <exception cref="T:System.NullReferenceException">
  13216. The <paramref name="obj"/> parameter is null.
  13217. </exception>
  13218. </member>
  13219. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.ToString">
  13220. <summary>
  13221. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  13222. </summary>
  13223. <returns>
  13224. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  13225. </returns>
  13226. </member>
  13227. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.SetCachedStringResult(System.String)">
  13228. <summary>
  13229. Sets the cached string result.
  13230. </summary>
  13231. <param name="value">The value.</param>
  13232. </member>
  13233. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.SetCachedBooleanResult(System.Boolean)">
  13234. <summary>
  13235. Sets the cached boolean result.
  13236. </summary>
  13237. <param name="value">if set to <c>true</c> [value].</param>
  13238. </member>
  13239. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.SetCachedErrorResult(System.Int32)">
  13240. <summary>
  13241. Sets the cached error result.
  13242. </summary>
  13243. <param name="errorCode">The error code.</param>
  13244. </member>
  13245. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.SetParsedExpression(NPOI.SS.Formula.PTG.Ptg[])">
  13246. Also checks for a related shared formula and unlinks it if found
  13247. </member>
  13248. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.RemoveArrayFormula(System.Int32,System.Int32)">
  13249. Removes an array formula
  13250. @return the range of the array formula containing the specified cell. Never <code>null</code>
  13251. </member>
  13252. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.RecordSize">
  13253. <summary>
  13254. Get the current Serialized size of the record. Should include the sid and recLength (4 bytes).
  13255. </summary>
  13256. <value>The size of the record.</value>
  13257. </member>
  13258. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.Sid">
  13259. <summary>
  13260. return the non static version of the id for this record.
  13261. </summary>
  13262. <value>The sid.</value>
  13263. </member>
  13264. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.FormulaRecord">
  13265. <summary>
  13266. Gets or sets the formula record.
  13267. </summary>
  13268. <value>The formula record.</value>
  13269. </member>
  13270. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.StringRecord">
  13271. <summary>
  13272. Gets or sets the string record.
  13273. </summary>
  13274. <value>The string record.</value>
  13275. </member>
  13276. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.StringValue">
  13277. <summary>
  13278. Gets the string value.
  13279. </summary>
  13280. <value>The string value.</value>
  13281. </member>
  13282. <member name="T:NPOI.HSSF.Record.Aggregates.MergedCellsTable">
  13283. @author Josh Micich
  13284. </member>
  13285. <member name="M:NPOI.HSSF.Record.Aggregates.MergedCellsTable.#ctor">
  13286. <summary>
  13287. Creates an empty aggregate
  13288. </summary>
  13289. </member>
  13290. <member name="M:NPOI.HSSF.Record.Aggregates.MergedCellsTable.Read(NPOI.HSSF.Model.RecordStream)">
  13291. Reads zero or more consecutive {@link MergeCellsRecord}s
  13292. @param rs
  13293. </member>
  13294. <member name="T:NPOI.HSSF.Record.Aggregates.PageSettingsBlock">
  13295. Groups the page settings records for a worksheet.<p/>
  13296. See OOO excelfileformat.pdf sec 4.4 'Page Settings Block'
  13297. @author Josh Micich
  13298. </member>
  13299. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.#ctor">
  13300. Creates a PageSettingsBlock with default settings
  13301. </member>
  13302. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.IsComponentRecord(System.Int32)">
  13303. @return <c>true</c> if the specified Record sid is one belonging to the
  13304. 'Page Settings Block'.
  13305. </member>
  13306. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.SetColumnBreak(System.Int32,System.Int32,System.Int32)">
  13307. Sets a page break at the indicated column
  13308. </member>
  13309. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.RemoveColumnBreak(System.Int32)">
  13310. Removes a page break at the indicated column
  13311. </member>
  13312. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.CreateHCenter">
  13313. Creates the HCenter Record and sets it to false (don't horizontally center)
  13314. </member>
  13315. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.CreateVCenter">
  13316. Creates the VCenter Record and sets it to false (don't horizontally center)
  13317. </member>
  13318. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.CreatePrintSetup">
  13319. Creates the PrintSetup Record and sets it to defaults and marks it invalid
  13320. @see org.apache.poi.hssf.record.PrintSetupRecord
  13321. @see org.apache.poi.hssf.record.Record
  13322. @return record containing a PrintSetupRecord
  13323. </member>
  13324. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.GetMargin(NPOI.SS.UserModel.MarginType)">
  13325. Gets the size of the margin in inches.
  13326. @param margin which margin to Get
  13327. @return the size of the margin
  13328. </member>
  13329. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  13330. Sets the size of the margin in inches.
  13331. @param margin which margin to Get
  13332. @param size the size of the margin
  13333. </member>
  13334. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.ShiftBreaks(NPOI.HSSF.Record.PageBreakRecord,System.Int32,System.Int32,System.Int32)">
  13335. Shifts all the page breaks in the range "count" number of rows/columns
  13336. @param breaks The page record to be shifted
  13337. @param start Starting "main" value to shift breaks
  13338. @param stop Ending "main" value to shift breaks
  13339. @param count number of units (rows/columns) to shift by
  13340. </member>
  13341. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.SetRowBreak(System.Int32,System.Int16,System.Int16)">
  13342. Sets a page break at the indicated row
  13343. @param row
  13344. </member>
  13345. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.RemoveRowBreak(System.Int32)">
  13346. Removes a page break at the indicated row
  13347. @param row
  13348. </member>
  13349. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.IsRowBroken(System.Int32)">
  13350. Queries if the specified row has a page break
  13351. @param row
  13352. @return true if the specified row has a page break
  13353. </member>
  13354. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.IsColumnBroken(System.Int32)">
  13355. Queries if the specified column has a page break
  13356. @return <c>true</c> if the specified column has a page break
  13357. </member>
  13358. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.ShiftRowBreaks(System.Int32,System.Int32,System.Int32)">
  13359. Shifts the horizontal page breaks for the indicated count
  13360. @param startingRow
  13361. @param endingRow
  13362. @param count
  13363. </member>
  13364. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.ShiftColumnBreaks(System.Int16,System.Int16,System.Int16)">
  13365. Shifts the vertical page breaks for the indicated count
  13366. @param startingCol
  13367. @param endingCol
  13368. @param count
  13369. </member>
  13370. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.AddLateHeaderFooter(NPOI.HSSF.Record.HeaderFooterRecord)">
  13371. <summary>
  13372. HEADERFOOTER is new in 2007. Some apps seem to have scattered this record long after
  13373. the PageSettingsBlock where it belongs.
  13374. </summary>
  13375. <param name="rec"></param>
  13376. </member>
  13377. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.AddLateRecords(NPOI.HSSF.Model.RecordStream)">
  13378. <summary>
  13379. This method reads PageSettingsBlock records from the supplied RecordStream until the first non-PageSettingsBlock record is encountered.
  13380. As each record is read, it is incorporated into this PageSettingsBlock.
  13381. </summary>
  13382. <param name="rs"></param>
  13383. </member>
  13384. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.Header">
  13385. Returns the HeaderRecord.
  13386. @return HeaderRecord for the sheet.
  13387. </member>
  13388. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.Footer">
  13389. Returns the FooterRecord.
  13390. @return FooterRecord for the sheet.
  13391. </member>
  13392. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.PrintSetup">
  13393. Returns the PrintSetupRecord.
  13394. @return PrintSetupRecord for the sheet.
  13395. </member>
  13396. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.RowBreaks">
  13397. @return all the horizontal page breaks, never <c>null</c>
  13398. </member>
  13399. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.NumRowBreaks">
  13400. @return the number of row page breaks
  13401. </member>
  13402. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.ColumnBreaks">
  13403. @return all the column page breaks, never <c>null</c>
  13404. </member>
  13405. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.NumColumnBreaks">
  13406. @return the number of column page breaks
  13407. </member>
  13408. <member name="F:NPOI.HSSF.Record.Aggregates.PLSAggregate._plsContinues">
  13409. holds any continue records found after the PLS record.<br/>
  13410. This would not be required if PLS was properly interpreted.
  13411. Currently, PLS is an {@link UnknownRecord} and does not automatically
  13412. include any trailing {@link ContinueRecord}s.
  13413. </member>
  13414. <member name="T:NPOI.HSSF.Record.Aggregates.PositionTrackingVisitor">
  13415. A wrapper for {@link RecordVisitor} which accumulates the sizes of all
  13416. records visited.
  13417. </member>
  13418. <member name="T:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate">
  13419. @author andy
  13420. @author Jason Height (jheight at chariot dot net dot au)
  13421. </member>
  13422. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.#ctor">
  13423. Creates a new instance of ValueRecordsAggregate
  13424. </member>
  13425. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.#ctor(NPOI.HSSF.Model.RecordStream,NPOI.HSSF.Record.Aggregates.SharedValueManager)">
  13426. @param rs record stream with all {@link SharedFormulaRecord}
  13427. {@link ArrayRecord}, {@link TableRecord} {@link MergeCellsRecord} Records removed
  13428. </member>
  13429. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.AddUnknownRecord(NPOI.HSSF.Record.Record)">
  13430. Handles UnknownRecords which appear within the row/cell records
  13431. </member>
  13432. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.GetRowCountForBlock(System.Int32)">
  13433. Returns the number of physical rows within a block
  13434. </member>
  13435. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.GetStartRowNumberForBlock(System.Int32)">
  13436. Returns the physical row number of the first row in a block
  13437. </member>
  13438. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.GetEndRowNumberForBlock(System.Int32)">
  13439. Returns the physical row number of the end row in a block
  13440. </member>
  13441. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.CreateRow(System.Int32)">
  13442. Create a row record.
  13443. @param row number
  13444. @return RowRecord Created for the passed in row number
  13445. @see org.apache.poi.hssf.record.RowRecord
  13446. </member>
  13447. <member name="P:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.RowBlockCount">
  13448. Returns the number of row blocks.
  13449. <p/>The row blocks are goupings of rows that contain the DBCell record
  13450. after them
  13451. </member>
  13452. <member name="T:NPOI.HSSF.Record.Aggregates.SharedValueManager">
  13453. <summary>
  13454. Manages various auxiliary records while constructing a RowRecordsAggregate
  13455. @author Josh Micich
  13456. </summary>
  13457. </member>
  13458. <member name="F:NPOI.HSSF.Record.Aggregates.SharedValueManager._groupsCache">
  13459. cached for optimization purposes
  13460. </member>
  13461. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.Create(NPOI.HSSF.Record.SharedFormulaRecord[],NPOI.SS.Util.CellReference[],System.Collections.Generic.List{NPOI.HSSF.Record.ArrayRecord},System.Collections.Generic.List{NPOI.HSSF.Record.TableRecord})">
  13462. @param firstCells
  13463. @param recs list of sheet records (possibly Contains records for other parts of the Excel file)
  13464. @param startIx index of first row/cell record for current sheet
  13465. @param endIx one past index of last row/cell record for current sheet. It is important
  13466. that this code does not inadvertently collect <c>SharedFormulaRecord</c>s from any other
  13467. sheet (which could happen if endIx is chosen poorly). (see bug 44449)
  13468. </member>
  13469. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.LinkSharedFormulaRecord(NPOI.SS.Util.CellReference,NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate)">
  13470. @param firstCell as extracted from the {@link ExpPtg} from the cell's formula.
  13471. @return never <code>null</code>
  13472. </member>
  13473. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.GetRecordForFirstCell(NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate)">
  13474. Gets the {@link SharedValueRecordBase} record if it should be encoded immediately after the
  13475. formula record Contained in the specified {@link FormulaRecordAggregate} agg. Note - the
  13476. shared value record always appears after the first formula record in the group. For arrays
  13477. and tables the first formula is always the in the top left cell. However, since shared
  13478. formula groups can be sparse and/or overlap, the first formula may not actually be in the
  13479. top left cell.
  13480. @return the SHRFMLA, TABLE or ARRAY record for the formula cell, if it is the first cell of
  13481. a table or array region. <code>null</code> if the formula cell is not shared/array/table,
  13482. or if the specified formula is not the the first in the group.
  13483. </member>
  13484. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.Unlink(NPOI.HSSF.Record.SharedFormulaRecord)">
  13485. Converts all {@link FormulaRecord}s handled by <c>sharedFormulaRecord</c>
  13486. to plain unshared formulas
  13487. </member>
  13488. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.AddArrayRecord(NPOI.HSSF.Record.ArrayRecord)">
  13489. Add specified Array Record.
  13490. </member>
  13491. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.RemoveArrayFormula(System.Int32,System.Int32)">
  13492. Removes the {@link ArrayRecord} for the cell group containing the specified cell.
  13493. The caller should clear (set blank) all cells in the returned range.
  13494. @return the range of the array formula which was just removed. Never <code>null</code>.
  13495. </member>
  13496. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.GetArrayRecord(System.Int32,System.Int32)">
  13497. @return the shared ArrayRecord identified by (firstRow, firstColumn). never <code>null</code>.
  13498. </member>
  13499. <member name="F:NPOI.HSSF.Record.Aggregates.SharedValueManager.SharedFormulaGroup._firstCell">
  13500. Coordinates of the first cell having a formula that uses this shared formula.
  13501. This is often <i>but not always</i> the top left cell in the range covered by
  13502. {@link #_sfr}
  13503. </member>
  13504. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.SharedFormulaGroup.IsFirstCell(System.Int32,System.Int32)">
  13505. Note - the 'first cell' of a shared formula group is not always the top-left cell
  13506. of the enclosing range.
  13507. @return <c>true</c> if the specified coordinates correspond to the 'first cell'
  13508. of this shared formula group.
  13509. </member>
  13510. <member name="T:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate">
  13511. Aggregate value records toGether. Things are easier to handle that way.
  13512. @author andy
  13513. @author Glen Stampoultzis (glens at apache.org)
  13514. @author Jason Height (jheight at chariot dot net dot au)
  13515. </member>
  13516. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.#ctor">
  13517. Creates a new instance of ValueRecordsAggregate
  13518. </member>
  13519. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.HandleMissingSharedFormulaRecord(NPOI.HSSF.Record.FormulaRecord)">
  13520. Sometimes the shared formula flag "seems" to be erroneously Set, in which case there is no
  13521. call to <c>SharedFormulaRecord.ConvertSharedFormulaRecord</c> and hence the
  13522. <c>ParsedExpression</c> field of this <c>FormulaRecord</c> will not Get updated.<br/>
  13523. As it turns out, this is not a problem, because in these circumstances, the existing value
  13524. for <c>ParsedExpression</c> is perfectly OK.<p/>
  13525. This method may also be used for Setting breakpoints to help diagnose Issues regarding the
  13526. abnormally-Set 'shared formula' flags.
  13527. (see TestValueRecordsAggregate.testSpuriousSharedFormulaFlag()).<p/>
  13528. The method currently does nothing but do not delete it without Finding a nice home for this
  13529. comment.
  13530. </member>
  13531. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.GetRowCellBlockSize(System.Int32,System.Int32)">
  13532. Tallies a count of the size of the cell records
  13533. that are attached to the rows in the range specified.
  13534. </member>
  13535. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.RowHasCells(System.Int32)">
  13536. Returns true if the row has cells attached to it
  13537. </member>
  13538. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.SerializeCellRow(System.Int32,System.Int32,System.Byte[])">
  13539. Serializes the cells that are allocated to a certain row range
  13540. </member>
  13541. <member name="T:NPOI.HSSF.Record.ArrayRecord">
  13542. ARRAY (0x0221)<p/>
  13543. Treated in a similar way to SharedFormulaRecord
  13544. @author Josh Micich
  13545. </member>
  13546. <member name="T:NPOI.HSSF.Record.SharedValueRecordBase">
  13547. Common base class for {@link SharedFormulaRecord}, {@link ArrayRecord} and
  13548. {@link TableRecord} which are have similarities.
  13549. @author Josh Micich
  13550. </member>
  13551. <member name="M:NPOI.HSSF.Record.SharedValueRecordBase.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13552. reads only the range (1 {@link CellRangeAddress8Bit}) from the stream
  13553. </member>
  13554. <member name="M:NPOI.HSSF.Record.SharedValueRecordBase.IsInRange(System.Int32,System.Int32)">
  13555. @return <c>true</c> if (rowIx, colIx) is within the range ({@link #Range})
  13556. of this shared value object.
  13557. </member>
  13558. <member name="M:NPOI.HSSF.Record.SharedValueRecordBase.IsFirstCell(System.Int32,System.Int32)">
  13559. @return <c>true</c> if (rowIx, colIx) describes the first cell in this shared value
  13560. object's range ({@link #Range})
  13561. </member>
  13562. <member name="T:NPOI.HSSF.Record.AutoFilter.DOPERRecord">
  13563. <summary>
  13564. DOPER Structure for AutoFilter record
  13565. </summary>
  13566. <remarks>author: Tony Qu</remarks>
  13567. </member>
  13568. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.RK">
  13569. <summary>
  13570. get or set the RK record
  13571. </summary>
  13572. </member>
  13573. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.LengthOfString">
  13574. <summary>
  13575. Gets or sets Length of the string (the string is stored in the rgch field that follows the DOPER structures)
  13576. </summary>
  13577. </member>
  13578. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.IsBooleanValue">
  13579. <summary>
  13580. Whether the bBoolErr field contains a Boolean value
  13581. </summary>
  13582. </member>
  13583. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.IsErrorValue">
  13584. <summary>
  13585. Whether the bBoolErr field contains a Error value
  13586. </summary>
  13587. </member>
  13588. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.BooleanValue">
  13589. <summary>
  13590. Get or sets the boolean value
  13591. </summary>
  13592. </member>
  13593. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.ErrorValue">
  13594. <summary>
  13595. Get or sets the boolean value
  13596. </summary>
  13597. </member>
  13598. <member name="T:NPOI.HSSF.Record.BackupRecord">
  13599. Title: Backup Record
  13600. Description: bool specifying whether
  13601. the GUI should store a backup of the file.
  13602. REFERENCE: PG 287 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13603. @author Andrew C. Oliver (acoliver at apache dot org)
  13604. @version 2.0-pre
  13605. </member>
  13606. <member name="M:NPOI.HSSF.Record.BackupRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13607. Constructs a BackupRecord and Sets its fields appropriately
  13608. @param in the RecordInputstream to Read the record from
  13609. </member>
  13610. <member name="P:NPOI.HSSF.Record.BackupRecord.Backup">
  13611. Get the backup flag
  13612. @return short 0/1 (off/on)
  13613. </member>
  13614. <member name="M:NPOI.HSSF.Record.BiffHeaderInput.ReadRecordSID">
  13615. Read an unsigned short from the stream without decrypting
  13616. </member>
  13617. <member name="M:NPOI.HSSF.Record.BiffHeaderInput.ReadDataSize">
  13618. Read an unsigned short from the stream without decrypting
  13619. </member>
  13620. <member name="T:NPOI.HSSF.Record.BlankRecord">
  13621. Title: Blank cell record
  13622. Description: Represents a column in a row with no value but with styling.
  13623. REFERENCE: PG 287 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13624. @author Andrew C. Oliver (acoliver at apache dot org)
  13625. @author Jason Height (jheight at chariot dot net dot au)
  13626. @version 2.0-pre
  13627. </member>
  13628. <member name="M:NPOI.HSSF.Record.BlankRecord.#ctor">
  13629. Creates a new instance of BlankRecord
  13630. </member>
  13631. <member name="M:NPOI.HSSF.Record.BlankRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13632. Constructs a BlankRecord and Sets its fields appropriately
  13633. @param in the RecordInputstream to Read the record from
  13634. </member>
  13635. <member name="M:NPOI.HSSF.Record.BlankRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  13636. called by the class that is responsible for writing this sucker.
  13637. Subclasses should implement this so that their data is passed back in a
  13638. byte array.
  13639. @return byte array containing instance data
  13640. </member>
  13641. <member name="P:NPOI.HSSF.Record.BlankRecord.Row">
  13642. Get the row this cell occurs on
  13643. @return the row
  13644. </member>
  13645. <member name="P:NPOI.HSSF.Record.BlankRecord.Column">
  13646. Get the column this cell defines within the row
  13647. @return the column
  13648. </member>
  13649. <member name="P:NPOI.HSSF.Record.BlankRecord.XFIndex">
  13650. Set the index of the extended format record to style this cell with
  13651. @param xf - the 0-based index of the extended format
  13652. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  13653. </member>
  13654. <member name="P:NPOI.HSSF.Record.BlankRecord.Sid">
  13655. return the non static version of the id for this record.
  13656. </member>
  13657. <member name="T:NPOI.HSSF.Record.BOFRecord">
  13658. Title: Beginning Of File
  13659. Description: Somewhat of a misnomer, its used for the beginning of a Set of
  13660. records that have a particular pupose or subject.
  13661. Used in sheets and workbooks.
  13662. REFERENCE: PG 289 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13663. @author Andrew C. Oliver
  13664. @author Jason Height (jheight at chariot dot net dot au)
  13665. @version 2.0-pre
  13666. </member>
  13667. <member name="F:NPOI.HSSF.Record.BOFRecord.sid">
  13668. for BIFF8 files the BOF is 0x809. For earlier versions see
  13669. {@link #biff2_sid} {@link #biff3_sid} {@link #biff4_sid}
  13670. {@link #biff5_sid}
  13671. </member>
  13672. <member name="F:NPOI.HSSF.Record.BOFRecord.VERSION">
  13673. suggested default (0x06 - BIFF8)
  13674. </member>
  13675. <member name="F:NPOI.HSSF.Record.BOFRecord.BUILD">
  13676. suggested default 0x10d3
  13677. </member>
  13678. <member name="F:NPOI.HSSF.Record.BOFRecord.BUILD_YEAR">
  13679. suggested default 0x07CC (1996)
  13680. </member>
  13681. <member name="F:NPOI.HSSF.Record.BOFRecord.HISTORY_MASK">
  13682. suggested default for a normal sheet (0x41)
  13683. </member>
  13684. <member name="M:NPOI.HSSF.Record.BOFRecord.#ctor">
  13685. Constructs an empty BOFRecord with no fields Set.
  13686. </member>
  13687. <member name="M:NPOI.HSSF.Record.BOFRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13688. Constructs a BOFRecord and Sets its fields appropriately
  13689. @param in the RecordInputstream to Read the record from
  13690. </member>
  13691. <member name="P:NPOI.HSSF.Record.BOFRecord.Version">
  13692. Version number - for BIFF8 should be 0x06
  13693. @see #VERSION
  13694. @param version version to be Set
  13695. </member>
  13696. <member name="P:NPOI.HSSF.Record.BOFRecord.HistoryBitMask">
  13697. Set the history bit mask (not very useful)
  13698. @see #HISTORY_MASK
  13699. @param bitmask bitmask to Set for the history
  13700. </member>
  13701. <member name="P:NPOI.HSSF.Record.BOFRecord.RequiredVersion">
  13702. Set the minimum version required to Read this file
  13703. @see #VERSION
  13704. @param version version to Set
  13705. </member>
  13706. <member name="P:NPOI.HSSF.Record.BOFRecord.Type">
  13707. type of object this marks
  13708. @see #TYPE_WORKBOOK
  13709. @see #TYPE_VB_MODULE
  13710. @see #TYPE_WORKSHEET
  13711. @see #TYPE_CHART
  13712. @see #TYPE_EXCEL_4_MACRO
  13713. @see #TYPE_WORKSPACE_FILE
  13714. @return short type of object
  13715. </member>
  13716. <member name="P:NPOI.HSSF.Record.BOFRecord.Build">
  13717. Get the build that wrote this file
  13718. @see #BUILD
  13719. @return short build number of the generator of this file
  13720. </member>
  13721. <member name="P:NPOI.HSSF.Record.BOFRecord.BuildYear">
  13722. Year of the build that wrote this file
  13723. @see #BUILD_YEAR
  13724. @return short build year of the generator of this file
  13725. </member>
  13726. <member name="T:NPOI.HSSF.Record.BookBoolRecord">
  13727. Title: Save External Links record (BookBool)
  13728. Description: Contains a flag specifying whether the Gui should save externally
  13729. linked values from other workbooks.
  13730. REFERENCE: PG 289 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13731. @author Andrew C. Oliver (acoliver at apache dot org)
  13732. @version 2.0-pre
  13733. </member>
  13734. <member name="M:NPOI.HSSF.Record.BookBoolRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13735. Constructs a BookBoolRecord and Sets its fields appropriately
  13736. @param in the RecordInputstream to Read the record from
  13737. </member>
  13738. <member name="P:NPOI.HSSF.Record.BookBoolRecord.SaveLinkValues">
  13739. Get the save ext links flag
  13740. @return short 0/1 (off/on)
  13741. </member>
  13742. <member name="T:NPOI.HSSF.Record.BoolErrRecord">
  13743. Creates new BoolErrRecord.
  13744. REFERENCE: PG ??? Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13745. @author Michael P. Harhen
  13746. @author Jason Height (jheight at chariot dot net dot au)
  13747. @version 2.0-pre
  13748. </member>
  13749. <member name="M:NPOI.HSSF.Record.CellRecord.AppendValueText(System.Text.StringBuilder)">
  13750. Append specific debug info (used by {@link #toString()} for the value
  13751. contained in this record. Trailing new-line should not be Appended
  13752. (superclass does that).
  13753. </member>
  13754. <member name="M:NPOI.HSSF.Record.CellRecord.SerializeValue(NPOI.Util.ILittleEndianOutput)">
  13755. writes out the value data for this cell record
  13756. </member>
  13757. <member name="P:NPOI.HSSF.Record.CellRecord.XFIndex">
  13758. get the index to the ExtendedFormat
  13759. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  13760. @return index to the XF record
  13761. </member>
  13762. <member name="P:NPOI.HSSF.Record.CellRecord.RecordName">
  13763. Gets the debug info BIFF record type name (used by {@link #toString()}.
  13764. </member>
  13765. <member name="P:NPOI.HSSF.Record.CellRecord.ValueDataSize">
  13766. @return the size (in bytes) of the value data for this cell record
  13767. </member>
  13768. <member name="F:NPOI.HSSF.Record.BoolErrRecord._isError">
  13769. If <code>true</code>, this record represents an error cell value, otherwise this record represents a boolean cell value
  13770. </member>
  13771. <member name="M:NPOI.HSSF.Record.BoolErrRecord.#ctor">
  13772. Creates new BoolErrRecord
  13773. </member>
  13774. <member name="M:NPOI.HSSF.Record.BoolErrRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13775. Constructs a BoolErr record and Sets its fields appropriately.
  13776. @param in the RecordInputstream to Read the record from
  13777. </member>
  13778. <member name="M:NPOI.HSSF.Record.BoolErrRecord.SetValue(System.Boolean)">
  13779. Set the bool value for the cell
  13780. @param value representing the bool value
  13781. </member>
  13782. <member name="M:NPOI.HSSF.Record.BoolErrRecord.SetValue(System.Byte)">
  13783. Set the error value for the cell
  13784. @param value error representing the error value
  13785. this value can only be 0,7,15,23,29,36 or 42
  13786. see bugzilla bug 16560 for an explanation
  13787. </member>
  13788. <member name="P:NPOI.HSSF.Record.BoolErrRecord.BooleanValue">
  13789. Get the value for the cell
  13790. @return bool representing the bool value
  13791. </member>
  13792. <member name="P:NPOI.HSSF.Record.BoolErrRecord.ErrorValue">
  13793. Get the error value for the cell
  13794. @return byte representing the error value
  13795. </member>
  13796. <member name="P:NPOI.HSSF.Record.BoolErrRecord.IsBoolean">
  13797. Indicates whether the call holds a boolean value
  13798. @return boolean true if the cell holds a boolean value
  13799. </member>
  13800. <member name="P:NPOI.HSSF.Record.BoolErrRecord.IsError">
  13801. Indicates whether the call holds an error value
  13802. @return bool true if the cell holds an error value
  13803. </member>
  13804. <member name="T:NPOI.HSSF.Record.BottomMarginRecord">
  13805. Record for the bottom margin.
  13806. NOTE: This source was automatically generated.
  13807. @author Shawn Laubach (slaubach at apache dot org)
  13808. </member>
  13809. <member name="T:NPOI.HSSF.Record.IMargin">
  13810. The margin interface Is a parent used to define left, right, top and bottom margins.
  13811. This allows much of the code to be generic when it comes to handling margins.
  13812. NOTE: This source wass automatically generated.
  13813. @author Shawn Laubach (slaubach at apache dot org)
  13814. </member>
  13815. <member name="P:NPOI.HSSF.Record.IMargin.Margin">
  13816. Get the margin field for the Margin.
  13817. </member>
  13818. <member name="M:NPOI.HSSF.Record.BottomMarginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13819. Constructs a BottomMargin record and Sets its fields appropriately.
  13820. @param in the RecordInputstream to Read the record from
  13821. </member>
  13822. <member name="P:NPOI.HSSF.Record.BottomMarginRecord.Margin">
  13823. Get the margin field for the BottomMargin record.
  13824. </member>
  13825. <member name="T:NPOI.HSSF.Record.BoundSheetRecord">
  13826. Title: Bound Sheet Record (aka BundleSheet)
  13827. Description: Defines a sheet within a workbook. Basically stores the sheetname
  13828. and tells where the Beginning of file record Is within the HSSF
  13829. file.
  13830. REFERENCE: PG 291 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13831. @author Andrew C. Oliver (acoliver at apache dot org)
  13832. @author Sergei Kozello (sergeikozello at mail.ru)
  13833. </member>
  13834. <member name="M:NPOI.HSSF.Record.BoundSheetRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13835. Constructs a BoundSheetRecord and Sets its fields appropriately
  13836. @param in the RecordInputstream to Read the record from
  13837. </member>
  13838. <member name="M:NPOI.HSSF.Record.BoundSheetRecord.OrderByBofPosition(System.Collections.Generic.List{NPOI.HSSF.Record.BoundSheetRecord})">
  13839. Converts a List of {@link BoundSheetRecord}s to an array and sorts by the position of their
  13840. BOFs.
  13841. </member>
  13842. <member name="P:NPOI.HSSF.Record.BoundSheetRecord.PositionOfBof">
  13843. Get the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file
  13844. @return offset in bytes
  13845. </member>
  13846. <member name="P:NPOI.HSSF.Record.BoundSheetRecord.IsVeryHidden">
  13847. Is the sheet very hidden? Different from (normal) hidden
  13848. </member>
  13849. <member name="P:NPOI.HSSF.Record.BoundSheetRecord.Sheetname">
  13850. Get the sheetname for this sheet. (this appears in the tabs at the bottom)
  13851. @return sheetname the name of the sheet
  13852. </member>
  13853. <member name="T:NPOI.HSSF.Record.CalcCountRecord">
  13854. Title: Calc Count Record
  13855. Description: Specifies the maximum times the gui should perform a formula
  13856. recalculation. For instance: in the case a formula includes
  13857. cells that are themselves a result of a formula and a value
  13858. Changes. This Is essentially a failsafe against an infinate
  13859. loop in the event the formulas are not independant.
  13860. REFERENCE: PG 292 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13861. @author Andrew C. Oliver (acoliver at apache dot org)
  13862. @author Jason Height (jheight at chariot dot net dot au)
  13863. @version 2.0-pre
  13864. @see org.apache.poi.hssf.record.CalcModeRecord
  13865. </member>
  13866. <member name="M:NPOI.HSSF.Record.CalcCountRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13867. Constructs a CalcCountRecord and Sets its fields appropriately
  13868. @param in the RecordInputstream to Read the record from
  13869. </member>
  13870. <member name="P:NPOI.HSSF.Record.CalcCountRecord.Iterations">
  13871. Get the number of iterations to perform
  13872. @return iterations
  13873. </member>
  13874. <member name="T:NPOI.HSSF.Record.CalcModeRecord">
  13875. Title: Calc Mode Record
  13876. Description: Tells the gui whether to calculate formulas
  13877. automatically, manually or automatically
  13878. except for tables.
  13879. REFERENCE: PG 292 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13880. @author Andrew C. Oliver (acoliver at apache dot org)
  13881. @author Jason Height (jheight at chariot dot net dot au)
  13882. @version 2.0-pre
  13883. @see org.apache.poi.hssf.record.CalcCountRecord
  13884. </member>
  13885. <member name="F:NPOI.HSSF.Record.CalcModeRecord.MANUAL">
  13886. manually calculate formulas (0)
  13887. </member>
  13888. <member name="F:NPOI.HSSF.Record.CalcModeRecord.AUTOMATIC">
  13889. automatically calculate formulas (1)
  13890. </member>
  13891. <member name="F:NPOI.HSSF.Record.CalcModeRecord.AUTOMATIC_EXCEPT_TABLES">
  13892. automatically calculate formulas except for tables (-1)
  13893. </member>
  13894. <member name="M:NPOI.HSSF.Record.CalcModeRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13895. Constructs a CalcModeRecord and Sets its fields appropriately
  13896. @param in the RecordInputstream to Read the record from
  13897. </member>
  13898. <member name="M:NPOI.HSSF.Record.CalcModeRecord.SetCalcMode(System.Int16)">
  13899. Set the calc mode flag for formulas
  13900. @see #MANUAL
  13901. @see #AUTOMATIC
  13902. @see #AUTOMATIC_EXCEPT_TABLES
  13903. @param calcmode one of the three flags above
  13904. </member>
  13905. <member name="M:NPOI.HSSF.Record.CalcModeRecord.GetCalcMode">
  13906. Get the calc mode flag for formulas
  13907. @see #MANUAL
  13908. @see #AUTOMATIC
  13909. @see #AUTOMATIC_EXCEPT_TABLES
  13910. @return calcmode one of the three flags above
  13911. </member>
  13912. <member name="T:NPOI.HSSF.Record.CFHeaderRecord">
  13913. Conditional Formatting Header record (CFHEADER)
  13914. @author Dmitriy Kumshayev
  13915. </member>
  13916. <member name="M:NPOI.HSSF.Record.CFHeaderRecord.#ctor">
  13917. Creates new CFHeaderRecord
  13918. </member>
  13919. <member name="T:NPOI.HSSF.Record.CFRuleRecord">
  13920. Conditional Formatting Rule Record.
  13921. @author Dmitriy Kumshayev
  13922. </member>
  13923. <member name="M:NPOI.HSSF.Record.CFRuleRecord.#ctor(System.Byte,NPOI.SS.UserModel.ComparisonOperator)">
  13924. Creates new CFRuleRecord
  13925. </member>
  13926. <member name="M:NPOI.HSSF.Record.CFRuleRecord.Create(NPOI.HSSF.UserModel.HSSFWorkbook,System.String)">
  13927. Creates a new comparison operation rule
  13928. </member>
  13929. <member name="M:NPOI.HSSF.Record.CFRuleRecord.Create(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.SS.UserModel.ComparisonOperator,System.String,System.String)">
  13930. Creates a new comparison operation rule
  13931. </member>
  13932. <member name="M:NPOI.HSSF.Record.CFRuleRecord.Create(NPOI.HSSF.UserModel.HSSFSheet,System.Byte,System.String,System.String)">
  13933. Creates a new comparison operation rule
  13934. </member>
  13935. <member name="M:NPOI.HSSF.Record.CFRuleRecord.GetFormulaSize(NPOI.SS.Formula.Formula)">
  13936. @param ptgs may be <c>null</c>
  13937. @return encoded size of the formula
  13938. </member>
  13939. <member name="M:NPOI.HSSF.Record.CFRuleRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  13940. called by the class that Is responsible for writing this sucker.
  13941. Subclasses should implement this so that their data Is passed back in a
  13942. byte array.
  13943. @param offset to begin writing at
  13944. @param data byte array containing instance data
  13945. @return number of bytes written
  13946. </member>
  13947. <member name="M:NPOI.HSSF.Record.CFRuleRecord.ParseFormula(System.String,NPOI.HSSF.UserModel.HSSFWorkbook)">
  13948. TODO - Parse conditional format formulas properly i.e. produce tRefN and tAreaN instead of tRef and tArea
  13949. this call will produce the wrong results if the formula Contains any cell references
  13950. One approach might be to apply the inverse of SharedFormulaRecord.ConvertSharedFormulas(Stack, int, int)
  13951. Note - two extra parameters (rowIx &amp;colIx) will be required. They probably come from one of the Region objects.
  13952. @return <c>null</c> if <c>formula</c> was null.
  13953. </member>
  13954. <member name="M:NPOI.HSSF.Record.CFRuleRecord.ParseFormula(System.String,NPOI.HSSF.UserModel.HSSFSheet)">
  13955. TODO - parse conditional format formulas properly i.e. produce tRefN and tAreaN instead of tRef and tArea
  13956. this call will produce the wrong results if the formula contains any cell references
  13957. One approach might be to apply the inverse of SharedFormulaRecord.convertSharedFormulas(Stack, int, int)
  13958. Note - two extra parameters (rowIx &amp; colIx) will be required. They probably come from one of the Region objects.
  13959. @return <code>null</code> if <c>formula</c> was null.
  13960. </member>
  13961. <member name="P:NPOI.HSSF.Record.CFRuleRecord.ParsedExpression1">
  13962. get the stack of the 1st expression as a list
  13963. @return list of tokens (casts stack to a list and returns it!)
  13964. this method can return null is we are unable to create Ptgs from
  13965. existing excel file
  13966. callers should check for null!
  13967. </member>
  13968. <member name="P:NPOI.HSSF.Record.CFRuleRecord.ParsedExpression2">
  13969. get the stack of the 2nd expression as a list
  13970. @return list of tokens (casts stack to a list and returns it!)
  13971. this method can return null is we are unable to create Ptgs from
  13972. existing excel file
  13973. callers should check for null!
  13974. </member>
  13975. <member name="P:NPOI.HSSF.Record.CFRuleRecord.Options">
  13976. Get the option flags
  13977. @return bit mask
  13978. </member>
  13979. <member name="T:NPOI.HSSF.Record.CF.BorderFormatting">
  13980. Border Formatting Block of the Conditional Formatting Rule Record.
  13981. @author Dmitriy Kumshayev
  13982. </member>
  13983. <member name="M:NPOI.HSSF.Record.CF.BorderFormatting.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13984. Creates new FontFormatting
  13985. </member>
  13986. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderLeft">
  13987. <summary>
  13988. Get the type of border to use for the left border of the cell
  13989. </summary>
  13990. </member>
  13991. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderRight">
  13992. <summary>
  13993. Get the type of border to use for the right border of the cell
  13994. </summary>
  13995. </member>
  13996. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderTop">
  13997. <summary>
  13998. Get the type of border to use for the top border of the cell
  13999. </summary>
  14000. </member>
  14001. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderBottom">
  14002. <summary>
  14003. Get the type of border to use for the bottom border of the cell
  14004. </summary>
  14005. </member>
  14006. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderDiagonal">
  14007. <summary>
  14008. Get the type of border to use for the diagonal border of the cell
  14009. </summary>
  14010. </member>
  14011. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.LeftBorderColor">
  14012. <summary>
  14013. Get the color to use for the left border
  14014. </summary>
  14015. </member>
  14016. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.RightBorderColor">
  14017. <summary>
  14018. Get the color to use for the right border
  14019. </summary>
  14020. </member>
  14021. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.TopBorderColor">
  14022. <summary>
  14023. Get the color to use for the top border
  14024. </summary>
  14025. </member>
  14026. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BottomBorderColor">
  14027. <summary>
  14028. Get the color to use for the bottom border
  14029. </summary>
  14030. </member>
  14031. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.DiagonalBorderColor">
  14032. <summary>
  14033. Get the color to use for the diagonal border
  14034. </summary>
  14035. </member>
  14036. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.IsForwardDiagonalOn">
  14037. <summary>
  14038. true if forward diagonal is on
  14039. </summary>
  14040. </member>
  14041. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.IsBackwardDiagonalOn">
  14042. <summary>
  14043. true if backward diagonal Is on
  14044. </summary>
  14045. </member>
  14046. <member name="T:NPOI.HSSF.Record.CF.CellRangeUtil">
  14047. @author Dmitriy Kumshayev
  14048. </member>
  14049. <member name="F:NPOI.HSSF.Record.CF.CellRangeUtil.INSIDE">
  14050. first range is within the second range
  14051. </member>
  14052. <member name="F:NPOI.HSSF.Record.CF.CellRangeUtil.ENCLOSES">
  14053. first range encloses or is equal to the second
  14054. </member>
  14055. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.Intersect(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  14056. Intersect this range with the specified range.
  14057. @param crB - the specified range
  14058. @return code which reflects how the specified range is related to this range.<br/>
  14059. Possible return codes are:
  14060. NO_INTERSECTION - the specified range is outside of this range;<br/>
  14061. OVERLAP - both ranges partially overlap;<br/>
  14062. INSIDE - the specified range is inside of this one<br/>
  14063. ENCLOSES - the specified range encloses (possibly exactly the same as) this range<br/>
  14064. </member>
  14065. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.MergeCellRanges(NPOI.SS.Util.CellRangeAddress[])">
  14066. Do all possible cell merges between cells of the list so that:
  14067. if a cell range is completely inside of another cell range, it s removed from the list
  14068. if two cells have a shared border, merge them into one bigger cell range
  14069. @param cellRangeList
  14070. @return updated List of cell ranges
  14071. </member>
  14072. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.MergeRanges(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  14073. @return the new range(s) to replace the supplied ones. <c>null</c> if no merge is possible
  14074. </member>
  14075. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.ToArray(System.Collections.ArrayList)">
  14076. **
  14077. </member>
  14078. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.Contains(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  14079. Check if the specified range is located inside of this cell range.
  14080. @param crB
  14081. @return true if this cell range Contains the argument range inside if it's area
  14082. </member>
  14083. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.HasExactSharedBorder(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  14084. Check if the specified cell range has a shared border with the current range.
  14085. @return <c>true</c> if the ranges have a complete shared border (i.e.
  14086. the two ranges toher make a simple rectangular region.
  14087. </member>
  14088. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.CreateEnclosingCellRange(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  14089. Create an enclosing CellRange for the two cell ranges.
  14090. @return enclosing CellRange
  14091. </member>
  14092. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.lt(System.Int32,System.Int32)">
  14093. @return true if a &lt; b
  14094. </member>
  14095. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.le(System.Int32,System.Int32)">
  14096. @return true if a &lt;= b
  14097. </member>
  14098. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.gt(System.Int32,System.Int32)">
  14099. @return true if a > b
  14100. </member>
  14101. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.ge(System.Int32,System.Int32)">
  14102. @return true if a >= b
  14103. </member>
  14104. <member name="T:NPOI.HSSF.Record.CF.FontFormatting">
  14105. Font Formatting Block of the Conditional Formatting Rule Record.
  14106. @author Dmitriy Kumshayev
  14107. </member>
  14108. <member name="F:NPOI.HSSF.Record.CF.FontFormatting.FONT_WEIGHT_NORMAL">
  14109. Normal boldness (not bold)
  14110. </member>
  14111. <member name="F:NPOI.HSSF.Record.CF.FontFormatting.FONT_WEIGHT_BOLD">
  14112. Bold boldness (bold)
  14113. </member>
  14114. <member name="M:NPOI.HSSF.Record.CF.FontFormatting.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14115. Creates new FontFormatting
  14116. </member>
  14117. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.FontHeight">
  14118. Gets the height of the font in 1/20th point Units
  14119. @return fontheight (in points/20); or -1 if not modified
  14120. </member>
  14121. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.IsItalic">
  14122. Get whether the font Is to be italics or not
  14123. @return italics - whether the font Is italics or not
  14124. @see #GetAttributes()
  14125. </member>
  14126. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.IsStruckout">
  14127. Get whether the font Is to be stricken out or not
  14128. @return strike - whether the font Is stricken out or not
  14129. @see #GetAttributes()
  14130. </member>
  14131. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.FontWeight">
  14132. <summary>
  14133. Get or set the font weight for this font (100-1000dec or 0x64-0x3e8).
  14134. Default Is 0x190 for normal and 0x2bc for bold
  14135. </summary>
  14136. </member>
  14137. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.IsBold">
  14138. <summary>
  14139. Get or set whether the font weight is set to bold or not
  14140. </summary>
  14141. </member>
  14142. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.EscapementType">
  14143. Get the type of base or subscript for the font
  14144. @return base or subscript option
  14145. @see org.apache.poi.hssf.usermodel.HSSFFontFormatting#SS_NONE
  14146. @see org.apache.poi.hssf.usermodel.HSSFFontFormatting#SS_SUPER
  14147. @see org.apache.poi.hssf.usermodel.HSSFFontFormatting#SS_SUB
  14148. </member>
  14149. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.UnderlineType">
  14150. Get the type of Underlining for the font
  14151. @return font Underlining type
  14152. </member>
  14153. <member name="T:NPOI.HSSF.Record.CF.PatternFormatting">
  14154. Pattern Formatting Block of the Conditional Formatting Rule Record.
  14155. @author Dmitriy Kumshayev
  14156. </member>
  14157. <member name="M:NPOI.HSSF.Record.CF.PatternFormatting.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14158. Creates new FontFormatting
  14159. </member>
  14160. <member name="P:NPOI.HSSF.Record.CF.PatternFormatting.FillPattern">
  14161. Get the Fill pattern
  14162. @return Fill pattern
  14163. </member>
  14164. <member name="P:NPOI.HSSF.Record.CF.PatternFormatting.FillBackgroundColor">
  14165. Get the background Fill color
  14166. @see org.apache.poi.hssf.usermodel.HSSFPalette#GetColor(short)
  14167. @return Fill color
  14168. </member>
  14169. <member name="P:NPOI.HSSF.Record.CF.PatternFormatting.FillForegroundColor">
  14170. Get the foreground Fill color
  14171. @see org.apache.poi.hssf.usermodel.HSSFPalette#GetColor(short)
  14172. @return Fill color
  14173. </member>
  14174. <member name="T:NPOI.HSSF.Record.Chart.AreaFormatRecord">
  14175. * The area format record is used to define the colours and patterns for an area.
  14176. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14177. * Remove the record in src/records/definitions.
  14178. * @author Glen Stampoultzis (glens at apache.org)
  14179. </member>
  14180. <member name="M:NPOI.HSSF.Record.Chart.AreaFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14181. Constructs a AreaFormat record and s its fields appropriately.
  14182. @param in the RecordInputstream to Read the record from
  14183. </member>
  14184. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.DataSize">
  14185. Size of record (exluding 4 byte header)
  14186. </member>
  14187. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.ForegroundColor">
  14188. the foreground color field for the AreaFormat record.
  14189. </member>
  14190. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.BackgroundColor">
  14191. the background color field for the AreaFormat record.
  14192. </member>
  14193. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.Pattern">
  14194. the pattern field for the AreaFormat record.
  14195. </member>
  14196. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.FormatFlags">
  14197. the format flags field for the AreaFormat record.
  14198. </member>
  14199. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.ForecolorIndex">
  14200. the forecolor index field for the AreaFormat record.
  14201. </member>
  14202. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.BackcolorIndex">
  14203. the backcolor index field for the AreaFormat record.
  14204. </member>
  14205. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.IsAutomatic">
  14206. automatic formatting
  14207. @return the automatic field value.
  14208. </member>
  14209. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.IsInvert">
  14210. swap foreground and background colours when data is negative
  14211. @return the invert field value.
  14212. </member>
  14213. <member name="T:NPOI.HSSF.Record.Chart.AreaRecord">
  14214. * The area record is used to define a area chart.
  14215. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14216. * Remove the record in src/records/definitions.
  14217. * @author Glen Stampoultzis (glens at apache.org)
  14218. </member>
  14219. <member name="M:NPOI.HSSF.Record.Chart.AreaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14220. Constructs a Area record and s its fields appropriately.
  14221. @param in the RecordInputstream to Read the record from
  14222. </member>
  14223. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.DataSize">
  14224. Size of record (exluding 4 byte header)
  14225. </member>
  14226. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.FormatFlags">
  14227. the format flags field for the Area record.
  14228. </member>
  14229. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.IsStacked">
  14230. series is stacked
  14231. @return the stacked field value.
  14232. </member>
  14233. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.IsDisplayAsPercentage">
  14234. results Displayed as percentages
  14235. @return the Display as percentage field value.
  14236. </member>
  14237. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.IsShadow">
  14238. Display a shadow for the chart
  14239. @return the shadow field value.
  14240. </member>
  14241. <member name="T:NPOI.HSSF.Record.Chart.AxisParentRecord">
  14242. * The axis size and location
  14243. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14244. * Remove the record in src/records/definitions.
  14245. * @author Glen Stampoultzis (glens at apache.org)
  14246. </member>
  14247. <member name="M:NPOI.HSSF.Record.Chart.AxisParentRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14248. Constructs a AxisParent record and s its fields appropriately.
  14249. @param in the RecordInputstream to Read the record from
  14250. </member>
  14251. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.DataSize">
  14252. Size of record (exluding 4 byte header)
  14253. </member>
  14254. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.AxisType">
  14255. the axis type field for the AxisParent record.
  14256. @return One of
  14257. AXIS_TYPE_MAIN
  14258. AXIS_TYPE_SECONDARY
  14259. </member>
  14260. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.X">
  14261. the x field for the AxisParent record.
  14262. </member>
  14263. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.Y">
  14264. the y field for the AxisParent record.
  14265. </member>
  14266. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.Width">
  14267. the width field for the AxisParent record.
  14268. </member>
  14269. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.Height">
  14270. the height field for the AxisParent record.
  14271. </member>
  14272. <member name="T:NPOI.HSSF.Record.Chart.AxisRecord">
  14273. * The axis record defines the type of an axis.
  14274. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14275. * Remove the record in src/records/definitions.
  14276. * @author Glen Stampoultzis (glens at apache.org)
  14277. </member>
  14278. <member name="M:NPOI.HSSF.Record.Chart.AxisRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14279. Constructs a Axis record and Sets its fields appropriately.
  14280. @param in the RecordInputstream to Read the record from
  14281. </member>
  14282. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.DataSize">
  14283. Size of record (exluding 4 byte header)
  14284. </member>
  14285. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.AxisType">
  14286. Get the axis type field for the Axis record.
  14287. @return One of
  14288. AXIS_TYPE_CATEGORY_OR_X_AXIS
  14289. AXIS_TYPE_VALUE_AXIS
  14290. AXIS_TYPE_SERIES_AXIS
  14291. </member>
  14292. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.Reserved1">
  14293. Get the reserved1 field for the Axis record.
  14294. </member>
  14295. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.Reserved2">
  14296. Get the reserved2 field for the Axis record.
  14297. </member>
  14298. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.Reserved3">
  14299. Get the reserved3 field for the Axis record.
  14300. </member>
  14301. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.Reserved4">
  14302. Get the reserved4 field for the Axis record.
  14303. </member>
  14304. <member name="T:NPOI.HSSF.Record.Chart.BarRecord">
  14305. * The bar record is used to define a bar chart.
  14306. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14307. * Remove the record in src/records/definitions.
  14308. * @author Glen Stampoultzis (glens at apache.org)
  14309. </member>
  14310. <member name="M:NPOI.HSSF.Record.Chart.BarRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14311. Constructs a Bar record and s its fields appropriately.
  14312. @param in the RecordInputstream to Read the record from
  14313. </member>
  14314. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.DataSize">
  14315. Size of record (exluding 4 byte header)
  14316. </member>
  14317. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.BarSpace">
  14318. the bar space field for the Bar record.
  14319. </member>
  14320. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.CategorySpace">
  14321. the category space field for the Bar record.
  14322. </member>
  14323. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.FormatFlags">
  14324. the format flags field for the Bar record.
  14325. </member>
  14326. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.IsHorizontal">
  14327. true to Display horizontal bar charts, false for vertical
  14328. @return the horizontal field value.
  14329. </member>
  14330. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.IsStacked">
  14331. stack Displayed values
  14332. @return the stacked field value.
  14333. </member>
  14334. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.IsDisplayAsPercentage">
  14335. Display chart values as a percentage
  14336. @return the Display as percentage field value.
  14337. </member>
  14338. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.IsShadow">
  14339. Display a shadow for the chart
  14340. @return the shadow field value.
  14341. </member>
  14342. <member name="T:NPOI.HSSF.Record.Chart.BeginRecord">
  14343. The begin record defines the start of a block of records for a (grpahing
  14344. data object. This record is matched with a corresponding EndRecord.
  14345. @see EndRecord
  14346. @author Glen Stampoultzis (glens at apache.org)
  14347. </member>
  14348. <member name="M:NPOI.HSSF.Record.Chart.BeginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14349. Constructs a BeginRecord record and Sets its fields appropriately.
  14350. @param in the RecordInputstream to Read the record from
  14351. </member>
  14352. <member name="T:NPOI.HSSF.Record.Chart.CatLabRecord">
  14353. CATLAB - Category Labels (0x0856)<br/>
  14354. @author Patrick Cheng
  14355. </member>
  14356. <member name="T:NPOI.HSSF.Record.Chart.ChartEndBlockRecord">
  14357. ENDBLOCK - Chart Future Record Type End Block (0x0853)<br/>
  14358. @author Patrick Cheng
  14359. </member>
  14360. <member name="T:NPOI.HSSF.Record.Chart.ChartEndObjectRecord">
  14361. ENDOBJECT - Chart Future Record Type End Object (0x0855)<br/>
  14362. @author Patrick Cheng
  14363. </member>
  14364. <member name="T:NPOI.HSSF.Record.ChartFormatRecord">
  14365. Class ChartFormatRecord
  14366. @author Glen Stampoultzis (glens at apache.org)
  14367. @version %I%, %G%
  14368. </member>
  14369. <member name="M:NPOI.HSSF.Record.ChartFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14370. Constructs a ChartFormatRecord record and Sets its fields appropriately.
  14371. @param in the RecordInputstream to Read the record from
  14372. </member>
  14373. <member name="T:NPOI.HSSF.Record.Chart.ChartFRTInfoRecord">
  14374. <summary>
  14375. The ChartFrtInfo record specifies the versions of the application that originally created and last saved the file.
  14376. </summary>
  14377. </member>
  14378. <member name="T:NPOI.HSSF.Record.Chart.ChartRecord">
  14379. * The chart record is used to define the location and size of a chart.
  14380. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14381. * Remove the record in src/records/definitions.
  14382. * @author Glen Stampoultzis (glens at apache.org)
  14383. </member>
  14384. <member name="M:NPOI.HSSF.Record.Chart.ChartRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14385. Constructs a Chart record and Sets its fields appropriately.
  14386. @param in the RecordInputstream to Read the record from
  14387. </member>
  14388. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.DataSize">
  14389. Size of record (exluding 4 byte header)
  14390. </member>
  14391. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.X">
  14392. Get the x field for the Chart record.
  14393. </member>
  14394. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.Y">
  14395. Get the y field for the Chart record.
  14396. </member>
  14397. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.Width">
  14398. Get the width field for the Chart record.
  14399. </member>
  14400. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.Height">
  14401. Get the height field for the Chart record.
  14402. </member>
  14403. <member name="T:NPOI.HSSF.Record.Chart.ChartStartBlockRecord">
  14404. STARTBLOCK - Chart Future Record Type Start Block (0x0852)<br/>
  14405. @author Patrick Cheng
  14406. </member>
  14407. <member name="T:NPOI.HSSF.Record.Chart.ChartStartObjectRecord">
  14408. STARTOBJECT - Chart Future Record Type Start Object (0x0854)<br/>
  14409. @author Patrick Cheng
  14410. </member>
  14411. <member name="T:NPOI.HSSF.Record.Chart.CrtLinkRecord">
  14412. <summary>
  14413. The CrtLink record is written but unused.
  14414. </summary>
  14415. </member>
  14416. <member name="T:NPOI.HSSF.Record.Chart.DataFormatRecord">
  14417. * The data format record is used to index into a series.
  14418. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14419. * Remove the record in src/records/definitions.
  14420. * @author Glen Stampoultzis (glens at apache.org)
  14421. </member>
  14422. <member name="M:NPOI.HSSF.Record.Chart.DataFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14423. Constructs a DataFormat record and Sets its fields appropriately.
  14424. @param in the RecordInputstream to Read the record from
  14425. </member>
  14426. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.DataSize">
  14427. Size of record (exluding 4 byte header)
  14428. </member>
  14429. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.PointNumber">
  14430. Get the point number field for the DataFormat record.
  14431. </member>
  14432. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.SeriesIndex">
  14433. Get the series index field for the DataFormat record.
  14434. </member>
  14435. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.SeriesNumber">
  14436. Get the series number field for the DataFormat record.
  14437. </member>
  14438. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.FormatFlags">
  14439. Get the format flags field for the DataFormat record.
  14440. </member>
  14441. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.UseExcel4Colors">
  14442. Set true to use excel 4 colors.
  14443. @return the use excel 4 colors field value.
  14444. </member>
  14445. <member name="T:NPOI.HSSF.Record.Chart.DataLabelExtensionRecord">
  14446. DATALABEXT - Chart Data Label Extension (0x086A) <br/>
  14447. @author Patrick Cheng
  14448. </member>
  14449. <member name="T:NPOI.HSSF.Record.Chart.DatRecord">
  14450. * The dat record is used to store options for the chart.
  14451. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14452. * Remove the record in src/records/definitions.
  14453. * @author Glen Stampoultzis (glens at apache.org)
  14454. </member>
  14455. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14456. Constructs a Dat record and Sets its fields appropriately.
  14457. @param in the RecordInputstream to Read the record from
  14458. </member>
  14459. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.SetHorizontalBorder(System.Boolean)">
  14460. Sets the horizontal border field value.
  14461. has a horizontal border
  14462. </member>
  14463. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.IsHorizontalBorder">
  14464. has a horizontal border
  14465. @return the horizontal border field value.
  14466. </member>
  14467. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.SetVerticalBorder(System.Boolean)">
  14468. Sets the vertical border field value.
  14469. has vertical border
  14470. </member>
  14471. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.IsVerticalBorder">
  14472. has vertical border
  14473. @return the vertical border field value.
  14474. </member>
  14475. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.SetBorder(System.Boolean)">
  14476. Sets the border field value.
  14477. data table has a border
  14478. </member>
  14479. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.IsBorder">
  14480. data table has a border
  14481. @return the border field value.
  14482. </member>
  14483. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.SetShowSeriesKey(System.Boolean)">
  14484. Sets the show series key field value.
  14485. shows the series key
  14486. </member>
  14487. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.IsShowSeriesKey">
  14488. shows the series key
  14489. @return the show series key field value.
  14490. </member>
  14491. <member name="P:NPOI.HSSF.Record.Chart.DatRecord.DataSize">
  14492. Size of record (exluding 4 byte header)
  14493. </member>
  14494. <member name="P:NPOI.HSSF.Record.Chart.DatRecord.Options">
  14495. Get the options field for the Dat record.
  14496. </member>
  14497. <member name="T:NPOI.HSSF.Record.Chart.EndRecord">
  14498. The end record defines the end of a block of records for a (Graphing)
  14499. data object. This record is matched with a corresponding BeginRecord.
  14500. @see BeginRecord
  14501. @author Glen Stampoultzis (glens at apache.org)
  14502. </member>
  14503. <member name="M:NPOI.HSSF.Record.Chart.EndRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14504. Constructs a EndRecord record and Sets its fields appropriately.
  14505. @param in the RecordInputstream to Read the record from
  14506. </member>
  14507. <member name="T:NPOI.HSSF.Record.Chart.FontBasisRecord">
  14508. * The font basis record stores various font metrics.
  14509. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14510. * Remove the record in src/records/definitions.
  14511. * @author Glen Stampoultzis (glens at apache.org)
  14512. </member>
  14513. <member name="M:NPOI.HSSF.Record.Chart.FontBasisRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14514. Constructs a FontBasis record and Sets its fields appropriately.
  14515. @param in the RecordInputstream to Read the record from
  14516. </member>
  14517. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.DataSize">
  14518. Size of record (exluding 4 byte header)
  14519. </member>
  14520. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.XBasis">
  14521. Get the x Basis field for the FontBasis record.
  14522. </member>
  14523. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.YBasis">
  14524. Get the y Basis field for the FontBasis record.
  14525. </member>
  14526. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.HeightBasis">
  14527. Get the height basis field for the FontBasis record.
  14528. </member>
  14529. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.Scale">
  14530. Get the scale field for the FontBasis record.
  14531. </member>
  14532. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.IndexToFontTable">
  14533. Get the index to font table field for the FontBasis record.
  14534. </member>
  14535. <member name="T:NPOI.HSSF.Record.Chart.FrameRecord">
  14536. * The frame record indicates whether there is a border around the Displayed text of a chart.
  14537. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14538. * Remove the record in src/records/definitions.
  14539. * @author Glen Stampoultzis (glens at apache.org)
  14540. </member>
  14541. <member name="M:NPOI.HSSF.Record.Chart.FrameRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14542. Constructs a Frame record and Sets its fields appropriately.
  14543. @param in the RecordInputstream to Read the record from
  14544. </member>
  14545. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.DataSize">
  14546. Size of record (exluding 4 byte header)
  14547. </member>
  14548. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.BorderType">
  14549. Get the border type field for the Frame record.
  14550. @return One of
  14551. BORDER_TYPE_REGULAR
  14552. BORDER_TYPE_SHADOW
  14553. </member>
  14554. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.Options">
  14555. Get the options field for the Frame record.
  14556. </member>
  14557. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.IsAutoSize">
  14558. excel calculates the size automatically if true
  14559. @return the auto size field value.
  14560. </member>
  14561. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.IsAutoPosition">
  14562. excel calculates the position automatically
  14563. @return the auto position field value.
  14564. </member>
  14565. <member name="T:NPOI.HSSF.Record.Chart.LegendRecord">
  14566. * Defines a legend for a chart.
  14567. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14568. * Remove the record in src/records/definitions.
  14569. * @author Andrew C. Oliver (acoliver at apache.org)
  14570. </member>
  14571. <member name="M:NPOI.HSSF.Record.Chart.LegendRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14572. Constructs a Legend record and Sets its fields appropriately.
  14573. @param in the RecordInputstream to Read the record from
  14574. </member>
  14575. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.DataSize">
  14576. Size of record (exluding 4 byte header)
  14577. </member>
  14578. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.XAxisUpperLeft">
  14579. Get the x axis upper left field for the Legend record.
  14580. </member>
  14581. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.YAxisUpperLeft">
  14582. Get the y axis upper left field for the Legend record.
  14583. </member>
  14584. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.XSize">
  14585. Get the x size field for the Legend record.
  14586. </member>
  14587. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.YSize">
  14588. Get the y size field for the Legend record.
  14589. </member>
  14590. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.Type">
  14591. Get the type field for the Legend record.
  14592. @return One of
  14593. TYPE_BOTTOM
  14594. TYPE_CORNER
  14595. TYPE_TOP
  14596. TYPE_RIGHT
  14597. TYPE_LEFT
  14598. TYPE_UNDOCKED
  14599. </member>
  14600. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.Spacing">
  14601. Get the spacing field for the Legend record.
  14602. @return One of
  14603. SPACING_CLOSE
  14604. SPACING_MEDIUM
  14605. SPACING_OPEN
  14606. </member>
  14607. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.Options">
  14608. Get the options field for the Legend record.
  14609. </member>
  14610. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsAutoPosition">
  14611. automatic positioning (1=docked)
  14612. @return the auto position field value.
  14613. </member>
  14614. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsAutoSeries">
  14615. excel 5 only (true)
  14616. @return the auto series field value.
  14617. </member>
  14618. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsAutoXPositioning">
  14619. position of legend on the x axis is automatic
  14620. @return the auto x positioning field value.
  14621. </member>
  14622. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsAutoYPositioning">
  14623. position of legend on the y axis is automatic
  14624. @return the auto y positioning field value.
  14625. </member>
  14626. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsVertical">
  14627. vertical or horizontal legend (1 or 0 respectively). Always 0 if not automatic.
  14628. @return the vertical field value.
  14629. </member>
  14630. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsDataTable">
  14631. 1 if chart Contains data table
  14632. @return the data table field value.
  14633. </member>
  14634. <member name="T:NPOI.HSSF.Record.Chart.LineFormatRecord">
  14635. * Describes a line format record. The line format record controls how a line on a chart appears.
  14636. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14637. * Remove the record in src/records/definitions.
  14638. * @author Glen Stampoultzis (glens at apache.org)
  14639. </member>
  14640. <member name="M:NPOI.HSSF.Record.Chart.LineFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14641. Constructs a LineFormat record and Sets its fields appropriately.
  14642. @param in the RecordInputstream to Read the record from
  14643. </member>
  14644. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.DataSize">
  14645. Size of record (exluding 4 byte header)
  14646. </member>
  14647. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.LineColor">
  14648. Get the line color field for the LineFormat record.
  14649. </member>
  14650. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.LinePattern">
  14651. Get the line pattern field for the LineFormat record.
  14652. @return One of
  14653. LINE_PATTERN_SOLID
  14654. LINE_PATTERN_DASH
  14655. LINE_PATTERN_DOT
  14656. LINE_PATTERN_DASH_DOT
  14657. LINE_PATTERN_DASH_DOT_DOT
  14658. LINE_PATTERN_NONE
  14659. LINE_PATTERN_DARK_GRAY_PATTERN
  14660. LINE_PATTERN_MEDIUM_GRAY_PATTERN
  14661. LINE_PATTERN_LIGHT_GRAY_PATTERN
  14662. </member>
  14663. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.Weight">
  14664. Get the weight field for the LineFormat record.
  14665. specifies the thickness of the line.
  14666. @return One of
  14667. WEIGHT_HAIRLINE
  14668. WEIGHT_NARROW
  14669. WEIGHT_MEDIUM
  14670. WEIGHT_WIDE
  14671. </member>
  14672. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.Format">
  14673. Get the format field for the LineFormat record.
  14674. </member>
  14675. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.ColourPaletteIndex">
  14676. Get the colour palette index field for the LineFormat record.
  14677. </member>
  14678. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.IsAuto">
  14679. automatic format
  14680. @return the auto field value.
  14681. </member>
  14682. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.IsDrawTicks">
  14683. draw tick marks
  14684. @return the draw ticks field value.
  14685. </member>
  14686. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.IsUnknown">
  14687. book marks this as reserved = 0 but it seems to do something
  14688. @return the Unknown field value.
  14689. </member>
  14690. <member name="T:NPOI.HSSF.Record.Chart.NumberFormatIndexRecord">
  14691. * The number format index record indexes format table. This applies to an axis.
  14692. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14693. * Remove the record in src/records/definitions.
  14694. * @author Glen Stampoultzis (glens at apache.org)
  14695. </member>
  14696. <member name="M:NPOI.HSSF.Record.Chart.NumberFormatIndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14697. Constructs a NumberFormatIndex record and Sets its fields appropriately.
  14698. @param in the RecordInputstream to Read the record from
  14699. </member>
  14700. <member name="P:NPOI.HSSF.Record.Chart.NumberFormatIndexRecord.DataSize">
  14701. Size of record (exluding 4 byte header)
  14702. </member>
  14703. <member name="P:NPOI.HSSF.Record.Chart.NumberFormatIndexRecord.FormatIndex">
  14704. Get the format index field for the NumberFormatIndex record.
  14705. </member>
  14706. <member name="T:NPOI.HSSF.Record.Chart.ObjectLinkRecord">
  14707. * Links text to an object on the chart or identifies it as the title.
  14708. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14709. * Remove the record in src/records/definitions.
  14710. * @author Andrew C. Oliver (acoliver at apache.org)
  14711. </member>
  14712. <member name="M:NPOI.HSSF.Record.Chart.ObjectLinkRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14713. Constructs a ObjectLink record and Sets its fields appropriately.
  14714. @param in the RecordInputstream to Read the record from
  14715. </member>
  14716. <member name="P:NPOI.HSSF.Record.Chart.ObjectLinkRecord.DataSize">
  14717. Size of record (exluding 4 byte header)
  14718. </member>
  14719. <member name="P:NPOI.HSSF.Record.Chart.ObjectLinkRecord.AnchorId">
  14720. Get the anchor id field for the ObjectLink record.
  14721. @return One of
  14722. ANCHOR_ID_CHART_TITLE
  14723. ANCHOR_ID_Y_AXIS
  14724. ANCHOR_ID_X_AXIS
  14725. ANCHOR_ID_SERIES_OR_POINT
  14726. ANCHOR_ID_Z_AXIS
  14727. </member>
  14728. <member name="P:NPOI.HSSF.Record.Chart.ObjectLinkRecord.Link1">
  14729. Get the link 1 field for the ObjectLink record.
  14730. </member>
  14731. <member name="P:NPOI.HSSF.Record.Chart.ObjectLinkRecord.Link2">
  14732. Get the link 2 field for the ObjectLink record.
  14733. </member>
  14734. <member name="T:NPOI.HSSF.Record.Chart.PlotAreaRecord">
  14735. * preceeds and identifies a frame as belonging to the plot area.
  14736. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14737. * Remove the record in src/records/definitions.
  14738. * @author Andrew C. Oliver (acoliver at apache.org)
  14739. </member>
  14740. <member name="M:NPOI.HSSF.Record.Chart.PlotAreaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14741. Constructs a PlotArea record and Sets its fields appropriately.
  14742. @param in the RecordInputstream to Read the record from
  14743. </member>
  14744. <member name="P:NPOI.HSSF.Record.Chart.PlotAreaRecord.DataSize">
  14745. Size of record (exluding 4 byte header)
  14746. </member>
  14747. <member name="T:NPOI.HSSF.Record.Chart.PlotGrowthRecord">
  14748. * The plot growth record specifies the scaling factors used when a font is scaled.
  14749. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14750. * Remove the record in src/records/definitions.
  14751. * @author Glen Stampoultzis (glens at apache.org)
  14752. </member>
  14753. <member name="M:NPOI.HSSF.Record.Chart.PlotGrowthRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14754. Constructs a PlotGrowth record and Sets its fields appropriately.
  14755. @param in the RecordInputstream to Read the record from
  14756. </member>
  14757. <member name="P:NPOI.HSSF.Record.Chart.PlotGrowthRecord.DataSize">
  14758. Size of record (exluding 4 byte header)
  14759. </member>
  14760. <member name="P:NPOI.HSSF.Record.Chart.PlotGrowthRecord.HorizontalScale">
  14761. Get the horizontalScale field for the PlotGrowth record.
  14762. </member>
  14763. <member name="P:NPOI.HSSF.Record.Chart.PlotGrowthRecord.VerticalScale">
  14764. Get the verticalScale field for the PlotGrowth record.
  14765. </member>
  14766. <member name="T:NPOI.HSSF.Record.Chart.PositionMode">
  14767. <summary>
  14768. pecifies positioning mode for position information saved in a Pos record.
  14769. </summary>
  14770. </member>
  14771. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDFX">
  14772. <summary>
  14773. Relative position to the chart, in points.
  14774. </summary>
  14775. </member>
  14776. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDABS">
  14777. <summary>
  14778. Absolute width and height in points. It can only be applied to the mdBotRt field of Pos.
  14779. </summary>
  14780. </member>
  14781. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDPARENT">
  14782. <summary>
  14783. Owner of Pos determines how to interpret the position data.
  14784. </summary>
  14785. </member>
  14786. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDKTH">
  14787. <summary>
  14788. Offset to default position, in 1/1000th of the plot area size.
  14789. </summary>
  14790. </member>
  14791. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDCHART">
  14792. <summary>
  14793. Relative position to the chart, in SPRC.
  14794. </summary>
  14795. </member>
  14796. <member name="T:NPOI.HSSF.Record.Chart.PosRecord">
  14797. <summary>
  14798. specifies the size and position for a legend, an attached label, or the plot area, as specified by the primary axis group.
  14799. </summary>
  14800. </member>
  14801. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.MDTopLt">
  14802. <summary>
  14803. specifies the positioning mode for the upper-left corner of a legend, an attached label, or the plot area.
  14804. </summary>
  14805. </member>
  14806. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.MdBotRt">
  14807. <summary>
  14808. specifies the positioning mode for the lower-right corner of a legend, an attached label, or the plot area
  14809. </summary>
  14810. </member>
  14811. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.X1">
  14812. <summary>
  14813. specifies a position. The meaning is specified in the earlier table showing the valid combinations mdTopLt and mdBotRt by type.
  14814. </summary>
  14815. </member>
  14816. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.X2">
  14817. <summary>
  14818. specifies a width. The meaning is specified in the earlier table showing the valid combinations mdTopLt and mdBotRt by type.
  14819. </summary>
  14820. </member>
  14821. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.Y1">
  14822. <summary>
  14823. specifies a position. The meaning is specified in the earlier table showing the valid combinations mdTopLt and mdBotRt by type.
  14824. </summary>
  14825. </member>
  14826. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.Y2">
  14827. <summary>
  14828. specifies a height. The meaning is specified in the earlier table showing the valid combinations mdTopLt and mdBotRt by type.
  14829. </summary>
  14830. </member>
  14831. <member name="T:NPOI.HSSF.Record.Chart.SeriesChartGroupIndexRecord">
  14832. * The series chart Group index record stores the index to the CHARTFORMAT record (0 based).
  14833. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14834. * Remove the record in src/records/definitions.
  14835. * @author Glen Stampoultzis (glens at apache.org)
  14836. </member>
  14837. <member name="M:NPOI.HSSF.Record.Chart.SeriesChartGroupIndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14838. Constructs a SeriesChartGroupIndex record and Sets its fields appropriately.
  14839. @param in the RecordInputstream to Read the record from
  14840. </member>
  14841. <member name="P:NPOI.HSSF.Record.Chart.SeriesChartGroupIndexRecord.DataSize">
  14842. Size of record (exluding 4 byte header)
  14843. </member>
  14844. <member name="P:NPOI.HSSF.Record.Chart.SeriesChartGroupIndexRecord.ChartGroupIndex">
  14845. Get the chart Group index field for the SeriesChartGroupIndex record.
  14846. </member>
  14847. <member name="T:NPOI.HSSF.Record.Chart.SeriesIndexRecord">
  14848. * links a series to its position in the series list.
  14849. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14850. * Remove the record in src/records/definitions.
  14851. * @author Andrew C. Oliver (acoliver at apache.org)
  14852. </member>
  14853. <member name="M:NPOI.HSSF.Record.Chart.SeriesIndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14854. Constructs a SeriesIndex record and Sets its fields appropriately.
  14855. @param in the RecordInputstream to Read the record from
  14856. </member>
  14857. <member name="P:NPOI.HSSF.Record.Chart.SeriesIndexRecord.DataSize">
  14858. Size of record (exluding 4 byte header)
  14859. </member>
  14860. <member name="P:NPOI.HSSF.Record.Chart.SeriesIndexRecord.Index">
  14861. Get the index field for the SeriesIndex record.
  14862. </member>
  14863. <member name="T:NPOI.HSSF.Record.Chart.SeriesLabelsRecord">
  14864. * The series label record defines the type of label associated with the data format record.
  14865. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14866. * Remove the record in src/records/definitions.
  14867. * @author Glen Stampoultzis (glens at apache.org)
  14868. </member>
  14869. <member name="M:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14870. Constructs a SeriesLabels record and Sets its fields appropriately.
  14871. @param in the RecordInputstream to Read the record from
  14872. </member>
  14873. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.DataSize">
  14874. Size of record (exluding 4 byte header)
  14875. </member>
  14876. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.FormatFlags">
  14877. Get the format flags field for the SeriesLabels record.
  14878. </member>
  14879. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsShowActual">
  14880. show actual value of the data point
  14881. @return the show actual field value.
  14882. </member>
  14883. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsShowPercent">
  14884. show value as percentage of total (pie charts only)
  14885. @return the show percent field value.
  14886. </member>
  14887. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsLabelAsPercentage">
  14888. show category label/value as percentage (pie charts only)
  14889. @return the label as percentage field value.
  14890. </member>
  14891. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsSmoothedLine">
  14892. show smooth line
  14893. @return the smoothed line field value.
  14894. </member>
  14895. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsShowLabel">
  14896. Display category label
  14897. @return the show label field value.
  14898. </member>
  14899. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsShowBubbleSizes">
  14900. ??
  14901. @return the show bubble sizes field value.
  14902. </member>
  14903. <member name="T:NPOI.HSSF.Record.Chart.SeriesListRecord">
  14904. * The series list record defines the series Displayed as an overlay to the main chart record.
  14905. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14906. * Remove the record in src/records/definitions.
  14907. * @author Glen Stampoultzis (glens at apache.org)
  14908. </member>
  14909. <member name="M:NPOI.HSSF.Record.Chart.SeriesListRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14910. Constructs a SeriesList record and Sets its fields appropriately.
  14911. @param in the RecordInputstream to Read the record from
  14912. </member>
  14913. <member name="P:NPOI.HSSF.Record.Chart.SeriesListRecord.DataSize">
  14914. Size of record (exluding 4 byte header)
  14915. </member>
  14916. <member name="P:NPOI.HSSF.Record.Chart.SeriesListRecord.SeriesNumbers">
  14917. Get the series numbers field for the SeriesList record.
  14918. </member>
  14919. <member name="T:NPOI.HSSF.Record.Chart.SeriesRecord">
  14920. * The series record describes the overall data for a series.
  14921. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14922. * Remove the record in src/records/definitions.
  14923. * @author Glen Stampoultzis (glens at apache.org)
  14924. </member>
  14925. <member name="M:NPOI.HSSF.Record.Chart.SeriesRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14926. Constructs a Series record and Sets its fields appropriately.
  14927. @param in the RecordInputstream to Read the record from
  14928. </member>
  14929. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.DataSize">
  14930. Size of record (exluding 4 byte header)
  14931. </member>
  14932. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.CategoryDataType">
  14933. Get the category data type field for the Series record.
  14934. @return One of
  14935. CATEGORY_DATA_TYPE_DATES
  14936. CATEGORY_DATA_TYPE_NUMERIC
  14937. CATEGORY_DATA_TYPE_SEQUENCE
  14938. CATEGORY_DATA_TYPE_TEXT
  14939. </member>
  14940. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.ValuesDataType">
  14941. Get the values data type field for the Series record.
  14942. @return One of
  14943. VALUES_DATA_TYPE_DATES
  14944. VALUES_DATA_TYPE_NUMERIC
  14945. VALUES_DATA_TYPE_SEQUENCE
  14946. VALUES_DATA_TYPE_TEXT
  14947. </member>
  14948. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.NumCategories">
  14949. Get the num categories field for the Series record.
  14950. </member>
  14951. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.NumValues">
  14952. Get the num values field for the Series record.
  14953. </member>
  14954. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.BubbleSeriesType">
  14955. Get the bubble series type field for the Series record.
  14956. @return One of
  14957. BUBBLE_SERIES_TYPE_DATES
  14958. BUBBLE_SERIES_TYPE_NUMERIC
  14959. BUBBLE_SERIES_TYPE_SEQUENCE
  14960. BUBBLE_SERIES_TYPE_TEXT
  14961. </member>
  14962. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.NumBubbleValues">
  14963. Get the num bubble values field for the Series record.
  14964. </member>
  14965. <member name="T:NPOI.HSSF.Record.Chart.SeriesTextRecord">
  14966. * Defines a series name
  14967. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14968. * Remove the record in src/records/definitions.
  14969. * @author Andrew C. Oliver (acoliver at apache.org)
  14970. </member>
  14971. <member name="F:NPOI.HSSF.Record.Chart.SeriesTextRecord.MAX_LEN">
  14972. the actual text cannot be longer than 255 characters
  14973. </member>
  14974. <member name="M:NPOI.HSSF.Record.Chart.SeriesTextRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14975. Constructs a SeriesText record and Sets its fields appropriately.
  14976. @param in the RecordInputstream to Read the record from
  14977. </member>
  14978. <member name="P:NPOI.HSSF.Record.Chart.SeriesTextRecord.DataSize">
  14979. Size of record (exluding 4 byte header)
  14980. </member>
  14981. <member name="P:NPOI.HSSF.Record.Chart.SeriesTextRecord.Id">
  14982. Get the id field for the SeriesText record.
  14983. </member>
  14984. <member name="P:NPOI.HSSF.Record.Chart.SeriesTextRecord.Text">
  14985. Get the text field for the SeriesText record.
  14986. </member>
  14987. <member name="T:NPOI.HSSF.Record.Chart.SeriesToChartGroupRecord">
  14988. * Indicates the chart-group index for a series. The order probably defines the mapping. So the 0th record probably means the 0th series. The only field in this of course defines which chart Group the 0th series (for instance) would map to. Confusing? Well thats because it Is. (p 522 BCG)
  14989. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14990. * Remove the record in src/records/definitions.
  14991. * @author Andrew C. Oliver (acoliver at apache.org)
  14992. </member>
  14993. <member name="M:NPOI.HSSF.Record.Chart.SeriesToChartGroupRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14994. Constructs a SeriesToChartGroup record and Sets its fields appropriately.
  14995. @param in the RecordInputstream to Read the record from
  14996. </member>
  14997. <member name="P:NPOI.HSSF.Record.Chart.SeriesToChartGroupRecord.DataSize">
  14998. Size of record (exluding 4 byte header)
  14999. </member>
  15000. <member name="P:NPOI.HSSF.Record.Chart.SeriesToChartGroupRecord.ChartGroupIndex">
  15001. Get the chart Group index field for the SeriesToChartGroup record.
  15002. </member>
  15003. <member name="T:NPOI.HSSF.Record.TextRecord">
  15004. <summary>
  15005. Section [2.4.324]. The Text record specifies the properties of an attached label and specifies the beginning of
  15006. a collection of records as defined by the chart sheet substream ABNF. This collection of records specifies an attached label.
  15007. </summary>
  15008. </member>
  15009. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_LEFT">
  15010. <summary>
  15011. Left-alignment if iReadingOrder specifies left-to-right reading order; otherwise, right-alignment
  15012. </summary>
  15013. </member>
  15014. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_CENTER">
  15015. <summary>
  15016. Center-alignment
  15017. </summary>
  15018. </member>
  15019. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_BOTTOM">
  15020. <summary>
  15021. Right-alignment if iReadingOrder specifies left-to-right reading order; otherwise, left-alignment
  15022. </summary>
  15023. </member>
  15024. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_JUSTIFY">
  15025. <summary>
  15026. Justify-alignment
  15027. </summary>
  15028. </member>
  15029. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_DISTRIBUTED">
  15030. <summary>
  15031. distributed alignment
  15032. </summary>
  15033. </member>
  15034. <member name="F:NPOI.HSSF.Record.TextRecord.VERTICAL_ALIGNMENT_DISTRIBUTED">
  15035. <summary>
  15036. distributed alignment
  15037. </summary>
  15038. </member>
  15039. <member name="F:NPOI.HSSF.Record.TextRecord.DISPLAY_MODE_TRANSPARENT">
  15040. <summary>
  15041. Transparent background
  15042. </summary>
  15043. </member>
  15044. <member name="F:NPOI.HSSF.Record.TextRecord.DISPLAY_MODE_OPAQUE">
  15045. <summary>
  15046. Opaque background
  15047. </summary>
  15048. </member>
  15049. <member name="M:NPOI.HSSF.Record.TextRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15050. Constructs a Text record and Sets its fields appropriately.
  15051. @param in the RecordInputstream to Read the record from
  15052. </member>
  15053. <member name="P:NPOI.HSSF.Record.TextRecord.DataSize">
  15054. Size of record (exluding 4 byte header)
  15055. </member>
  15056. <member name="P:NPOI.HSSF.Record.TextRecord.HorizontalAlignment">
  15057. Get the horizontal alignment field for the Text record.
  15058. @return One of
  15059. HORIZONTAL_ALIGNMENT_LEFT
  15060. HORIZONTAL_ALIGNMENT_CENTER
  15061. HORIZONTAL_ALIGNMENT_BOTTOM
  15062. HORIZONTAL_ALIGNMENT_JUSTIFY
  15063. </member>
  15064. <member name="P:NPOI.HSSF.Record.TextRecord.VerticalAlignment">
  15065. Get the vertical alignment field for the Text record.
  15066. @return One of
  15067. VERTICAL_ALIGNMENT_TOP
  15068. VERTICAL_ALIGNMENT_CENTER
  15069. VERTICAL_ALIGNMENT_BOTTOM
  15070. VERTICAL_ALIGNMENT_JUSTIFY
  15071. </member>
  15072. <member name="P:NPOI.HSSF.Record.TextRecord.DisplayMode">
  15073. Get the Display mode field for the Text record.
  15074. @return One of
  15075. DISPLAY_MODE_TRANSPARENT
  15076. DISPLAY_MODE_OPAQUE
  15077. </member>
  15078. <member name="P:NPOI.HSSF.Record.TextRecord.RgbColor">
  15079. Get the rgbColor field for the Text record.
  15080. </member>
  15081. <member name="P:NPOI.HSSF.Record.TextRecord.X">
  15082. Get the x field for the Text record.
  15083. </member>
  15084. <member name="P:NPOI.HSSF.Record.TextRecord.Y">
  15085. Get the y field for the Text record.
  15086. </member>
  15087. <member name="P:NPOI.HSSF.Record.TextRecord.Width">
  15088. Set the width field for the Text record.
  15089. </member>
  15090. <member name="P:NPOI.HSSF.Record.TextRecord.Height">
  15091. Get the height field for the Text record.
  15092. </member>
  15093. <member name="P:NPOI.HSSF.Record.TextRecord.Options1">
  15094. Get the options1 field for the Text record.
  15095. </member>
  15096. <member name="P:NPOI.HSSF.Record.TextRecord.IndexOfColorValue">
  15097. Get the index of color value field for the Text record.
  15098. </member>
  15099. <member name="P:NPOI.HSSF.Record.TextRecord.Options2">
  15100. Get the options2 field for the Text record.
  15101. </member>
  15102. <member name="P:NPOI.HSSF.Record.TextRecord.TextRotation">
  15103. Get the text rotation field for the Text record.
  15104. </member>
  15105. <member name="P:NPOI.HSSF.Record.TextRecord.IsAutoColor">
  15106. true = automaticly selected colour, false = user-selected
  15107. @return the auto color field value.
  15108. </member>
  15109. <member name="P:NPOI.HSSF.Record.TextRecord.ShowKey">
  15110. true = draw legend
  15111. @return the show key field value.
  15112. </member>
  15113. <member name="P:NPOI.HSSF.Record.TextRecord.ShowValue">
  15114. false = text is category label
  15115. @return the show value field value.
  15116. </member>
  15117. <member name="P:NPOI.HSSF.Record.TextRecord.IsAutoGeneratedText">
  15118. @return the auto generated text field value.
  15119. </member>
  15120. <member name="P:NPOI.HSSF.Record.TextRecord.IsGenerated">
  15121. @return the generated field value.
  15122. </member>
  15123. <member name="P:NPOI.HSSF.Record.TextRecord.IsAutoLabelDeleted">
  15124. @return the auto label deleted field value.
  15125. </member>
  15126. <member name="P:NPOI.HSSF.Record.TextRecord.IsAutoBackground">
  15127. @return the auto background field value.
  15128. </member>
  15129. <member name="P:NPOI.HSSF.Record.TextRecord.ShowCategoryLabelAsPercentage">
  15130. @return the show category label as percentage field value.
  15131. </member>
  15132. <member name="P:NPOI.HSSF.Record.TextRecord.ShowValueAsPercentage">
  15133. @return the show value as percentage field value.
  15134. </member>
  15135. <member name="P:NPOI.HSSF.Record.TextRecord.ShowBubbleSizes">
  15136. @return the show bubble sizes field value.
  15137. </member>
  15138. <member name="P:NPOI.HSSF.Record.TextRecord.ShowLabel">
  15139. @return the show label field value.
  15140. </member>
  15141. <member name="P:NPOI.HSSF.Record.TextRecord.DataLabelPlacement">
  15142. @return the data label placement field value.
  15143. </member>
  15144. <member name="T:NPOI.HSSF.Record.TickRecord">
  15145. * The Tick record defines how tick marks and label positioning/formatting
  15146. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  15147. * Remove the record in src/records/definitions.
  15148. * @author Andrew C. Oliver(acoliver at apache.org)
  15149. </member>
  15150. <member name="M:NPOI.HSSF.Record.TickRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15151. Constructs a Tick record and Sets its fields appropriately.
  15152. @param in the RecordInputstream to Read the record from
  15153. </member>
  15154. <member name="P:NPOI.HSSF.Record.TickRecord.DataSize">
  15155. Size of record (exluding 4 byte header)
  15156. </member>
  15157. <member name="P:NPOI.HSSF.Record.TickRecord.MajorTickType">
  15158. Get the major tick type field for the Tick record.
  15159. </member>
  15160. <member name="P:NPOI.HSSF.Record.TickRecord.MinorTickType">
  15161. Get the minor tick type field for the Tick record.
  15162. </member>
  15163. <member name="P:NPOI.HSSF.Record.TickRecord.LabelPosition">
  15164. Get the label position field for the Tick record.
  15165. </member>
  15166. <member name="P:NPOI.HSSF.Record.TickRecord.Background">
  15167. Get the background field for the Tick record.
  15168. </member>
  15169. <member name="P:NPOI.HSSF.Record.TickRecord.LabelColorRgb">
  15170. Get the label color rgb field for the Tick record.
  15171. </member>
  15172. <member name="P:NPOI.HSSF.Record.TickRecord.Zero1">
  15173. Get the zero 1 field for the Tick record.
  15174. </member>
  15175. <member name="P:NPOI.HSSF.Record.TickRecord.Zero2">
  15176. Get the zero 2 field for the Tick record.
  15177. </member>
  15178. <member name="P:NPOI.HSSF.Record.TickRecord.Options">
  15179. Get the options field for the Tick record.
  15180. </member>
  15181. <member name="P:NPOI.HSSF.Record.TickRecord.TickColor">
  15182. Get the tick color field for the Tick record.
  15183. </member>
  15184. <member name="P:NPOI.HSSF.Record.TickRecord.Zero3">
  15185. Get the zero 3 field for the Tick record.
  15186. </member>
  15187. <member name="P:NPOI.HSSF.Record.TickRecord.IsAutoTextColor">
  15188. use the quote Unquote automatic color for text
  15189. @return the auto text color field value.
  15190. </member>
  15191. <member name="P:NPOI.HSSF.Record.TickRecord.IsAutoTextBackground">
  15192. use the quote Unquote automatic color for text background
  15193. @return the auto text background field value.
  15194. </member>
  15195. <member name="P:NPOI.HSSF.Record.TickRecord.Rotation">
  15196. rotate text (0=none, 1=normal, 2=90 degrees counterclockwise, 3=90 degrees clockwise)
  15197. @return the rotation field value.
  15198. </member>
  15199. <member name="P:NPOI.HSSF.Record.TickRecord.IsAutorotate">
  15200. automatically rotate the text
  15201. @return the autorotate field value.
  15202. </member>
  15203. <member name="T:NPOI.HSSF.Record.UnitsRecord">
  15204. * The Units record describes Units.
  15205. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  15206. * Remove the record in src/records/definitions.
  15207. * @author Glen Stampoultzis (glens at apache.org)
  15208. </member>
  15209. <member name="M:NPOI.HSSF.Record.UnitsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15210. Constructs a Units record and Sets its fields appropriately.
  15211. @param in the RecordInputstream to Read the record from
  15212. </member>
  15213. <member name="P:NPOI.HSSF.Record.UnitsRecord.DataSize">
  15214. Size of record (exluding 4 byte header)
  15215. </member>
  15216. <member name="P:NPOI.HSSF.Record.UnitsRecord.Units">
  15217. Get the Units field for the Units record.
  15218. </member>
  15219. <member name="T:NPOI.HSSF.Record.Chart.ValueRangeRecord">
  15220. * The value range record defines the range of the value axis.
  15221. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  15222. * Remove the record in src/records/definitions.
  15223. * @author Glen Stampoultzis (glens at apache.org)
  15224. </member>
  15225. <member name="M:NPOI.HSSF.Record.Chart.ValueRangeRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15226. Constructs a ValueRange record and Sets its fields appropriately.
  15227. @param in the RecordInputstream to Read the record from
  15228. </member>
  15229. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.DataSize">
  15230. Size of record (exluding 4 byte header)
  15231. </member>
  15232. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.MinimumAxisValue">
  15233. Get the minimum axis value field for the ValueRange record.
  15234. </member>
  15235. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.MaximumAxisValue">
  15236. Get the maximum axis value field for the ValueRange record.
  15237. </member>
  15238. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.MajorIncrement">
  15239. Get the major increment field for the ValueRange record.
  15240. </member>
  15241. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.MinorIncrement">
  15242. Get the minor increment field for the ValueRange record.
  15243. </member>
  15244. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.CategoryAxisCross">
  15245. Get the category axis cross field for the ValueRange record.
  15246. </member>
  15247. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.Options">
  15248. Get the options field for the ValueRange record.
  15249. </member>
  15250. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticMinimum">
  15251. automatic minimum value selected
  15252. @return the automatic minimum field value.
  15253. </member>
  15254. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticMaximum">
  15255. automatic maximum value selected
  15256. @return the automatic maximum field value.
  15257. </member>
  15258. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticMajor">
  15259. automatic major Unit selected
  15260. @return the automatic major field value.
  15261. </member>
  15262. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticMinor">
  15263. automatic minor Unit selected
  15264. @return the automatic minor field value.
  15265. </member>
  15266. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticCategoryCrossing">
  15267. category crossing point is automatically selected
  15268. @return the automatic category crossing field value.
  15269. </member>
  15270. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsLogarithmicScale">
  15271. use logarithmic scale
  15272. @return the logarithmic scale field value.
  15273. </member>
  15274. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsValuesInReverse">
  15275. values are reverses in graph
  15276. @return the values in reverse field value.
  15277. </member>
  15278. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsCrossCategoryAxisAtMaximum">
  15279. category axis to cross at maximum value
  15280. @return the cross category axis at maximum field value.
  15281. </member>
  15282. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsReserved">
  15283. reserved, must equal 1 (excel dev. guide says otherwise)
  15284. @return the reserved field value.
  15285. </member>
  15286. <member name="T:NPOI.HSSF.Record.CodepageRecord">
  15287. Title: Codepage Record
  15288. <p>Description: the default characterset. for the workbook</p>
  15289. <p>REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)</p>
  15290. <p>Use {@link CodePageUtil} to turn these values into Java code pages
  15291. to encode/decode strings.</p>
  15292. @version 2.0-pre
  15293. </member>
  15294. <member name="F:NPOI.HSSF.Record.CodepageRecord.CODEPAGE">
  15295. Excel 97+ (Biff 8) should always store strings as UTF-16LE or
  15296. compressed versions of that. As such, this should always be
  15297. 0x4b0 = UTF_16, except for files coming from older versions.
  15298. </member>
  15299. <member name="M:NPOI.HSSF.Record.CodepageRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15300. Constructs a CodepageRecord and Sets its fields appropriately
  15301. @param in the RecordInputstream to Read the record from
  15302. </member>
  15303. <member name="P:NPOI.HSSF.Record.CodepageRecord.Codepage">
  15304. Get the codepage for this workbook
  15305. @see #CODEPAGE
  15306. @return codepage - the codepage to Set
  15307. </member>
  15308. <member name="T:NPOI.HSSF.Record.ColumnInfoRecord">
  15309. Title: COLINFO Record<p/>
  15310. Description: Defines with width and formatting for a range of columns<p/>
  15311. REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<p/>
  15312. @author Andrew C. Oliver (acoliver at apache dot org)
  15313. @version 2.0-pre
  15314. </member>
  15315. <member name="M:NPOI.HSSF.Record.ColumnInfoRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15316. Constructs a ColumnInfo record and Sets its fields appropriately
  15317. @param in the RecordInputstream to Read the record from
  15318. </member>
  15319. <member name="M:NPOI.HSSF.Record.ColumnInfoRecord.FormatMatches(NPOI.HSSF.Record.ColumnInfoRecord)">
  15320. @return true if the format, options and column width match
  15321. </member>
  15322. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.FirstColumn">
  15323. Get the first column this record defines formatting info for
  15324. @return the first column index (0-based)
  15325. </member>
  15326. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.LastColumn">
  15327. Get the last column this record defines formatting info for
  15328. @return the last column index (0-based)
  15329. </member>
  15330. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.ColumnWidth">
  15331. Get the columns' width in 1/256 of a Char width
  15332. @return column width
  15333. </member>
  15334. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.XFIndex">
  15335. Get the columns' default format info
  15336. @return the extended format index
  15337. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  15338. </member>
  15339. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.Options">
  15340. Get the options bitfield - use the bitSetters instead
  15341. @return the bitfield raw value
  15342. </member>
  15343. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.IsHidden">
  15344. Get whether or not these cells are hidden
  15345. @return whether the cells are hidden.
  15346. @see #SetOptions(short)
  15347. </member>
  15348. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.OutlineLevel">
  15349. Get the outline level for the cells
  15350. @see #SetOptions(short)
  15351. @return outline level for the cells
  15352. </member>
  15353. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.IsCollapsed">
  15354. Get whether the cells are collapsed
  15355. @return wether the cells are collapsed
  15356. @see #SetOptions(short)
  15357. </member>
  15358. <member name="T:NPOI.POIFS.EventFileSystem.POIFSWriterEvent">
  15359. Class POIFSWriterEvent
  15360. @author Marc Johnson (mjohnson at apache dot org)
  15361. @version %I%, %G%
  15362. </member>
  15363. <member name="M:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.#ctor(NPOI.POIFS.FileSystem.DocumentOutputStream,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String,System.Int32)">
  15364. namespace scoped constructor
  15365. @param stream the DocumentOutputStream, freshly opened
  15366. @param path the path of the document
  15367. @param documentName the name of the document
  15368. @param limit the limit, in bytes, that can be written to the
  15369. stream
  15370. </member>
  15371. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.Stream">
  15372. @return the DocumentOutputStream, freshly opened
  15373. </member>
  15374. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.Path">
  15375. @return the document's path
  15376. </member>
  15377. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.Name">
  15378. @return the document's name
  15379. </member>
  15380. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.Limit">
  15381. @return the limit on writing, in bytes
  15382. </member>
  15383. <member name="T:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs">
  15384. <summary>
  15385. EventArgs for POIFSWriter
  15386. author: Tony Qu
  15387. </summary>
  15388. </member>
  15389. <member name="M:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.#ctor(NPOI.POIFS.FileSystem.DocumentOutputStream,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String,System.Int32)">
  15390. <summary>
  15391. Initializes a new instance of the <see cref="T:NPOI.POIFS.EventFileSystem.POIFSWriterEvent"/> class.
  15392. </summary>
  15393. <param name="stream">the POIFSDocumentWriter, freshly opened</param>
  15394. <param name="path">the path of the document</param>
  15395. <param name="documentName">the name of the document</param>
  15396. <param name="limit">the limit, in bytes, that can be written to the stream</param>
  15397. </member>
  15398. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.Limit">
  15399. <summary>
  15400. Gets the limit on writing, in bytes
  15401. </summary>
  15402. <value>The limit.</value>
  15403. </member>
  15404. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.Name">
  15405. <summary>
  15406. Gets the document's name
  15407. </summary>
  15408. <value>The name.</value>
  15409. </member>
  15410. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.Path">
  15411. <summary>
  15412. Gets the document's path
  15413. </summary>
  15414. <value>The path.</value>
  15415. </member>
  15416. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.Stream">
  15417. <summary>
  15418. the POIFSDocumentWriter, freshly opened
  15419. </summary>
  15420. <value>The stream.</value>
  15421. </member>
  15422. <member name="T:NPOI.POIFS.EventFileSystem.POIFSWriterListener">
  15423. Interface POIFSWriterListener
  15424. @author Marc Johnson (mjohnson at apache dot org)
  15425. @version %I%, %G%
  15426. </member>
  15427. <member name="M:NPOI.POIFS.EventFileSystem.POIFSWriterListener.ProcessPOIFSWriterEvent(NPOI.POIFS.EventFileSystem.POIFSWriterEvent)">
  15428. Process a POIFSWriterEvent that this listener had registered
  15429. for
  15430. @param event the POIFSWriterEvent
  15431. </member>
  15432. <member name="T:NPOI.POIFS.FileSystem.BlockStore">
  15433. <summary>
  15434. This abstract class describes a way to read, store, chain
  15435. and free a series of blocks (be they Big or Small ones)
  15436. </summary>
  15437. </member>
  15438. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetBlockStoreBlockSize">
  15439. <summary>
  15440. Returns the size of the blocks managed through the block store.
  15441. </summary>
  15442. <returns></returns>
  15443. </member>
  15444. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetBlockAt(System.Int32)">
  15445. <summary>
  15446. Load the block at the given offset.
  15447. </summary>
  15448. <param name="offset"></param>
  15449. <returns></returns>
  15450. </member>
  15451. <member name="M:NPOI.POIFS.FileSystem.BlockStore.CreateBlockIfNeeded(System.Int32)">
  15452. <summary>
  15453. Extends the file if required to hold blocks up to
  15454. the specified offset, and return the block from there.
  15455. </summary>
  15456. <param name="offset"></param>
  15457. <returns></returns>
  15458. </member>
  15459. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetBATBlockAndIndex(System.Int32)">
  15460. <summary>
  15461. Returns the BATBlock that handles the specified offset,
  15462. and the relative index within it
  15463. </summary>
  15464. <param name="offset"></param>
  15465. <returns></returns>
  15466. </member>
  15467. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetNextBlock(System.Int32)">
  15468. <summary>
  15469. Works out what block follows the specified one.
  15470. </summary>
  15471. <param name="offset"></param>
  15472. <returns></returns>
  15473. </member>
  15474. <member name="M:NPOI.POIFS.FileSystem.BlockStore.SetNextBlock(System.Int32,System.Int32)">
  15475. <summary>
  15476. Changes the record of what block follows the specified one.
  15477. </summary>
  15478. <param name="offset"></param>
  15479. <param name="nextBlock"></param>
  15480. </member>
  15481. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetFreeBlock">
  15482. <summary>
  15483. Finds a free block, and returns its offset.
  15484. This method will extend the file/stream if needed, and if doing
  15485. so, allocate new FAT blocks to address the extra space.
  15486. </summary>
  15487. <returns></returns>
  15488. </member>
  15489. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetChainLoopDetector">
  15490. <summary>
  15491. Creates a Detector for loops in the chain
  15492. </summary>
  15493. <returns></returns>
  15494. </member>
  15495. <member name="T:NPOI.POIFS.FileSystem.ChainLoopDetector">
  15496. <summary>
  15497. Used to detect if a chain has a loop in it, so
  15498. we can bail out with an error rather than
  15499. spinning away for ever...
  15500. </summary>
  15501. </member>
  15502. <member name="T:NPOI.POIFS.FileSystem.DocumentInputStream">
  15503. This class provides methods to read a DocumentEntry managed by a
  15504. {@link POIFSFileSystem} or {@link NPOIFSFileSystem} instance.
  15505. It Creates the appropriate one, and delegates, allowing us to
  15506. work transparently with the two.
  15507. </member>
  15508. <member name="F:NPOI.POIFS.FileSystem.DocumentInputStream.EOF">
  15509. returned by read operations if we're at end of document
  15510. </member>
  15511. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.#ctor">
  15512. For use by downstream implementations
  15513. </member>
  15514. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  15515. Create an InputStream from the specified DocumentEntry
  15516. @param document the DocumentEntry to be read
  15517. @exception IOException if the DocumentEntry cannot be opened (like, maybe it has
  15518. been deleted?)
  15519. </member>
  15520. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.#ctor(NPOI.POIFS.FileSystem.POIFSDocument)">
  15521. Create an InputStream from the specified Document
  15522. @param document the Document to be read
  15523. </member>
  15524. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.#ctor(NPOI.POIFS.FileSystem.NPOIFSDocument)">
  15525. Create an InputStream from the specified Document
  15526. @param document the Document to be read
  15527. </member>
  15528. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.MarkSupported">
  15529. Tests if this input stream supports the mark and reset methods.
  15530. @return <code>true</code> always
  15531. </member>
  15532. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.Reset">
  15533. Repositions this stream to the position at the time the mark() method was
  15534. last called on this input stream. If mark() has not been called this
  15535. method repositions the stream to its beginning.
  15536. </member>
  15537. <member name="T:NPOI.POIFS.FileSystem.DocumentOutputStream">
  15538. This class provides a wrapper over an OutputStream so that Document
  15539. Writers can't accidently go over their size limits
  15540. @author Marc Johnson (mjohnson at apache dot org)
  15541. </member>
  15542. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.#ctor(System.IO.Stream,System.Int32)">
  15543. Create a DocumentOutputStream
  15544. @param stream the OutputStream to which the data is actually
  15545. read
  15546. @param limit the maximum number of bytes that can be written
  15547. </member>
  15548. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Write(System.Int32)">
  15549. Writes the specified byte to this output stream. The general
  15550. contract for write is that one byte is written to the output
  15551. stream. The byte to be written is the eight low-order bits of
  15552. the argument b. The 24 high-order bits of b are ignored.
  15553. @param b the byte.
  15554. @exception IOException if an I/O error occurs. In particular,
  15555. an IOException may be thrown if the
  15556. output stream has been closed, or if the
  15557. Writer tries to write too much data.
  15558. </member>
  15559. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Write(System.Byte[])">
  15560. Writes b.Length bytes from the specified byte array
  15561. to this output stream.
  15562. @param b the data.
  15563. @exception IOException if an I/O error occurs.
  15564. </member>
  15565. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Write(System.Byte[],System.Int32,System.Int32)">
  15566. <summary>
  15567. Writes len bytes from the specified byte array starting at
  15568. offset off to this output stream. The general contract for
  15569. Write(b, off, len) is that some of the bytes in the array b are
  15570. written to the output stream in order; element b[off] is the
  15571. first byte written and b[off+len-1] is the last byte written by
  15572. this operation.
  15573. </summary>
  15574. <param name="b">the data.</param>
  15575. <param name="off">the start offset in the data.</param>
  15576. <param name="len">the number of bytes to Write.</param>
  15577. </member>
  15578. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Flush">
  15579. <summary>
  15580. Flushes this output stream and forces any buffered output bytes to be written out
  15581. </summary>
  15582. </member>
  15583. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Close">
  15584. Closes this output stream and releases any system resources
  15585. associated with this stream. The general contract of close is
  15586. that it closes the output stream. A closed stream cannot
  15587. perform output operations and cannot be reopened.
  15588. @exception IOException if an I/O error occurs.
  15589. </member>
  15590. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.WriteFiller(System.Int32,System.Byte)">
  15591. write the rest of the document's data (fill in at the end)
  15592. @param totalLimit the actual number of bytes the corresponding
  15593. document must fill
  15594. @param fill the byte to fill remaining space with
  15595. @exception IOException on I/O error
  15596. </member>
  15597. <member name="T:NPOI.POIFS.FileSystem.NDocumentInputStream">
  15598. This class provides methods to read a DocumentEntry managed by a
  15599. {@link NPOIFSFileSystem} instance.
  15600. </member>
  15601. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._current_offset">
  15602. current offset into the Document
  15603. </member>
  15604. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._current_block_count">
  15605. current block count
  15606. </member>
  15607. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._marked_offset">
  15608. current marked offset into the Document (used by mark and Reset)
  15609. </member>
  15610. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._marked_offset_count">
  15611. and the block count for it
  15612. </member>
  15613. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._document_size">
  15614. the Document's size
  15615. </member>
  15616. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._closed">
  15617. have we been closed?
  15618. </member>
  15619. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._document">
  15620. the actual Document
  15621. </member>
  15622. <member name="M:NPOI.POIFS.FileSystem.NDocumentInputStream.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  15623. Create an InputStream from the specified DocumentEntry
  15624. @param document the DocumentEntry to be read
  15625. @exception IOException if the DocumentEntry cannot be opened (like, maybe it has
  15626. been deleted?)
  15627. </member>
  15628. <member name="M:NPOI.POIFS.FileSystem.NDocumentInputStream.#ctor(NPOI.POIFS.FileSystem.NPOIFSDocument)">
  15629. Create an InputStream from the specified Document
  15630. @param document the Document to be read
  15631. </member>
  15632. <member name="M:NPOI.POIFS.FileSystem.NDocumentInputStream.Reset">
  15633. Repositions this stream to the position at the time the mark() method was
  15634. last called on this input stream. If mark() has not been called this
  15635. method repositions the stream to its beginning.
  15636. </member>
  15637. <member name="T:NPOI.POIFS.FileSystem.NPOIFSDocument">
  15638. This class manages a document in the NIO POIFS filesystem.
  15639. This is the {@link NPOIFSFileSystem} version.
  15640. </member>
  15641. <member name="T:NPOI.POIFS.Dev.POIFSViewable">
  15642. <summary>
  15643. Interface for a drill-down viewable object. Such an object has
  15644. content that may or may not be displayed, at the discretion of the
  15645. viewer. The content is returned to the viewer as an array or as an
  15646. Iterator, and the object provides a clue as to which technique the
  15647. viewer should use to get its content.
  15648. A POIFSViewable object is also expected to provide a short
  15649. description of itself, that can be used by a viewer when the
  15650. viewable object is collapsed.
  15651. @author Marc Johnson (mjohnson at apache dot org)
  15652. </summary>
  15653. </member>
  15654. <member name="P:NPOI.POIFS.Dev.POIFSViewable.PreferArray">
  15655. <summary>
  15656. Provides a short description of the object to be used when a
  15657. POIFSViewable object has not provided its contents.
  15658. </summary>
  15659. <value><c>true</c> if [prefer array]; otherwise, <c>false</c>.</value>
  15660. </member>
  15661. <member name="P:NPOI.POIFS.Dev.POIFSViewable.ShortDescription">
  15662. <summary>
  15663. Gets the short description.
  15664. </summary>
  15665. <value>The short description.</value>
  15666. </member>
  15667. <member name="P:NPOI.POIFS.Dev.POIFSViewable.ViewableArray">
  15668. <summary>
  15669. Get an array of objects, some of which may implement POIFSViewable
  15670. </summary>
  15671. <value>The viewable array.</value>
  15672. </member>
  15673. <member name="P:NPOI.POIFS.Dev.POIFSViewable.ViewableIterator">
  15674. <summary>
  15675. Give viewers a hint as to whether to call ViewableArray or ViewableIterator
  15676. </summary>
  15677. <value>The viewable iterator.</value>
  15678. </member>
  15679. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.#ctor(NPOI.POIFS.FileSystem.DocumentNode)">
  15680. Constructor for an existing Document
  15681. </member>
  15682. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.#ctor(NPOI.POIFS.Properties.DocumentProperty,NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  15683. Constructor for an existing Document
  15684. </member>
  15685. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.#ctor(System.String,NPOI.POIFS.FileSystem.NPOIFSFileSystem,System.IO.Stream)">
  15686. Constructor for a new Document
  15687. @param name the name of the POIFSDocument
  15688. @param stream the InputStream we read data from
  15689. </member>
  15690. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.Free">
  15691. Frees the underlying stream and property
  15692. </member>
  15693. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.GetViewableArray">
  15694. Get an array of objects, some of which may implement POIFSViewable
  15695. @return an array of Object; may not be null, but may be empty
  15696. </member>
  15697. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.GetViewableIterator">
  15698. Get an Iterator of objects, some of which may implement POIFSViewable
  15699. @return an Iterator; may not be null, but may have an empty back end
  15700. store
  15701. </member>
  15702. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.GetShortDescription">
  15703. Provides a short description of the object, to be used when a
  15704. POIFSViewable object has not provided its contents.
  15705. @return short description
  15706. </member>
  15707. <member name="P:NPOI.POIFS.FileSystem.NPOIFSDocument.Size">
  15708. @return size of the document
  15709. </member>
  15710. <member name="P:NPOI.POIFS.FileSystem.NPOIFSDocument.DocumentProperty">
  15711. @return the instance's DocumentProperty
  15712. </member>
  15713. <member name="T:NPOI.POIFS.FileSystem.NPOIFSFileSystem">
  15714. This is the main class of the POIFS system; it manages the entire
  15715. life cycle of the filesystem.
  15716. This is the new NIO version
  15717. </member>
  15718. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateNonClosingInputStream(System.IO.Stream)">
  15719. Convenience method for clients that want to avoid the auto-close behaviour of the constructor.
  15720. </member>
  15721. <member name="F:NPOI.POIFS.FileSystem.NPOIFSFileSystem.bigBlockSize">
  15722. What big block size the file uses. Most files
  15723. use 512 bytes, but a few use 4096
  15724. </member>
  15725. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor">
  15726. Constructor, intended for writing
  15727. </member>
  15728. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor(System.IO.FileInfo,System.Boolean)">
  15729. <p>Creates a POIFSFileSystem from a <tt>File</tt>. This uses less memory than
  15730. creating from an <tt>InputStream</tt>.</p>
  15731. <p>Note that with this constructor, you will need to call {@link #close()}
  15732. when you're done to have the underlying file closed, as the file is
  15733. kept open during normal operation to read the data out.</p>
  15734. @param file the File from which to read or read/write the data
  15735. @param readOnly whether the POIFileSystem will only be used in read-only mode
  15736. @exception IOException on errors reading, or on invalid data
  15737. </member>
  15738. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor(System.IO.FileStream)">
  15739. * <p>Creates a POIFSFileSystem from an open <tt>FileChannel</tt>. This uses
  15740. * less memory than creating from an <tt>InputStream</tt>. The stream will
  15741. * be used in read-only mode.</p>
  15742. *
  15743. * <p>Note that with this constructor, you will need to call {@link #close()}
  15744. * when you're done to have the underlying Channel closed, as the channel is
  15745. * kept open during normal operation to read the data out.</p>
  15746. *
  15747. * @param channel the FileChannel from which to read the data
  15748. *
  15749. * @exception IOException on errors reading, or on invalid data
  15750. </member>
  15751. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor(System.IO.FileStream,System.Boolean)">
  15752. <p>Creates a POIFSFileSystem from an open <tt>FileChannel</tt>. This uses
  15753. less memory than creating from an <tt>InputStream</tt>.</p>
  15754. <p>Note that with this constructor, you will need to call {@link #close()}
  15755. when you're done to have the underlying Channel closed, as the channel is
  15756. kept open during normal operation to read the data out.</p>
  15757. @param channel the FileChannel from which to read or read/write the data
  15758. @param readOnly whether the POIFileSystem will only be used in read-only mode
  15759. @exception IOException on errors reading, or on invalid data
  15760. </member>
  15761. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor(System.IO.Stream)">
  15762. Create a POIFSFileSystem from an <tt>InputStream</tt>. Normally the stream is read until
  15763. EOF. The stream is always closed.<p/>
  15764. Some streams are usable After reaching EOF (typically those that return <code>true</code>
  15765. for <tt>markSupported()</tt>). In the unlikely case that the caller has such a stream
  15766. <i>and</i> needs to use it After this constructor completes, a work around is to wrap the
  15767. stream in order to trap the <tt>close()</tt> call. A convenience method (
  15768. <tt>CreateNonClosingInputStream()</tt>) has been provided for this purpose:
  15769. <pre>
  15770. InputStream wrappedStream = POIFSFileSystem.CreateNonClosingInputStream(is);
  15771. HSSFWorkbook wb = new HSSFWorkbook(wrappedStream);
  15772. is.Reset();
  15773. doSomethingElse(is);
  15774. </pre>
  15775. Note also the special case of <tt>MemoryStream</tt> for which the <tt>close()</tt>
  15776. method does nothing.
  15777. <pre>
  15778. MemoryStream bais = ...
  15779. HSSFWorkbook wb = new HSSFWorkbook(bais); // calls bais.Close() !
  15780. bais.Reset(); // no problem
  15781. doSomethingElse(bais);
  15782. </pre>
  15783. @param stream the InputStream from which to read the data
  15784. @exception IOException on errors Reading, or on invalid data
  15785. </member>
  15786. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CloseInputStream(System.IO.Stream,System.Boolean)">
  15787. @param stream the stream to be closed
  15788. @param success <code>false</code> if an exception is currently being thrown in the calling method
  15789. </member>
  15790. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.HasPOIFSHeader(System.IO.Stream)">
  15791. Checks that the supplied InputStream (which MUST
  15792. support mark and reset, or be a PushbackInputStream)
  15793. has a POIFS (OLE2) header at the start of it.
  15794. If your InputStream does not support mark / reset,
  15795. then wrap it in a PushBackInputStream, then be
  15796. sure to always use that, and not the original!
  15797. @param inp An InputStream which supports either mark/reset, or is a PushbackInputStream
  15798. </member>
  15799. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.HasPOIFSHeader(System.Byte[])">
  15800. Checks if the supplied first 8 bytes of a stream / file
  15801. has a POIFS (OLE2) header.
  15802. </member>
  15803. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.ReadCoreContents">
  15804. Read and process the PropertiesTable and the
  15805. FAT / XFAT blocks, so that we're Ready to
  15806. work with the file
  15807. </member>
  15808. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetBlockAt(System.Int32)">
  15809. Load the block at the given offset.
  15810. </member>
  15811. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateBlockIfNeeded(System.Int32)">
  15812. Load the block at the given offset,
  15813. extending the file if needed
  15814. </member>
  15815. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetBATBlockAndIndex(System.Int32)">
  15816. Returns the BATBlock that handles the specified offset,
  15817. and the relative index within it
  15818. </member>
  15819. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetNextBlock(System.Int32)">
  15820. Works out what block follows the specified one.
  15821. </member>
  15822. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.SetNextBlock(System.Int32,System.Int32)">
  15823. Changes the record of what block follows the specified one.
  15824. </member>
  15825. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetFreeBlock">
  15826. Finds a free block, and returns its offset.
  15827. This method will extend the file if needed, and if doing
  15828. so, allocate new FAT blocks to Address the extra space.
  15829. </member>
  15830. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetMiniStore">
  15831. Returns the MiniStore, which performs a similar low
  15832. level function to this, except for the small blocks.
  15833. </member>
  15834. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.AddDocument(NPOI.POIFS.FileSystem.NPOIFSDocument)">
  15835. add a new POIFSDocument to the FileSytem
  15836. @param document the POIFSDocument being Added
  15837. </member>
  15838. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.AddDirectory(NPOI.POIFS.Properties.DirectoryProperty)">
  15839. add a new DirectoryProperty to the FileSystem
  15840. @param directory the DirectoryProperty being Added
  15841. </member>
  15842. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateDocument(System.IO.Stream,System.String)">
  15843. Create a new document to be Added to the root directory
  15844. @param stream the InputStream from which the document's data
  15845. will be obtained
  15846. @param name the name of the new POIFSDocument
  15847. @return the new DocumentEntry
  15848. @exception IOException on error creating the new POIFSDocument
  15849. </member>
  15850. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateDocument(System.String,System.Int32,NPOI.POIFS.EventFileSystem.POIFSWriterListener)">
  15851. create a new DocumentEntry in the root entry; the data will be
  15852. provided later
  15853. @param name the name of the new DocumentEntry
  15854. @param size the size of the new DocumentEntry
  15855. @param Writer the Writer of the new DocumentEntry
  15856. @return the new DocumentEntry
  15857. @exception IOException
  15858. </member>
  15859. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateDirectory(System.String)">
  15860. create a new DirectoryEntry in the root directory
  15861. @param name the name of the new DirectoryEntry
  15862. @return the new DirectoryEntry
  15863. @exception IOException on name duplication
  15864. </member>
  15865. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.WriteFileSystem">
  15866. Write the filesystem out to the open file. Will thrown an
  15867. {@link ArgumentException} if opened from an
  15868. {@link InputStream}.
  15869. @exception IOException thrown on errors writing to the stream
  15870. </member>
  15871. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.WriteFileSystem(System.IO.Stream)">
  15872. Write the filesystem out
  15873. @param stream the OutputStream to which the filesystem will be
  15874. written
  15875. @exception IOException thrown on errors writing to the stream
  15876. </member>
  15877. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.syncWithDataSource">
  15878. Has our in-memory objects write their state
  15879. to their backing blocks
  15880. </member>
  15881. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.Close">
  15882. Closes the FileSystem, freeing any underlying files, streams
  15883. and buffers. After this, you will be unable to read or
  15884. write from the FileSystem.
  15885. </member>
  15886. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateDocumentInputStream(System.String)">
  15887. open a document in the root entry's list of entries
  15888. @param documentName the name of the document to be opened
  15889. @return a newly opened DocumentInputStream
  15890. @exception IOException if the document does not exist or the
  15891. name is that of a DirectoryEntry
  15892. </member>
  15893. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.Remove(NPOI.POIFS.FileSystem.EntryNode)">
  15894. remove an entry
  15895. @param entry to be Removed
  15896. </member>
  15897. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetViewableArray">
  15898. Get an array of objects, some of which may implement
  15899. POIFSViewable
  15900. @return an array of Object; may not be null, but may be empty
  15901. </member>
  15902. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetViewableIterator">
  15903. Get an Iterator of objects, some of which may implement
  15904. POIFSViewable
  15905. @return an Iterator; may not be null, but may have an empty
  15906. back end store
  15907. </member>
  15908. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetShortDescription">
  15909. Provides a short description of the object, to be used when a
  15910. POIFSViewable object has not provided its contents.
  15911. @return short description
  15912. </member>
  15913. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetBigBlockSize">
  15914. @return The Big Block size, normally 512 bytes, sometimes 4096 bytes
  15915. </member>
  15916. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetBigBlockSizeDetails">
  15917. @return The Big Block size, normally 512 bytes, sometimes 4096 bytes
  15918. </member>
  15919. <member name="P:NPOI.POIFS.FileSystem.NPOIFSFileSystem.PropertyTable">
  15920. For unit Testing only! Returns the underlying
  15921. properties table
  15922. </member>
  15923. <member name="P:NPOI.POIFS.FileSystem.NPOIFSFileSystem.Root">
  15924. Get the root entry
  15925. @return the root entry
  15926. </member>
  15927. <member name="T:NPOI.POIFS.FileSystem.NPOIFSMiniStore">
  15928. This class handles the MiniStream (small block store)
  15929. in the NIO case for {@link NPOIFSFileSystem}
  15930. </member>
  15931. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.GetBlockAt(System.Int32)">
  15932. Load the block at the given offset.
  15933. </member>
  15934. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.CreateBlockIfNeeded(System.Int32)">
  15935. Load the block, extending the underlying stream if needed
  15936. </member>
  15937. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.GetBATBlockAndIndex(System.Int32)">
  15938. Returns the BATBlock that handles the specified offset,
  15939. and the relative index within it
  15940. </member>
  15941. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.GetNextBlock(System.Int32)">
  15942. Works out what block follows the specified one.
  15943. </member>
  15944. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.SetNextBlock(System.Int32,System.Int32)">
  15945. Changes the record of what block follows the specified one.
  15946. </member>
  15947. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.GetFreeBlock">
  15948. Finds a free block, and returns its offset.
  15949. This method will extend the file if needed, and if doing
  15950. so, allocate new FAT blocks to Address the extra space.
  15951. </member>
  15952. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.SyncWithDataSource">
  15953. Writes the SBATs to their backing blocks
  15954. </member>
  15955. <member name="T:NPOI.POIFS.FileSystem.NPOIFSStream">
  15956. This handles Reading and writing a stream within a
  15957. {@link NPOIFSFileSystem}. It can supply an iterator
  15958. to read blocks, and way to write out to existing and
  15959. new blocks.
  15960. Most users will want a higher level version of this,
  15961. which deals with properties to track which stream
  15962. this is.
  15963. This only works on big block streams, it doesn't
  15964. handle small block ones.
  15965. This uses the new NIO code
  15966. TODO Implement a streaming write method, and append
  15967. </member>
  15968. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.#ctor(NPOI.POIFS.FileSystem.BlockStore,System.Int32)">
  15969. Constructor for an existing stream. It's up to you
  15970. to know how to Get the start block (eg from a
  15971. {@link HeaderBlock} or a {@link Property})
  15972. </member>
  15973. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.#ctor(NPOI.POIFS.FileSystem.BlockStore)">
  15974. Constructor for a new stream. A start block won't
  15975. be allocated until you begin writing to it.
  15976. </member>
  15977. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.GetStartBlock">
  15978. What block does this stream start at?
  15979. Will be {@link POIFSConstants#END_OF_CHAIN} for a
  15980. new stream that hasn't been written to yet.
  15981. </member>
  15982. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.GetBlockIterator">
  15983. Returns an iterator that'll supply one {@link ByteBuffer}
  15984. per block in the stream.
  15985. </member>
  15986. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.UpdateContents(System.Byte[])">
  15987. Updates the contents of the stream to the new
  15988. Set of bytes.
  15989. Note - if this is property based, you'll still
  15990. need to update the size in the property yourself
  15991. </member>
  15992. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.Free">
  15993. Frees all blocks in the stream
  15994. </member>
  15995. <member name="T:NPOI.POIFS.FileSystem.ODocumentInputStream">
  15996. This class provides methods to read a DocumentEntry managed by a
  15997. {@link POIFSFileSystem} instance.
  15998. @author Marc Johnson (mjohnson at apache dot org)
  15999. </member>
  16000. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._current_offset">
  16001. current offset into the Document
  16002. </member>
  16003. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._marked_offset">
  16004. current marked offset into the Document (used by mark and Reset)
  16005. </member>
  16006. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._document_size">
  16007. the Document's size
  16008. </member>
  16009. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._closed">
  16010. have we been closed?
  16011. </member>
  16012. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._document">
  16013. the actual Document
  16014. </member>
  16015. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._currentBlock">
  16016. the data block Containing the current stream pointer
  16017. </member>
  16018. <member name="M:NPOI.POIFS.FileSystem.ODocumentInputStream.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  16019. Create an InputStream from the specified DocumentEntry
  16020. @param document the DocumentEntry to be read
  16021. @exception IOException if the DocumentEntry cannot be opened (like, maybe it has
  16022. been deleted?)
  16023. </member>
  16024. <member name="M:NPOI.POIFS.FileSystem.ODocumentInputStream.#ctor(NPOI.POIFS.FileSystem.POIFSDocument)">
  16025. Create an InputStream from the specified Document
  16026. @param document the Document to be read
  16027. </member>
  16028. <member name="M:NPOI.POIFS.FileSystem.ODocumentInputStream.Reset">
  16029. Repositions this stream to the position at the time the mark() method was
  16030. last called on this input stream. If mark() has not been called this
  16031. method repositions the stream to its beginning.
  16032. </member>
  16033. <member name="T:NPOI.POIFS.FileSystem.POIFSDocument">
  16034. <summary>
  16035. This class manages a document in the POIFS filesystem.
  16036. @author Marc Johnson (mjohnson at apache dot org)
  16037. </summary>
  16038. </member>
  16039. <member name="T:NPOI.POIFS.FileSystem.BATManaged">
  16040. <summary>
  16041. This interface defines behaviors for objects managed by the Block
  16042. Allocation Table (BAT).
  16043. @author Marc Johnson (mjohnson at apache dot org)
  16044. </summary>
  16045. </member>
  16046. <member name="P:NPOI.POIFS.FileSystem.BATManaged.CountBlocks">
  16047. <summary>
  16048. Gets the number of BigBlock's this instance uses
  16049. </summary>
  16050. <value>count of BigBlock instances</value>
  16051. </member>
  16052. <member name="P:NPOI.POIFS.FileSystem.BATManaged.StartBlock">
  16053. <summary>
  16054. Sets the start block for this instance
  16055. </summary>
  16056. <value>index into the array of BigBlock instances making up the the filesystem</value>
  16057. </member>
  16058. <member name="T:NPOI.POIFS.Storage.BlockWritable">
  16059. <summary>
  16060. An interface for persisting block storage of POIFS components.
  16061. @author Marc Johnson (mjohnson at apache dot org)
  16062. </summary>
  16063. </member>
  16064. <member name="M:NPOI.POIFS.Storage.BlockWritable.WriteBlocks(System.IO.Stream)">
  16065. <summary>
  16066. Writes the blocks.
  16067. </summary>
  16068. <param name="stream">The stream.</param>
  16069. </member>
  16070. <member name="M:NPOI.POIFS.FileSystem.POIFSDocument.#ctor(System.String,System.IO.Stream)">
  16071. <summary>
  16072. Initializes a new instance of the <see cref="T:NPOI.POIFS.FileSystem.POIFSDocument"/> class.
  16073. </summary>
  16074. <param name="name">the name of the POIFSDocument</param>
  16075. <param name="stream">the InputStream we read data from</param>
  16076. </member>
  16077. <member name="M:NPOI.POIFS.FileSystem.POIFSDocument.#ctor(System.String,NPOI.POIFS.Storage.ListManagedBlock[],System.Int32)">
  16078. <summary>
  16079. Constructor from small blocks
  16080. </summary>
  16081. <param name="name">the name of the POIFSDocument</param>
  16082. <param name="blocks">the small blocks making up the POIFSDocument</param>
  16083. <param name="length">the actual length of the POIFSDocument</param>
  16084. </member>
  16085. <member name="M:NPOI.POIFS.FileSystem.POIFSDocument.Read(System.Byte[],System.Int32)">
  16086. <summary>
  16087. read data from the internal stores
  16088. </summary>
  16089. <param name="buffer">the buffer to write to</param>
  16090. <param name="offset">the offset into our storage to read from</param>
  16091. </member>
  16092. <member name="M:NPOI.POIFS.FileSystem.POIFSDocument.WriteBlocks(System.IO.Stream)">
  16093. <summary>
  16094. Writes the blocks.
  16095. </summary>
  16096. <param name="stream">The stream.</param>
  16097. </member>
  16098. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.CountBlocks">
  16099. <summary>
  16100. Gets the number of BigBlock's this instance uses
  16101. </summary>
  16102. <value>count of BigBlock instances</value>
  16103. </member>
  16104. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.DocumentProperty">
  16105. <summary>
  16106. Gets the document property.
  16107. </summary>
  16108. <value>The document property.</value>
  16109. </member>
  16110. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.PreferArray">
  16111. <summary>
  16112. Provides a short description of the object to be used when a
  16113. POIFSViewable object has not provided its contents.
  16114. </summary>
  16115. <value><c>true</c> if [prefer array]; otherwise, <c>false</c>.</value>
  16116. </member>
  16117. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.ShortDescription">
  16118. <summary>
  16119. Gets the short description.
  16120. </summary>
  16121. <value>The short description.</value>
  16122. </member>
  16123. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.Size">
  16124. <summary>
  16125. Gets the size.
  16126. </summary>
  16127. <value>The size.</value>
  16128. </member>
  16129. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.SmallBlocks">
  16130. <summary>
  16131. Gets the small blocks.
  16132. </summary>
  16133. <value>The small blocks.</value>
  16134. </member>
  16135. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.StartBlock">
  16136. <summary>
  16137. Sets the start block for this instance
  16138. </summary>
  16139. <value>
  16140. index into the array of BigBlock instances making up the the filesystem
  16141. </value>
  16142. </member>
  16143. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.ViewableArray">
  16144. <summary>
  16145. Get an array of objects, some of which may implement POIFSViewable
  16146. </summary>
  16147. <value>The viewable array.</value>
  16148. </member>
  16149. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.ViewableIterator">
  16150. <summary>
  16151. Give viewers a hint as to whether to call ViewableArray or ViewableIterator
  16152. </summary>
  16153. <value>The viewable iterator.</value>
  16154. </member>
  16155. <member name="T:NPOI.POIFS.NIO.ByteArrayBackedDataSource">
  16156. <summary>
  16157. A POIFS <see cref="T:NPOI.POIFS.NIO.DataSource"/> backed by a byte array.
  16158. </summary>
  16159. </member>
  16160. <member name="T:NPOI.POIFS.NIO.DataSource">
  16161. <summary>
  16162. Common definition of how we read and write bytes
  16163. </summary>
  16164. </member>
  16165. <member name="M:NPOI.POIFS.NIO.DataSource.Close">
  16166. <summary>
  16167. Close the underlying stream
  16168. </summary>
  16169. </member>
  16170. <member name="M:NPOI.POIFS.NIO.DataSource.CopyTo(System.IO.Stream)">
  16171. <summary>
  16172. Copies the contents to the specified Stream
  16173. </summary>
  16174. <param name="stream"></param>
  16175. </member>
  16176. <member name="T:NPOI.POIFS.NIO.FileBackedDataSource">
  16177. <summary>
  16178. A POIFS DataSource backed by a File
  16179. TODO - Return the ByteBuffers in such a way that in RW mode,
  16180. changes to the buffer end up on the disk (will fix the HPSF TestWrite
  16181. currently failing unit test when done)
  16182. </summary>
  16183. </member>
  16184. <member name="M:NPOI.POIFS.NIO.FileBackedDataSource.Read(System.Int32,System.Int64)">
  16185. <summary>
  16186. Reads a sequence of bytes from this FileStream starting at the given file position.
  16187. </summary>
  16188. <param name="length"></param>
  16189. <param name="position">The file position at which the transfer is to begin;</param>
  16190. <returns></returns>
  16191. </member>
  16192. <member name="M:NPOI.POIFS.NIO.FileBackedDataSource.Write(NPOI.Util.ByteBuffer,System.Int64)">
  16193. <summary>
  16194. Writes a sequence of bytes to this FileStream from the given Stream,
  16195. starting at the given file position.
  16196. </summary>
  16197. <param name="src">The Stream from which bytes are to be transferred</param>
  16198. <param name="position">The file position at which the transfer is to begin;
  16199. must be non-negative</param>
  16200. </member>
  16201. <member name="M:NPOI.POIFS.Properties.NPropertyTable.PreWrite">
  16202. Prepare to be written
  16203. </member>
  16204. <member name="T:NPOI.POIFS.Storage.HeaderBlock">
  16205. <summary>
  16206. The block containing the archive header
  16207. @author Marc Johnson (mjohnson at apache dot org)
  16208. </summary>
  16209. </member>
  16210. <member name="T:NPOI.POIFS.Storage.HeaderBlockConstants">
  16211. <summary>
  16212. Constants used in reading/writing the Header block
  16213. @author Marc Johnson (mjohnson at apache dot org)
  16214. </summary>
  16215. </member>
  16216. <member name="F:NPOI.POIFS.Storage.HeaderBlock.bigBlockSize">
  16217. What big block Size the file uses. Most files
  16218. use 512 bytes, but a few use 4096
  16219. </member>
  16220. <member name="F:NPOI.POIFS.Storage.HeaderBlock._sbat_count">
  16221. Number of small block allocation table blocks (int)
  16222. (Number of MiniFAT Sectors in Microsoft parlance)
  16223. </member>
  16224. <member name="M:NPOI.POIFS.Storage.HeaderBlock.#ctor(System.IO.Stream)">
  16225. <summary>
  16226. create a new HeaderBlockReader from an Stream
  16227. </summary>
  16228. <param name="stream">the source Stream</param>
  16229. </member>
  16230. <member name="M:NPOI.POIFS.Storage.HeaderBlock.AlertShortRead(System.Int32,System.Int32)">
  16231. <summary>
  16232. Alerts the short read.
  16233. </summary>
  16234. <param name="read">The read.</param>
  16235. <param name="expectedReadSize">The expected size.</param>
  16236. </member>
  16237. <member name="P:NPOI.POIFS.Storage.HeaderBlock.PropertyStart">
  16238. <summary>
  16239. Get start of Property Table
  16240. </summary>
  16241. <value>the index of the first block of the Property Table</value>
  16242. </member>
  16243. <member name="P:NPOI.POIFS.Storage.HeaderBlock.SBATStart">
  16244. <summary>
  16245. Gets start of small block allocation table
  16246. </summary>
  16247. <value>The SBAT start.</value>
  16248. </member>
  16249. <member name="P:NPOI.POIFS.Storage.HeaderBlock.SBATCount">
  16250. <summary>
  16251. Gets number of BAT blocks
  16252. </summary>
  16253. <value>The BAT count.</value>
  16254. </member>
  16255. <member name="P:NPOI.POIFS.Storage.HeaderBlock.BATArray">
  16256. <summary>
  16257. Gets the BAT array.
  16258. </summary>
  16259. <value>The BAT array.</value>
  16260. </member>
  16261. <member name="P:NPOI.POIFS.Storage.HeaderBlock.XBATCount">
  16262. <summary>
  16263. Gets the XBAT count.
  16264. </summary>
  16265. <value>The XBAT count.</value>
  16266. @return XBAT count
  16267. </member>
  16268. <member name="P:NPOI.POIFS.Storage.HeaderBlock.XBATIndex">
  16269. <summary>
  16270. Gets the index of the XBAT.
  16271. </summary>
  16272. <value>The index of the XBAT.</value>
  16273. </member>
  16274. <member name="P:NPOI.POIFS.Storage.HeaderBlock.BigBlockSize">
  16275. <summary>
  16276. Gets The Big Block Size, normally 512 bytes, sometimes 4096 bytes
  16277. </summary>
  16278. <value>The size of the big block.</value>
  16279. @return
  16280. </member>
  16281. <member name="T:NPOI.SS.Format.CellDateFormatter">
  16282. Formats a date value.
  16283. @author Ken Arnold, Industrious Media LLC
  16284. </member>
  16285. <member name="T:NPOI.SS.Format.CellFormatter">
  16286. This is the abstract supertype for the various cell formatters.
  16287. @author Ken Arnold, Industrious Media LLC
  16288. </member>
  16289. <member name="F:NPOI.SS.Format.CellFormatter.format">
  16290. The original specified format.
  16291. </member>
  16292. <member name="F:NPOI.SS.Format.CellFormatter.LOCALE">
  16293. This is the locale used to Get a consistent format result from which to
  16294. work.
  16295. </member>
  16296. <member name="M:NPOI.SS.Format.CellFormatter.#ctor(System.String)">
  16297. Creates a new formatter object, storing the format in {@link #format}.
  16298. @param format The format.
  16299. </member>
  16300. <member name="M:NPOI.SS.Format.CellFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  16301. Format a value according the format string.
  16302. @param toAppendTo The buffer to append to.
  16303. @param value The value to format.
  16304. </member>
  16305. <member name="M:NPOI.SS.Format.CellFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  16306. Format a value according to the type, in the most basic way.
  16307. @param toAppendTo The buffer to append to.
  16308. @param value The value to format.
  16309. </member>
  16310. <member name="M:NPOI.SS.Format.CellFormatter.Format(System.Object)">
  16311. Formats the value, returning the resulting string.
  16312. @param value The value to format.
  16313. @return The value, formatted.
  16314. </member>
  16315. <member name="M:NPOI.SS.Format.CellFormatter.SimpleFormat(System.Object)">
  16316. Formats the value in the most basic way, returning the resulting string.
  16317. @param value The value to format.
  16318. @return The value, formatted.
  16319. </member>
  16320. <member name="M:NPOI.SS.Format.CellFormatter.Quote(System.String)">
  16321. Returns the input string, surrounded by quotes.
  16322. @param str The string to quote.
  16323. @return The input string, surrounded by quotes.
  16324. </member>
  16325. <member name="M:NPOI.SS.Format.CellDateFormatter.#ctor(System.String)">
  16326. Creates a new date formatter with the given specification.
  16327. @param format The format.
  16328. </member>
  16329. <member name="M:NPOI.SS.Format.CellDateFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  16330. {@inheritDoc}
  16331. </member>
  16332. <member name="M:NPOI.SS.Format.CellDateFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  16333. {@inheritDoc}
  16334. <p/>
  16335. For a date, this is <tt>"mm/d/y"</tt>.
  16336. </member>
  16337. <member name="T:NPOI.SS.Format.CellFormatPart">
  16338. Objects of this class represent a single part of a cell format expression.
  16339. Each cell can have up to four of these for positive, zero, negative, and text
  16340. values.
  16341. <p/>
  16342. Each format part can contain a color, a condition, and will always contain a
  16343. format specification. For example <tt>"[Red][>=10]#"</tt> has a color
  16344. (<tt>[Red]</tt>), a condition (<tt>>=10</tt>) and a format specification
  16345. (<tt>#</tt>).
  16346. <p/>
  16347. This class also Contains patterns for matching the subparts of format
  16348. specification. These are used internally, but are made public in case other
  16349. code has use for them.
  16350. @author Ken Arnold, Industrious Media LLC
  16351. </member>
  16352. <member name="F:NPOI.SS.Format.CellFormatPart.COLOR_PAT">
  16353. Pattern for the color part of a cell format part.
  16354. </member>
  16355. <member name="F:NPOI.SS.Format.CellFormatPart.CONDITION_PAT">
  16356. Pattern for the condition part of a cell format part.
  16357. </member>
  16358. <member name="F:NPOI.SS.Format.CellFormatPart.SPECIFICATION_PAT">
  16359. Pattern for the format specification part of a cell format part.
  16360. </member>
  16361. <member name="F:NPOI.SS.Format.CellFormatPart.FORMAT_PAT">
  16362. Pattern for an entire cell single part.
  16363. </member>
  16364. <member name="F:NPOI.SS.Format.CellFormatPart.COLOR_GROUP">
  16365. Within {@link #FORMAT_PAT}, the group number for the matched color.
  16366. </member>
  16367. <member name="F:NPOI.SS.Format.CellFormatPart.CONDITION_OPERATOR_GROUP">
  16368. Within {@link #FORMAT_PAT}, the group number for the operator in the
  16369. condition.
  16370. </member>
  16371. <member name="F:NPOI.SS.Format.CellFormatPart.CONDITION_VALUE_GROUP">
  16372. Within {@link #FORMAT_PAT}, the group number for the value in the
  16373. condition.
  16374. </member>
  16375. <member name="F:NPOI.SS.Format.CellFormatPart.SPECIFICATION_GROUP">
  16376. Within {@link #FORMAT_PAT}, the group number for the format
  16377. specification.
  16378. </member>
  16379. <member name="M:NPOI.SS.Format.CellFormatPart.#ctor(System.String)">
  16380. Create an object to represent a format part.
  16381. @param desc The string to Parse.
  16382. </member>
  16383. <member name="M:NPOI.SS.Format.CellFormatPart.Applies(System.Object)">
  16384. Returns <tt>true</tt> if this format part applies to the given value. If
  16385. the value is a number and this is part has a condition, returns
  16386. <tt>true</tt> only if the number passes the condition. Otherwise, this
  16387. allways return <tt>true</tt>.
  16388. @param valueObject The value to Evaluate.
  16389. @return <tt>true</tt> if this format part applies to the given value.
  16390. </member>
  16391. <member name="M:NPOI.SS.Format.CellFormatPart.FindGroup(System.Text.RegularExpressions.Regex,System.String,System.String)">
  16392. Returns the number of the first group that is the same as the marker
  16393. string. The search starts with group 1.
  16394. @param pat The pattern to use.
  16395. @param str The string to match against the pattern.
  16396. @param marker The marker value to find the group of.
  16397. @return The matching group number.
  16398. @throws ArgumentException No group matches the marker.
  16399. </member>
  16400. <member name="M:NPOI.SS.Format.CellFormatPart.GetColor(System.Text.RegularExpressions.Match)">
  16401. Returns the color specification from the matcher, or <tt>null</tt> if
  16402. there is none.
  16403. @param m The matcher for the format part.
  16404. @return The color specification or <tt>null</tt>.
  16405. </member>
  16406. <member name="M:NPOI.SS.Format.CellFormatPart.GetCondition(System.Text.RegularExpressions.Match)">
  16407. Returns the condition specification from the matcher, or <tt>null</tt> if
  16408. there is none.
  16409. @param m The matcher for the format part.
  16410. @return The condition specification or <tt>null</tt>.
  16411. </member>
  16412. <member name="M:NPOI.SS.Format.CellFormatPart.GetCellFormatType(System.Text.RegularExpressions.Match)">
  16413. Returns the CellFormatType object implied by the format specification for
  16414. the format part.
  16415. @param matcher The matcher for the format part.
  16416. @return The CellFormatType.
  16417. </member>
  16418. <member name="M:NPOI.SS.Format.CellFormatPart.GetFormatter(System.Text.RegularExpressions.Match)">
  16419. Returns the formatter object implied by the format specification for the
  16420. format part.
  16421. @param matcher The matcher for the format part.
  16422. @return The formatter.
  16423. </member>
  16424. <member name="M:NPOI.SS.Format.CellFormatPart.formatType(System.String)">
  16425. Returns the type of format.
  16426. @param fdesc The format specification
  16427. @return The type of format.
  16428. </member>
  16429. <member name="M:NPOI.SS.Format.CellFormatPart.QuoteSpecial(System.String,NPOI.SS.Format.CellFormatType)">
  16430. Returns a version of the original string that has any special characters
  16431. quoted (or escaped) as appropriate for the cell format type. The format
  16432. type object is queried to see what is special.
  16433. @param repl The original string.
  16434. @param type The format type representation object.
  16435. @return A version of the string with any special characters Replaced.
  16436. @see CellFormatType#isSpecial(char)
  16437. </member>
  16438. <member name="M:NPOI.SS.Format.CellFormatPart.Apply(System.Object)">
  16439. Apply this format part to the given value. This returns a {@link
  16440. CellFormatResult} object with the results.
  16441. @param value The value to apply this format part to.
  16442. @return A {@link CellFormatResult} object Containing the results of
  16443. Applying the format to the value.
  16444. </member>
  16445. <member name="M:NPOI.SS.Format.CellFormatPart.Apply(System.Windows.Forms.Label,System.Object)">
  16446. Apply this format part to the given value, Applying the result to the
  16447. given label.
  16448. @param label The label
  16449. @param value The value to apply this format part to.
  16450. @return <tt>true</tt> if the
  16451. </member>
  16452. <member name="M:NPOI.SS.Format.CellFormatPart.ExpandChar(System.String)">
  16453. Expands a character. This is only partly done, because we don't have the
  16454. correct info. In Excel, this would be expanded to fill the rest of the
  16455. cell, but we don't know, in general, what the "rest of the cell" is1.
  16456. @param part The character to be repeated is the second character in this
  16457. string.
  16458. @return The character repeated three times.
  16459. </member>
  16460. <member name="M:NPOI.SS.Format.CellFormatPart.Group(System.Text.RegularExpressions.Match,System.Int32)">
  16461. Returns the string from the group, or <tt>""</tt> if the group is
  16462. <tt>null</tt>.
  16463. @param m The matcher.
  16464. @param g The group number.
  16465. @return The group or <tt>""</tt>.
  16466. </member>
  16467. <member name="P:NPOI.SS.Format.CellFormatPart.CellFormatType">
  16468. Returns the CellFormatType object implied by the format specification for
  16469. the format part.
  16470. @return The CellFormatType.
  16471. </member>
  16472. <member name="P:NPOI.SS.Format.CellFormatPart.HasCondition">
  16473. Returns <tt>true</tt> if this format part has a condition.
  16474. @return <tt>true</tt> if this format part has a condition.
  16475. </member>
  16476. <member name="T:NPOI.SS.Format.CellElapsedFormatter">
  16477. This class : printing out an elapsed time format.
  16478. @author Ken Arnold, Industrious Media LLC
  16479. </member>
  16480. <member name="M:NPOI.SS.Format.CellElapsedFormatter.#ctor(System.String)">
  16481. Creates a elapsed time formatter.
  16482. @param pattern The pattern to Parse.
  16483. </member>
  16484. <member name="M:NPOI.SS.Format.CellElapsedFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  16485. {@inheritDoc}
  16486. </member>
  16487. <member name="M:NPOI.SS.Format.CellElapsedFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  16488. {@inheritDoc}
  16489. <p/>
  16490. For a date, this is <tt>"mm/d/y"</tt>.
  16491. </member>
  16492. <member name="T:NPOI.SS.Format.CellFormat">
  16493. Format a value according to the standard Excel behavior. This "standard" is
  16494. not explicitly documented by Microsoft, so the behavior is determined by
  16495. experimentation; see the tests.
  16496. An Excel format has up to four parts, Separated by semicolons. Each part
  16497. specifies what to do with particular kinds of values, depending on the number
  16498. of parts given:
  16499. - One part (example: <c>[Green]#.##</c>)
  16500. If the value is a number, display according to this one part (example: green text,
  16501. with up to two decimal points). If the value is text, display it as is.
  16502. - Two parts (example: <c>[Green]#.##;[Red]#.##</c>)
  16503. If the value is a positive number or zero, display according to the first part (example: green
  16504. text, with up to two decimal points); if it is a negative number, display
  16505. according to the second part (example: red text, with up to two decimal
  16506. points). If the value is text, display it as is.
  16507. - Three parts (example: <c>[Green]#.##;[Black]#.##;[Red]#.##</c>)
  16508. If the value is a positive number, display according to the first part (example: green text, with up to
  16509. two decimal points); if it is zero, display according to the second part
  16510. (example: black text, with up to two decimal points); if it is a negative
  16511. number, display according to the third part (example: red text, with up to
  16512. two decimal points). If the value is text, display it as is.
  16513. - Four parts (example: <c>[Green]#.##;[Black]#.##;[Red]#.##;[@]</c>)
  16514. If the value is a positive number, display according to the first part (example: green text,
  16515. with up to two decimal points); if it is zero, display according to the
  16516. second part (example: black text, with up to two decimal points); if it is a
  16517. negative number, display according to the third part (example: red text, with
  16518. up to two decimal points). If the value is text, display according to the
  16519. fourth part (example: text in the cell's usual color, with the text value
  16520. surround by brackets).
  16521. In Addition to these, there is a general format that is used when no format
  16522. is specified. This formatting is presented by the {@link #GENERAL_FORMAT}
  16523. object.
  16524. @author Ken Arnold, Industrious Media LLC
  16525. </member>
  16526. <member name="F:NPOI.SS.Format.CellFormat.formatCache">
  16527. Maps a format string to its Parsed version for efficiencies sake.
  16528. </member>
  16529. <member name="M:NPOI.SS.Format.CellFormat.GetInstance(System.String)">
  16530. Returns a {@link CellFormat} that applies the given format. Two calls
  16531. with the same format may or may not return the same object.
  16532. @param format The format.
  16533. @return A {@link CellFormat} that applies the given format.
  16534. </member>
  16535. <member name="M:NPOI.SS.Format.CellFormat.#ctor(System.String)">
  16536. Creates a new object.
  16537. @param format The format.
  16538. </member>
  16539. <member name="M:NPOI.SS.Format.CellFormat.Apply(System.Object)">
  16540. Returns the result of Applying the format to the given value. If the
  16541. value is a number (a type of {@link Number} object), the correct number
  16542. format type is chosen; otherwise it is considered a text object.
  16543. @param value The value
  16544. @return The result, in a {@link CellFormatResult}.
  16545. </member>
  16546. <member name="M:NPOI.SS.Format.CellFormat.Apply(System.DateTime,System.Double)">
  16547. Returns the result of applying the format to the given date.
  16548. @param date The date.
  16549. @param numericValue The numeric value for the date.
  16550. @return The result, in a {@link CellFormatResult}.
  16551. </member>
  16552. <member name="M:NPOI.SS.Format.CellFormat.Apply(NPOI.SS.UserModel.ICell)">
  16553. Fetches the appropriate value from the cell, and returns the result of
  16554. Applying it to the appropriate format. For formula cells, the computed
  16555. value is what is used.
  16556. @param c The cell.
  16557. @return The result, in a {@link CellFormatResult}.
  16558. </member>
  16559. <member name="M:NPOI.SS.Format.CellFormat.Apply(System.Windows.Forms.Label,System.Object)">
  16560. Uses the result of Applying this format to the value, Setting the text
  16561. and color of a label before returning the result.
  16562. @param label The label to apply to.
  16563. @param value The value to Process.
  16564. @return The result, in a {@link CellFormatResult}.
  16565. </member>
  16566. <member name="M:NPOI.SS.Format.CellFormat.Apply(System.Windows.Forms.Label,System.DateTime,System.Double)">
  16567. Uses the result of applying this format to the given date, setting the text
  16568. and color of a label before returning the result.
  16569. @param label The label to apply to.
  16570. @param date The date.
  16571. @param numericValue The numeric value for the date.
  16572. @return The result, in a {@link CellFormatResult}.
  16573. </member>
  16574. <member name="M:NPOI.SS.Format.CellFormat.Apply(System.Windows.Forms.Label,NPOI.SS.UserModel.ICell)">
  16575. Fetches the appropriate value from the cell, and uses the result, Setting
  16576. the text and color of a label before returning the result.
  16577. @param label The label to apply to.
  16578. @param c The cell.
  16579. @return The result, in a {@link CellFormatResult}.
  16580. </member>
  16581. <member name="M:NPOI.SS.Format.CellFormat.GetApplicableFormatPart(System.Object)">
  16582. Returns the {@link CellFormatPart} that applies to the value. Result
  16583. depends on how many parts the cell format has, the cell value and any
  16584. conditions. The value must be a {@link Number}.
  16585. @param value The value.
  16586. @return The {@link CellFormatPart} that applies to the value.
  16587. </member>
  16588. <member name="M:NPOI.SS.Format.CellFormat.UltimateType(NPOI.SS.UserModel.ICell)">
  16589. Returns the ultimate cell type, following the results of formulas. If
  16590. the cell is a {@link Cell#CELL_TYPE_FORMULA}, this returns the result of
  16591. {@link Cell#getCachedFormulaResultType()}. Otherwise this returns the
  16592. result of {@link Cell#getCellType()}.
  16593. @param cell The cell.
  16594. @return The ultimate type of this cell.
  16595. </member>
  16596. <member name="M:NPOI.SS.Format.CellFormat.Equals(System.Object)">
  16597. Returns <tt>true</tt> if the other object is a {@link CellFormat} object
  16598. with the same format.
  16599. @param obj The other object.
  16600. @return <tt>true</tt> if the two objects are Equal.
  16601. </member>
  16602. <member name="M:NPOI.SS.Format.CellFormat.GetHashCode">
  16603. Returns a hash code for the format.
  16604. @return A hash code for the format.
  16605. </member>
  16606. <member name="T:NPOI.SS.Format.CellFormat.GeneralCellFormat">
  16607. Format a value as it would be were no format specified. This is also
  16608. used when the format specified is <tt>General</tt>.
  16609. </member>
  16610. <member name="T:NPOI.SS.Format.CellFormatCondition">
  16611. This object represents a condition in a cell format.
  16612. @author Ken Arnold, Industrious Media LLC
  16613. </member>
  16614. <member name="M:NPOI.SS.Format.CellFormatCondition.GetInstance(System.String,System.String)">
  16615. Returns an instance of a condition object.
  16616. @param opString The operator as a string. One of <tt>"&lt;"</tt>,
  16617. <tt>"&lt;="</tt>, <tt>">"</tt>, <tt>">="</tt>,
  16618. <tt>"="</tt>, <tt>"=="</tt>, <tt>"!="</tt>, or
  16619. <tt>"&lt;>"</tt>.
  16620. @param constStr The constant (such as <tt>"12"</tt>).
  16621. @return A condition object for the given condition.
  16622. </member>
  16623. <member name="M:NPOI.SS.Format.CellFormatCondition.Pass(System.Double)">
  16624. Returns <tt>true</tt> if the given value passes the constraint's test.
  16625. @param value The value to compare against.
  16626. @return <tt>true</tt> if the given value passes the constraint's test.
  16627. </member>
  16628. <member name="T:NPOI.SS.Format.CellFormatResult">
  16629. This object Contains the result of Applying a cell format or cell format part
  16630. to a value.
  16631. @author Ken Arnold, Industrious Media LLC
  16632. @see CellFormatPart#Apply(Object)
  16633. @see CellFormat#Apply(Object)
  16634. </member>
  16635. <member name="M:NPOI.SS.Format.CellFormatResult.#ctor(System.Boolean,System.String,System.Drawing.Color)">
  16636. Creates a new format result object.
  16637. @param applies The value for {@link #applies}.
  16638. @param text The value for {@link #text}.
  16639. @param textColor The value for {@link #textColor}.
  16640. </member>
  16641. <member name="P:NPOI.SS.Format.CellFormatResult.Applies">
  16642. This is <tt>true</tt> if no condition was given that applied to the
  16643. value, or if the condition is satisfied. If a condition is relevant, and
  16644. when applied the value fails the test, this is <tt>false</tt>.
  16645. </member>
  16646. <member name="P:NPOI.SS.Format.CellFormatResult.Text">
  16647. The resulting text. This will never be <tt>null</tt>.
  16648. </member>
  16649. <member name="P:NPOI.SS.Format.CellFormatResult.TextColor">
  16650. The color the format Sets, or <tt>null</tt> if the format Sets no color.
  16651. This will always be <tt>null</tt> if {@link #applies} is <tt>false</tt>.
  16652. </member>
  16653. <member name="T:NPOI.SS.Format.CellFormatType">
  16654. The different kinds of formats that the formatter understands.
  16655. @author Ken Arnold, Industrious Media LLC
  16656. </member>
  16657. <member name="F:NPOI.SS.Format.CellFormatType.GENERAL">
  16658. The general (default) format; also used for <tt>"General"</tt>.
  16659. </member>
  16660. <member name="F:NPOI.SS.Format.CellFormatType.NUMBER">
  16661. A numeric format.
  16662. </member>
  16663. <member name="F:NPOI.SS.Format.CellFormatType.DATE">
  16664. A date format.
  16665. </member>
  16666. <member name="F:NPOI.SS.Format.CellFormatType.ELAPSED">
  16667. An elapsed time format.
  16668. </member>
  16669. <member name="F:NPOI.SS.Format.CellFormatType.TEXT">
  16670. A text format.
  16671. </member>
  16672. <member name="M:NPOI.SS.Format.CellFormatType.IsSpecial(System.Char)">
  16673. Returns <tt>true</tt> if the format is special and needs to be quoted.
  16674. @param ch The character to test.
  16675. @return <tt>true</tt> if the format is special and needs to be quoted.
  16676. </member>
  16677. <member name="M:NPOI.SS.Format.CellFormatType.Formatter(System.String)">
  16678. Returns a new formatter of the appropriate type, for the given pattern.
  16679. The pattern must be appropriate for the type.
  16680. @param pattern The pattern to use.
  16681. @return A new formatter of the appropriate type, for the given pattern.
  16682. </member>
  16683. <member name="T:NPOI.SS.Format.CellGeneralFormatter">
  16684. A formatter for the default "General" cell format.
  16685. @author Ken Arnold, Industrious Media LLC
  16686. </member>
  16687. <member name="M:NPOI.SS.Format.CellGeneralFormatter.#ctor">
  16688. Creates a new general formatter.
  16689. </member>
  16690. <member name="M:NPOI.SS.Format.CellGeneralFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  16691. The general style is not quite the same as any other, or any combination
  16692. of others.
  16693. @param toAppendTo The buffer to append to.
  16694. @param value The value to format.
  16695. </member>
  16696. <member name="M:NPOI.SS.Format.CellGeneralFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  16697. Equivalent to {@link #formatValue(StringBuilder,Object)}. {@inheritDoc}.
  16698. </member>
  16699. <member name="T:NPOI.SS.Format.CellNumberFormatter">
  16700. This class : printing out a value using a number format.
  16701. @author Ken Arnold, Industrious Media LLC
  16702. </member>
  16703. <member name="M:NPOI.SS.Format.CellNumberFormatter.#ctor(System.String)">
  16704. Creates a new cell number formatter.
  16705. @param format The format to Parse.
  16706. </member>
  16707. <member name="M:NPOI.SS.Format.CellNumberFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  16708. {@inheritDoc}
  16709. </member>
  16710. <member name="M:NPOI.SS.Format.CellNumberFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  16711. {@inheritDoc}
  16712. <p/>
  16713. For a number, this is <tt>"#"</tt> for integer values, and <tt>"#.#"</tt>
  16714. for floating-point values.
  16715. </member>
  16716. <member name="T:NPOI.SS.Format.CellNumberFormatter.SimpleNumberCellFormatter">
  16717. <summary>
  16718. The CellNumberFormatter.simpleValue() method uses the SIMPLE_NUMBER
  16719. CellFormatter defined here. The CellFormat.GENERAL_FORMAT CellFormat
  16720. no longer uses the SIMPLE_NUMBER CellFormatter.
  16721. Note that the simpleValue()/SIMPLE_NUMBER CellFormatter format
  16722. ("#" for integer values, and "#.#" for floating-point values) is
  16723. different from the 'General' format for numbers ("#" for integer
  16724. values and "#.#########" for floating-point values).
  16725. </summary>
  16726. </member>
  16727. <member name="T:NPOI.SS.Format.CellNumberFormatter.Special">
  16728. This class is used to mark where the special characters in the format
  16729. are, as opposed to the other characters that are simply printed.
  16730. </member>
  16731. <member name="T:NPOI.SS.Format.CellNumberFormatter.StringMod">
  16732. This class represents a single modification to a result string. The way
  16733. this works is complicated, but so is numeric formatting. In general, for
  16734. most formats, we use a DecimalFormat object that will Put the string out
  16735. in a known format, usually with all possible leading and trailing zeros.
  16736. We then walk through the result and the orginal format, and note any
  16737. modifications that need to be made. Finally, we go through and apply
  16738. them all, dealing with overlapping modifications.
  16739. </member>
  16740. <member name="T:NPOI.SS.Format.CellTextFormatter">
  16741. This class : printing out text.
  16742. @author Ken Arnold, Industrious Media LLC
  16743. </member>
  16744. <member name="M:NPOI.SS.Format.CellTextFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  16745. {@inheritDoc}
  16746. </member>
  16747. <member name="M:NPOI.SS.Format.CellTextFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  16748. {@inheritDoc}
  16749. <p/>
  16750. For text, this is just printing the text.
  16751. </member>
  16752. <member name="T:NPOI.SS.Formula.Functions.EDate">
  16753. Implementation of Excel 'Analysis ToolPak' function EDATE()<br/>
  16754. Adds a specified number of months to the specified date.<p/>
  16755. <b>Syntax</b><br/>
  16756. <b>EDATE</b>(<b>date</b>, <b>number</b>)
  16757. <p/>
  16758. @author Tomas Herceg
  16759. </member>
  16760. <member name="T:NPOI.SS.Formula.Constant.ConstantValueParser">
  16761. To support Constant Values (2.5.7) as required by the CRN record.
  16762. This class is also used for two dimensional arrays which are encoded by
  16763. EXTERNALNAME (5.39) records and Array tokens.<p/>
  16764. @author Josh Micich
  16765. </member>
  16766. <member name="M:NPOI.SS.Formula.Constant.ConstantValueParser.GetEncodedSize(System.Object)">
  16767. @return encoded size without the 'type' code byte
  16768. </member>
  16769. <member name="T:NPOI.SS.Formula.Constant.ErrorConstant">
  16770. <summary>
  16771. Represents a constant error code value as encoded in a constant values array.
  16772. This class is a type-safe wrapper for a 16-bit int value performing a similar job to
  16773. <c>ErrorEval</c>
  16774. </summary>
  16775. <remarks> @author Josh Micich</remarks>
  16776. </member>
  16777. <member name="M:NPOI.SS.Formula.Constant.ErrorConstant.#ctor(System.Int32)">
  16778. <summary>
  16779. Initializes a new instance of the <see cref="T:NPOI.SS.Formula.Constant.ErrorConstant"/> class.
  16780. </summary>
  16781. <param name="errorCode">The error code.</param>
  16782. </member>
  16783. <member name="M:NPOI.SS.Formula.Constant.ErrorConstant.ValueOf(System.Int32)">
  16784. <summary>
  16785. Values the of.
  16786. </summary>
  16787. <param name="errorCode">The error code.</param>
  16788. <returns></returns>
  16789. </member>
  16790. <member name="M:NPOI.SS.Formula.Constant.ErrorConstant.ToString">
  16791. <summary>
  16792. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  16793. </summary>
  16794. <returns>
  16795. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  16796. </returns>
  16797. </member>
  16798. <member name="P:NPOI.SS.Formula.Constant.ErrorConstant.ErrorCode">
  16799. <summary>
  16800. Gets the error code.
  16801. </summary>
  16802. <value>The error code.</value>
  16803. </member>
  16804. <member name="P:NPOI.SS.Formula.Constant.ErrorConstant.Text">
  16805. <summary>
  16806. Gets the text.
  16807. </summary>
  16808. <value>The text.</value>
  16809. </member>
  16810. <member name="T:NPOI.HSSF.Record.ContinueRecord">
  16811. Title: Continue Record - Helper class used primarily for SST Records
  16812. Description: handles overflow for prior record in the input
  16813. stream; content Is tailored to that prior record
  16814. @author Marc Johnson (mjohnson at apache dot org)
  16815. @author Andrew C. Oliver (acoliver at apache dot org)
  16816. @author Csaba Nagy (ncsaba at yahoo dot com)
  16817. @version 2.0-pre
  16818. </member>
  16819. <member name="M:NPOI.HSSF.Record.ContinueRecord.#ctor">
  16820. default constructor
  16821. </member>
  16822. <member name="M:NPOI.HSSF.Record.ContinueRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16823. Main constructor -- kinda dummy because we don't validate or fill fields
  16824. @param in the RecordInputstream to Read the record from
  16825. </member>
  16826. <member name="M:NPOI.HSSF.Record.ContinueRecord.Write(System.Byte[],System.Int32,System.Nullable{System.Byte},System.Byte[])">
  16827. Writes the full encoding of a Continue record without making an instance
  16828. </member>
  16829. <member name="M:NPOI.HSSF.Record.ContinueRecord.Write(System.Byte[],System.Int32,System.Nullable{System.Byte},System.Byte[],System.Int32,System.Int32)">
  16830. @param initialDataByte (optional - often used for unicode flag).
  16831. If supplied, this will be written before srcData
  16832. @return the total number of bytes written
  16833. </member>
  16834. <member name="M:NPOI.HSSF.Record.ContinueRecord.ToString">
  16835. Debugging toString
  16836. @return string representation
  16837. </member>
  16838. <member name="M:NPOI.HSSF.Record.ContinueRecord.Clone">
  16839. Clone this record.
  16840. </member>
  16841. <member name="P:NPOI.HSSF.Record.ContinueRecord.Data">
  16842. Get the data for continuation
  16843. @return byte array containing all of the continued data
  16844. </member>
  16845. <member name="T:NPOI.HSSF.Record.Cont.ContinuableRecord">
  16846. Common superclass of all records that can produce {@link ContinueRecord}s while being Serialized.
  16847. @author Josh Micich
  16848. </member>
  16849. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecord.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  16850. Serializes this record's content to the supplied data output.<br/>
  16851. The standard BIFF header (ushort sid, ushort size) has been handled by the superclass, so
  16852. only BIFF data should be written by this method. Simple data types can be written with the
  16853. standard {@link LittleEndianOutput} methods. Methods from {@link ContinuableRecordOutput}
  16854. can be used to Serialize strings (with {@link ContinueRecord}s being written as required).
  16855. If necessary, implementors can explicitly start {@link ContinueRecord}s (regardless of the
  16856. amount of remaining space).
  16857. @param out a data output stream
  16858. </member>
  16859. <member name="P:NPOI.HSSF.Record.Cont.ContinuableRecord.RecordSize">
  16860. @return the total Length of the encoded record(s)
  16861. (Note - if any {@link ContinueRecord} is required, this result includes the
  16862. size of those too)
  16863. </member>
  16864. <member name="T:NPOI.HSSF.Record.Cont.ContinuableRecordOutput">
  16865. An augmented {@link LittleEndianOutput} used for serialization of {@link ContinuableRecord}s.
  16866. This class keeps track of how much remaining space is available in the current BIFF record and
  16867. can start new {@link ContinueRecord}s as required.
  16868. @author Josh Micich
  16869. </member>
  16870. <member name="T:NPOI.Util.ILittleEndianOutput">
  16871. @author Josh Micich
  16872. </member>
  16873. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.Terminate">
  16874. Terminates the last record (also updates its 'ushort size' field)
  16875. </member>
  16876. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.WriteContinue">
  16877. Terminates the current record and starts a new {@link ContinueRecord} (regardless
  16878. of how much space is still available in the current record).
  16879. </member>
  16880. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.WriteStringData(System.String)">
  16881. Writes the 'optionFlags' byte and encoded character data of a unicode string. This includes:
  16882. <ul>
  16883. <li>byte optionFlags</li>
  16884. <li>encoded character data (in "ISO-8859-1" or "UTF-16LE" encoding)</li>
  16885. </ul>
  16886. Notes:
  16887. <ul>
  16888. <li>The value of the 'is16bitEncoded' flag is determined by the actual character data
  16889. of <c>text</c></li>
  16890. <li>The string options flag is never separated (by a {@link ContinueRecord}) from the
  16891. first chunk of character data it refers to.</li>
  16892. <li>The 'ushort Length' field is assumed to have been explicitly written earlier. Hence,
  16893. there may be an intervening {@link ContinueRecord}</li>
  16894. </ul>
  16895. </member>
  16896. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.WriteString(System.String,System.Int32,System.Int32)">
  16897. Writes a unicode string complete with header and character data. This includes:
  16898. <ul>
  16899. <li>ushort Length</li>
  16900. <li>byte optionFlags</li>
  16901. <li>ushort numberOfRichTextRuns (optional)</li>
  16902. <li>ushort extendedDataSize (optional)</li>
  16903. <li>encoded character data (in "ISO-8859-1" or "UTF-16LE" encoding)</li>
  16904. </ul>
  16905. The following bits of the 'optionFlags' byte will be set as appropriate:
  16906. <table border='1'>
  16907. <tr><th>Mask</th><th>Description</th></tr>
  16908. <tr><td>0x01</td><td>is16bitEncoded</td></tr>
  16909. <tr><td>0x04</td><td>hasExtendedData</td></tr>
  16910. <tr><td>0x08</td><td>isRichText</td></tr>
  16911. </table>
  16912. Notes:
  16913. <ul>
  16914. <li>The value of the 'is16bitEncoded' flag is determined by the actual character data
  16915. of <c>text</c></li>
  16916. <li>The string header fields are never separated (by a {@link ContinueRecord}) from the
  16917. first chunk of character data (i.e. the first character is always encoded in the same
  16918. record as the string header).</li>
  16919. </ul>
  16920. </member>
  16921. <member name="F:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.NOPOutput">
  16922. **
  16923. </member>
  16924. <member name="P:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.TotalSize">
  16925. @return total number of bytes written so far (including all BIFF headers)
  16926. </member>
  16927. <member name="P:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.AvailableSpace">
  16928. @return number of remaining bytes of space in current record
  16929. </member>
  16930. <member name="T:NPOI.Util.IDelayableLittleEndianOutput">
  16931. <summary>
  16932. Implementors of this interface allow client code to 'delay' writing to a certain section of a
  16933. data output stream.<br/>
  16934. A typical application is for writing BIFF records when the size is not known until well after
  16935. the header has been written. The client code can call <see cref="M:NPOI.Util.IDelayableLittleEndianOutput.CreateDelayedOutput"/>
  16936. to reserve two bytes of the output for the 'ushort size' header field. The delayed output can
  16937. be written at any stage.
  16938. </summary>
  16939. <remarks>@author Josh Micich</remarks>
  16940. </member>
  16941. <member name="M:NPOI.Util.IDelayableLittleEndianOutput.CreateDelayedOutput(System.Int32)">
  16942. <summary>
  16943. Creates an output stream intended for outputting a sequence of <c>size</c> bytes.
  16944. </summary>
  16945. <param name="size"></param>
  16946. <returns></returns>
  16947. </member>
  16948. <member name="T:NPOI.HSSF.Record.Cont.UnknownLengthRecordOutput">
  16949. Allows the writing of BIFF records when the 'ushort size' header field is not known in advance.
  16950. When the client is finished writing data, it calls {@link #terminate()}, at which point this
  16951. class updates the 'ushort size' with its value.
  16952. @author Josh Micich
  16953. </member>
  16954. <member name="F:NPOI.HSSF.Record.Cont.UnknownLengthRecordOutput._dataSizeOutput">
  16955. for writing the 'ushort size' field once its value is known
  16956. </member>
  16957. <member name="M:NPOI.HSSF.Record.Cont.UnknownLengthRecordOutput.Terminate">
  16958. Finishes writing the current record and updates 'ushort size' field.<br/>
  16959. After this method is called, only {@link #getTotalSize()} may be called.
  16960. </member>
  16961. <member name="P:NPOI.HSSF.Record.Cont.UnknownLengthRecordOutput.TotalSize">
  16962. includes 4 byte header
  16963. </member>
  16964. <member name="T:NPOI.HSSF.Record.CountryRecord">
  16965. Title: Country Record (aka WIN.INI country)
  16966. Description: used for localization. Currently HSSF always Sets this to 1
  16967. and it seems to work fine even in Germany. (es geht's auch fuer Deutschland)
  16968. REFERENCE: PG 298 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  16969. @author Andrew C. Oliver (acoliver at apache dot org)
  16970. @version 2.0-pre
  16971. </member>
  16972. <member name="M:NPOI.HSSF.Record.CountryRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16973. Constructs a CountryRecord and Sets its fields appropriately
  16974. @param in the RecordInputstream to Read the record from
  16975. </member>
  16976. <member name="P:NPOI.HSSF.Record.CountryRecord.DefaultCountry">
  16977. Gets the default country
  16978. @return country ID (1 = US)
  16979. </member>
  16980. <member name="P:NPOI.HSSF.Record.CountryRecord.CurrentCountry">
  16981. Gets the current country
  16982. @return country ID (1 = US)
  16983. </member>
  16984. <member name="T:NPOI.HSSF.Record.CRNCountRecord">
  16985. XCT ?CRN Count
  16986. REFERENCE: 5.114
  16987. @author Josh Micich
  16988. </member>
  16989. <member name="P:NPOI.HSSF.Record.CRNCountRecord.Sid">
  16990. return the non static version of the id for this record.
  16991. </member>
  16992. <member name="T:NPOI.HSSF.Record.CRNRecord">
  16993. Title: CRN
  16994. Description: This record stores the contents of an external cell or cell range
  16995. REFERENCE: 5.23
  16996. @author josh micich
  16997. </member>
  16998. <member name="P:NPOI.HSSF.Record.CRNRecord.Sid">
  16999. return the non static version of the id for this record.
  17000. </member>
  17001. <member name="T:NPOI.HSSF.Record.Crypto.Biff8DecryptingStream">
  17002. @author Josh Micich
  17003. </member>
  17004. <member name="M:NPOI.HSSF.Record.Crypto.Biff8DecryptingStream.ReadRecordSID">
  17005. Reads an unsigned short value without decrypting
  17006. </member>
  17007. <member name="M:NPOI.HSSF.Record.Crypto.Biff8DecryptingStream.ReadDataSize">
  17008. Reads an unsigned short value without decrypting
  17009. </member>
  17010. <member name="M:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey.Create(System.Byte[])">
  17011. Create using the default password and a specified docId
  17012. @param docId 16 bytes
  17013. </member>
  17014. <member name="M:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey.Validate(System.Byte[],System.Byte[])">
  17015. @return <c>true</c> if the keyDigest is compatible with the specified saltData and saltHash
  17016. </member>
  17017. <member name="M:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey.CreateRC4(System.Int32)">
  17018. The {@link RC4} instance needs to be Changed every 1024 bytes.
  17019. @param keyBlockNo used to seed the newly Created {@link RC4}
  17020. </member>
  17021. <member name="F:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey._userPasswordTLS">
  17022. Stores the BIFF8 encryption/decryption password for the current thread. This has been done
  17023. using a {@link ThreadLocal} in order to avoid further overloading the various public APIs
  17024. (e.g. {@link HSSFWorkbook}) that need this functionality.
  17025. </member>
  17026. <member name="P:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey.CurrentUserPassword">
  17027. @return the BIFF8 encryption/decryption password for the current thread.
  17028. <code>null</code> if it is currently unSet.
  17029. </member>
  17030. <member name="T:NPOI.HSSF.Record.Crypto.Biff8RC4">
  17031. Used for both encrypting and decrypting BIFF8 streams. The internal
  17032. {@link RC4} instance is renewed (re-keyed) every 1024 bytes.
  17033. @author Josh Micich
  17034. </member>
  17035. <member name="F:NPOI.HSSF.Record.Crypto.Biff8RC4._streamPos">
  17036. This field is used to keep track of when to change the {@link RC4}
  17037. instance. The change occurs every 1024 bytes. Every byte passed over is
  17038. counted.
  17039. </member>
  17040. <member name="M:NPOI.HSSF.Record.Crypto.Biff8RC4.IsNeverEncryptedRecord(System.Int32)">
  17041. TODO: Additionally, the lbPlyPos (position_of_BOF) field of the BoundSheet8 record MUST NOT be encrypted.
  17042. @return <c>true</c> if record type specified by <c>sid</c> is never encrypted
  17043. </member>
  17044. <member name="M:NPOI.HSSF.Record.Crypto.Biff8RC4.SkipTwoBytes">
  17045. Used when BIFF header fields (sid, size) are being Read. The internal
  17046. {@link RC4} instance must step even when unencrypted bytes are read
  17047. </member>
  17048. <member name="T:NPOI.HSSF.Record.Crypto.RC4">
  17049. Simple implementation of the alleged RC4 algorithm.
  17050. Inspired by <A HREF="http://en.wikipedia.org/wiki/RC4">wikipedia's RC4 article</A>
  17051. @author Josh Micich
  17052. </member>
  17053. <member name="M:NPOI.HSSF.Record.CustomField.FillField(NPOI.HSSF.Record.RecordInputStream)">
  17054. Populates this fields data from the byte array passed in1.
  17055. @param in the RecordInputstream to Read the record from
  17056. </member>
  17057. <member name="M:NPOI.HSSF.Record.CustomField.ToString(System.Text.StringBuilder)">
  17058. Appends the string representation of this field to the supplied
  17059. StringBuilder.
  17060. @param str The string buffer to Append to.
  17061. </member>
  17062. <member name="M:NPOI.HSSF.Record.CustomField.SerializeField(System.Int32,System.Byte[])">
  17063. Converts this field to it's byte array form.
  17064. @param offset The offset into the byte array to start writing to.
  17065. @param data The data array to Write to.
  17066. @return The number of bytes written.
  17067. </member>
  17068. <member name="P:NPOI.HSSF.Record.CustomField.Size">
  17069. @return The size of this field in bytes. This operation Is not valid
  17070. Until after the call to <c>FillField()</c>
  17071. </member>
  17072. <member name="T:NPOI.HSSF.Record.DateWindow1904Record">
  17073. Title: Date Window 1904 Flag record
  17074. Description: Flag specifying whether 1904 date windowing Is used.
  17075. (tick toc tick toc...BOOM!)
  17076. REFERENCE: PG 280 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  17077. @author Andrew C. Oliver (acoliver at apache dot org)
  17078. @version 2.0-pre
  17079. </member>
  17080. <member name="M:NPOI.HSSF.Record.DateWindow1904Record.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17081. Constructs a DateWindow1904 record and Sets its fields appropriately.
  17082. @param in the RecordInputstream to Read the record from
  17083. </member>
  17084. <member name="P:NPOI.HSSF.Record.DateWindow1904Record.Windowing">
  17085. Gets whether or not to use 1904 date windowing (which means you'll be screwed in 2004)
  17086. @return window flag - 0/1 (false,true)
  17087. </member>
  17088. <member name="T:NPOI.HSSF.Record.DBCellRecord">
  17089. Title: DBCell Record
  17090. Description: Used by Excel and other MS apps to quickly Find rows in the sheets.
  17091. REFERENCE: PG 299/440 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  17092. @author Andrew C. Oliver (acoliver at apache dot org)
  17093. @author Jason Height
  17094. @version 2.0-pre
  17095. </member>
  17096. <member name="M:NPOI.HSSF.Record.DBCellRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17097. Constructs a DBCellRecord and Sets its fields appropriately
  17098. @param in the RecordInputstream to Read the record from
  17099. </member>
  17100. <member name="M:NPOI.HSSF.Record.DBCellRecord.#ctor(System.Int32,System.Int16[])">
  17101. offset from the start of this DBCellRecord to the start of the first cell in
  17102. the next DBCell block.
  17103. </member>
  17104. <member name="M:NPOI.HSSF.Record.DBCellRecord.GetCellOffsetAt(System.Int32)">
  17105. return the cell offset in the array
  17106. @param index of the cell offset to retrieve
  17107. @return celloffset from the celloffset array
  17108. </member>
  17109. <member name="M:NPOI.HSSF.Record.DBCellRecord.CalculateSizeOfRecords(System.Int32,System.Int32)">
  17110. @returns the size of the Group of <c>DBCellRecord</c>s needed to encode
  17111. the specified number of blocks and rows
  17112. </member>
  17113. <member name="P:NPOI.HSSF.Record.DBCellRecord.RowOffset">
  17114. Gets offset from the start of this DBCellRecord to the start of the first cell in
  17115. the next DBCell block.
  17116. @return rowoffset to the start of the first cell in the next DBCell block
  17117. </member>
  17118. <member name="P:NPOI.HSSF.Record.DBCellRecord.NumCellOffsets">
  17119. Get the number of cell offsets in the celloffset array
  17120. @return number of cell offsets
  17121. </member>
  17122. <member name="T:NPOI.HSSF.Record.DefaultColWidthRecord">
  17123. Title: Default Column Width Record
  17124. Description: Specifies the default width for columns that have no specific
  17125. width Set.
  17126. REFERENCE: PG 302 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  17127. @author Andrew C. Oliver (acoliver at apache dot org)
  17128. @author Jason Height (jheight at chariot dot net dot au)
  17129. @version 2.0-pre
  17130. </member>
  17131. <member name="F:NPOI.HSSF.Record.DefaultColWidthRecord.DEFAULT_COLUMN_WIDTH">
  17132. The default column width is 8 characters
  17133. </member>
  17134. <member name="M:NPOI.HSSF.Record.DefaultColWidthRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17135. Constructs a DefaultColumnWidth record and Sets its fields appropriately.
  17136. @param in the RecordInputstream to Read the record from
  17137. </member>
  17138. <member name="P:NPOI.HSSF.Record.DefaultColWidthRecord.ColWidth">
  17139. Get the default column width
  17140. @return defaultwidth for columns
  17141. </member>
  17142. <member name="T:NPOI.HSSF.Record.DefaultRowHeightRecord">
  17143. Title: Default Row Height Record
  17144. Description: Row height for rows with Undefined or not explicitly defined
  17145. heights.
  17146. REFERENCE: PG 301 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  17147. @author Andrew C. Oliver (acoliver at apache dot org)
  17148. @author Jason Height (jheight at chariot dot net dot au)
  17149. @version 2.0-pre
  17150. </member>
  17151. <member name="F:NPOI.HSSF.Record.DefaultRowHeightRecord.DEFAULT_ROW_HEIGHT">
  17152. The default row height for empty rows is 255 twips (255 / 20 == 12.75 points)
  17153. </member>
  17154. <member name="M:NPOI.HSSF.Record.DefaultRowHeightRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17155. <summary>
  17156. Constructs a DefaultRowHeight record and Sets its fields appropriately.
  17157. </summary>
  17158. <param name="in1">the RecordInputstream to Read the record from</param>
  17159. </member>
  17160. <member name="P:NPOI.HSSF.Record.DefaultRowHeightRecord.RowHeight">
  17161. <summary>
  17162. Get the default row height
  17163. </summary>
  17164. </member>
  17165. <member name="T:NPOI.HSSF.Record.DeltaRecord">
  17166. Title: Delta Record
  17167. Description: controls the accuracy of the calculations
  17168. REFERENCE: PG 303 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  17169. @author Andrew C. Oliver (acoliver at apache dot org)
  17170. @author Jason Height (jheight at chariot dot net dot au)
  17171. @version 2.0-pre
  17172. </member>
  17173. <member name="M:NPOI.HSSF.Record.DeltaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17174. Constructs a Delta record and Sets its fields appropriately.
  17175. @param in the RecordInputstream to Read the record from
  17176. </member>
  17177. <member name="P:NPOI.HSSF.Record.DeltaRecord.MaxChange">
  17178. Get the maximum Change
  17179. @return maxChange - maximum rounding error
  17180. </member>
  17181. <member name="T:NPOI.HSSF.Record.DimensionsRecord">
  17182. Title: Dimensions Record
  17183. Description: provides the minumum and maximum bounds
  17184. of a sheet.
  17185. REFERENCE: PG 303 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  17186. @author Andrew C. Oliver (acoliver at apache dot org)
  17187. @author Jason Height (jheight at chariot dot net dot au)
  17188. @version 2.0-pre
  17189. </member>
  17190. <member name="M:NPOI.HSSF.Record.DimensionsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17191. Constructs a Dimensions record and Sets its fields appropriately.
  17192. @param in the RecordInputstream to Read the record from
  17193. </member>
  17194. <member name="P:NPOI.HSSF.Record.DimensionsRecord.FirstRow">
  17195. Get the first row number for the sheet
  17196. @return row - first row on the sheet
  17197. </member>
  17198. <member name="P:NPOI.HSSF.Record.DimensionsRecord.LastRow">
  17199. Get the last row number for the sheet
  17200. @return row - last row on the sheet
  17201. </member>
  17202. <member name="P:NPOI.HSSF.Record.DimensionsRecord.FirstCol">
  17203. Get the first column number for the sheet
  17204. @return column - first column on the sheet
  17205. </member>
  17206. <member name="P:NPOI.HSSF.Record.DimensionsRecord.LastCol">
  17207. Get the last col number for the sheet
  17208. @return column - last column on the sheet
  17209. </member>
  17210. <member name="M:NPOI.HSSF.Record.DrawingGroupRecord.ProcessChildRecords">
  17211. Process the bytes into escher records.
  17212. (Not done by default in case we break things,
  17213. Unless you Set the "poi.deSerialize.escher"
  17214. system property)
  17215. </member>
  17216. <member name="P:NPOI.HSSF.Record.DrawingGroupRecord.RecordSize">
  17217. Size of record (including 4 byte headers for all sections)
  17218. </member>
  17219. <member name="T:NPOI.HSSF.Record.DrawingRecord">
  17220. DrawingRecord (0x00EC)<p/>
  17221. </member>
  17222. <member name="M:NPOI.HSSF.Record.DrawingRecord.Clone">
  17223. Cloning of drawing records must be executed through HSSFPatriarch, because all id's must be changed
  17224. @return cloned drawing records
  17225. </member>
  17226. <member name="T:NPOI.HSSF.Record.DrawingRecordForBiffViewer">
  17227. This Is purely for the biff viewer. During normal operations we don't want
  17228. to be seeing this.
  17229. </member>
  17230. <member name="T:NPOI.HSSF.Record.DSFRecord">
  17231. Title: double Stream Flag Record
  17232. Description: tells if this Is a double stream file. (always no for HSSF generated files)
  17233. double Stream files contain both BIFF8 and BIFF7 workbooks.
  17234. REFERENCE: PG 305 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  17235. @author Andrew C. Oliver (acoliver at apache dot org)
  17236. @version 2.0-pre
  17237. </member>
  17238. <member name="M:NPOI.HSSF.Record.DSFRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17239. Constructs a DBCellRecord and Sets its fields appropriately.
  17240. @param in the RecordInputstream to Read the record from
  17241. </member>
  17242. <member name="T:NPOI.HSSF.Record.DVALRecord">
  17243. Title: DATAVALIDATIONS Record
  17244. Description: used in data validation ;
  17245. This record Is the list header of all data validation records (0x01BE) in the current sheet.
  17246. @author Dragos Buleandra (dragos.buleandra@trade2b.ro)
  17247. </member>
  17248. <member name="F:NPOI.HSSF.Record.DVALRecord.field_1_options">
  17249. Options of the DVAL
  17250. </member>
  17251. <member name="F:NPOI.HSSF.Record.DVALRecord.field_2_horiz_pos">
  17252. Horizontal position of the dialog
  17253. </member>
  17254. <member name="F:NPOI.HSSF.Record.DVALRecord.field_3_vert_pos">
  17255. Vertical position of the dialog
  17256. </member>
  17257. <member name="F:NPOI.HSSF.Record.DVALRecord.field_cbo_id">
  17258. Object ID of the drop down arrow object for list boxes ;
  17259. in our case this will be always FFFF , Until
  17260. MSODrawingGroup and MSODrawing records are implemented
  17261. </member>
  17262. <member name="F:NPOI.HSSF.Record.DVALRecord.field_5_dv_no">
  17263. Number of following DV Records
  17264. </member>
  17265. <member name="M:NPOI.HSSF.Record.DVALRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17266. Constructs a DVAL record and Sets its fields appropriately.
  17267. @param in the RecordInputstream to Read the record from
  17268. </member>
  17269. <member name="P:NPOI.HSSF.Record.DVALRecord.Options">
  17270. @return the field_1_options
  17271. </member>
  17272. <member name="P:NPOI.HSSF.Record.DVALRecord.HorizontalPos">
  17273. @return the Horizontal position of the dialog
  17274. </member>
  17275. <member name="P:NPOI.HSSF.Record.DVALRecord.VerticalPos">
  17276. @return the the Vertical position of the dialog
  17277. </member>
  17278. <member name="P:NPOI.HSSF.Record.DVALRecord.ObjectID">
  17279. Get Object ID of the drop down arrow object for list boxes
  17280. </member>
  17281. <member name="P:NPOI.HSSF.Record.DVALRecord.DVRecNo">
  17282. Get number of following DV records
  17283. </member>
  17284. <member name="T:NPOI.HSSF.Record.DVRecord">
  17285. Title: DATAVALIDATION Record (0x01BE)<p/>
  17286. Description: This record stores data validation Settings and a list of cell ranges
  17287. which contain these Settings. The data validation Settings of a sheet
  17288. are stored in a sequential list of DV records. This list Is followed by
  17289. DVAL record(s)
  17290. @author Dragos Buleandra (dragos.buleandra@trade2b.ro)
  17291. @version 2.0-pre
  17292. </member>
  17293. <member name="F:NPOI.HSSF.Record.DVRecord._option_flags">
  17294. Option flags
  17295. </member>
  17296. <member name="F:NPOI.HSSF.Record.DVRecord._promptTitle">
  17297. Title of the prompt box
  17298. </member>
  17299. <member name="F:NPOI.HSSF.Record.DVRecord._errorTitle">
  17300. Title of the error box
  17301. </member>
  17302. <member name="F:NPOI.HSSF.Record.DVRecord._promptText">
  17303. Text of the prompt box
  17304. </member>
  17305. <member name="F:NPOI.HSSF.Record.DVRecord._errorText">
  17306. Text of the error box
  17307. </member>
  17308. <member name="F:NPOI.HSSF.Record.DVRecord._not_used_1">
  17309. Not used - Excel seems to always write 0x3FE0
  17310. </member>
  17311. <member name="F:NPOI.HSSF.Record.DVRecord._formula1">
  17312. Formula data for first condition (RPN token array without size field)
  17313. </member>
  17314. <member name="F:NPOI.HSSF.Record.DVRecord._not_used_2">
  17315. Not used - Excel seems to always write 0x0000
  17316. </member>
  17317. <member name="F:NPOI.HSSF.Record.DVRecord._formula2">
  17318. Formula data for second condition (RPN token array without size field)
  17319. </member>
  17320. <member name="F:NPOI.HSSF.Record.DVRecord._regions">
  17321. Cell range address list with all affected ranges
  17322. </member>
  17323. <member name="F:NPOI.HSSF.Record.DVRecord.opt_data_type">
  17324. Option flags field
  17325. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  17326. </member>
  17327. <member name="M:NPOI.HSSF.Record.DVRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17328. Constructs a DV record and Sets its fields appropriately.
  17329. @param in the RecordInputstream to Read the record from
  17330. </member>
  17331. <member name="M:NPOI.HSSF.Record.DVRecord.ResolveTitleText(System.String)">
  17332. When entered via the UI, Excel translates empty string into "\0"
  17333. While it is possible to encode the title/text as empty string (Excel doesn't exactly crash),
  17334. the resulting tool-tip text / message box looks wrong. It is best to do the same as the
  17335. Excel UI and encode 'not present' as "\0".
  17336. </member>
  17337. <member name="M:NPOI.HSSF.Record.DVRecord.Clone">
  17338. Clones the object. Uses serialisation, as the
  17339. contents are somewhat complex
  17340. </member>
  17341. <member name="P:NPOI.HSSF.Record.DVRecord.DataType">
  17342. Get the condition data type
  17343. @return the condition data type
  17344. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  17345. </member>
  17346. <member name="P:NPOI.HSSF.Record.DVRecord.ErrorStyle">
  17347. Get the condition error style
  17348. @return the condition error style
  17349. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  17350. </member>
  17351. <member name="P:NPOI.HSSF.Record.DVRecord.ListExplicitFormula">
  17352. return true if in list validations the string list Is explicitly given in the formula, false otherwise
  17353. @return true if in list validations the string list Is explicitly given in the formula, false otherwise
  17354. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  17355. </member>
  17356. <member name="P:NPOI.HSSF.Record.DVRecord.EmptyCellAllowed">
  17357. return true if empty values are allowed in cells, false otherwise
  17358. @return if empty values are allowed in cells, false otherwise
  17359. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  17360. </member>
  17361. <member name="P:NPOI.HSSF.Record.DVRecord.SuppressDropdownArrow">
  17362. @return <code>true</code> if drop down arrow should be suppressed when list validation is
  17363. used, <code>false</code> otherwise
  17364. </member>
  17365. <member name="P:NPOI.HSSF.Record.DVRecord.ShowPromptOnCellSelected">
  17366. return true if a prompt window should appear when cell Is selected, false otherwise
  17367. @return if a prompt window should appear when cell Is selected, false otherwise
  17368. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  17369. </member>
  17370. <member name="P:NPOI.HSSF.Record.DVRecord.ShowErrorOnInvalidValue">
  17371. return true if an error window should appear when an invalid value Is entered in the cell, false otherwise
  17372. @return if an error window should appear when an invalid value Is entered in the cell, false otherwise
  17373. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  17374. </member>
  17375. <member name="P:NPOI.HSSF.Record.DVRecord.ConditionOperator">
  17376. Get the condition operator
  17377. @return the condition operator
  17378. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  17379. </member>
  17380. <member name="P:NPOI.HSSF.Record.DVRecord.OptionFlags">
  17381. Gets the option flags field.
  17382. @return options - the option flags field
  17383. </member>
  17384. <member name="T:NPOI.HSSF.Record.EOFRecord">
  17385. End Of File record.
  17386. Description: Marks the end of records belonging to a particular object in the
  17387. HSSF File
  17388. REFERENCE: PG 307 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  17389. @author Andrew C. Oliver (acoliver at apache dot org)
  17390. @author Jason Height (jheight at chariot dot net dot au)
  17391. @version 2.0-pre
  17392. </member>
  17393. <member name="M:NPOI.HSSF.Record.EOFRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17394. Constructs a EOFRecord record and Sets its fields appropriately.
  17395. @param in the RecordInputstream to Read the record from
  17396. </member>
  17397. <member name="T:NPOI.HSSF.Record.EscherAggregate">
  17398. This class Is used to aggregate the MSODRAWING and OBJ record
  17399. combinations. This Is necessary due to the bizare way in which
  17400. these records are Serialized. What happens Is that you Get a
  17401. combination of MSODRAWING -> OBJ -> MSODRAWING -> OBJ records
  17402. but the escher records are Serialized _across_ the MSODRAWING
  17403. records.
  17404. It Gets even worse when you start looking at TXO records.
  17405. So what we do with this class Is aggregate lazily. That Is
  17406. we don't aggregate the MSODRAWING -> OBJ records Unless we
  17407. need to modify them.
  17408. At first document contains 4 types of records which belong to drawing layer.
  17409. There are can be such sequence of record:
  17410. <p/>
  17411. DrawingRecord
  17412. ContinueRecord
  17413. ...
  17414. ContinueRecord
  17415. ObjRecord | TextObjectRecord
  17416. .....
  17417. ContinueRecord
  17418. ...
  17419. ContinueRecord
  17420. ObjRecord | TextObjectRecord
  17421. NoteRecord
  17422. ...
  17423. NoteRecord
  17424. <p/>
  17425. To work with shapes we have to read data from Drawing and Continue records into single array of bytes and
  17426. build escher(office art) records tree from this array.
  17427. Each shape in drawing layer matches corresponding ObjRecord
  17428. Each textbox matches corresponding TextObjectRecord
  17429. <p/>
  17430. ObjRecord contains information about shape. Thus each ObjRecord corresponds EscherContainerRecord(SPGR)
  17431. <p/>
  17432. EscherAggrefate contains also NoteRecords
  17433. NoteRecords must be serial
  17434. @author Glen Stampoultzis (glens at apache.org)
  17435. </member>
  17436. <member name="F:NPOI.HSSF.Record.EscherAggregate.shapeToObj">
  17437. Maps shape container objects to their OBJ records
  17438. </member>
  17439. <member name="F:NPOI.HSSF.Record.EscherAggregate.tailRec">
  17440. list of "tail" records that need to be Serialized after all drawing Group records
  17441. </member>
  17442. <member name="M:NPOI.HSSF.Record.EscherAggregate.ToString">
  17443. Calculates the string representation of this record. This Is
  17444. simply a dump of all the records.
  17445. </member>
  17446. <member name="M:NPOI.HSSF.Record.EscherAggregate.ToXml(System.String)">
  17447. Calculates the xml representation of this record. This is
  17448. simply a dump of all the records.
  17449. @param tab - string which must be added before each line (used by default '\t')
  17450. @return xml representation of the all aggregated records
  17451. </member>
  17452. <member name="M:NPOI.HSSF.Record.EscherAggregate.IsDrawingLayerRecord(System.Int16)">
  17453. @param sid - record sid we want to check if it belongs to drawing layer
  17454. @return true if record is instance of DrawingRecord or ContinueRecord or ObjRecord or TextObjRecord
  17455. </member>
  17456. <member name="M:NPOI.HSSF.Record.EscherAggregate.CreateAggregate(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase},System.Int32)">
  17457. Collapses the drawing records into an aggregate.
  17458. read Drawing, Obj, TxtObj, Note and Continue records into single byte array,
  17459. create Escher tree from byte array, create map &lt;EscherRecord, Record&gt;
  17460. @param records - list of all records inside sheet
  17461. @param locFirstDrawingRecord - location of the first DrawingRecord inside sheet
  17462. @return new EscherAggregate create from all aggregated records which belong to drawing layer
  17463. </member>
  17464. <member name="M:NPOI.HSSF.Record.EscherAggregate.Serialize(System.Int32,System.Byte[])">
  17465. Serializes this aggregate to a byte array. Since this Is an aggregate
  17466. record it will effectively Serialize the aggregated records.
  17467. @param offset The offset into the start of the array.
  17468. @param data The byte array to Serialize to.
  17469. @return The number of bytes Serialized.
  17470. </member>
  17471. <member name="M:NPOI.HSSF.Record.EscherAggregate.WriteDataIntoDrawingRecord(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
  17472. @param drawingData - escher records saved into single byte array
  17473. @param writtenEscherBytes - count of bytes already saved into drawing records (we should know it to decide create
  17474. drawing or continue record)
  17475. @param pos current position of data array
  17476. @param data - array of bytes where drawing records must be serialized
  17477. @param i - number of shape, saved into data array
  17478. @return offset of data array after serialization
  17479. </member>
  17480. <member name="M:NPOI.HSSF.Record.EscherAggregate.GetEscherRecordSize(System.Collections.Generic.List{NPOI.DDF.EscherRecord})">
  17481. How many bytes do the raw escher records contain.
  17482. @param records List of escher records
  17483. @return the number of bytes
  17484. </member>
  17485. <member name="M:NPOI.HSSF.Record.EscherAggregate.GetSid(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase},System.Int32)">
  17486. @param records list of records to look into
  17487. @param loc - location of the record which sid must be returned
  17488. @return sid of the record with selected location
  17489. </member>
  17490. <member name="M:NPOI.HSSF.Record.EscherAggregate.BuildBaseTree">
  17491. create base tree with such structure:
  17492. EscherDgContainer
  17493. -EscherSpgrContainer
  17494. --EscherSpContainer
  17495. ---EscherSpRecord
  17496. ---EscherSpgrRecord
  17497. ---EscherSpRecord
  17498. -EscherDgRecord
  17499. id of DgRecord and SpRecord are empty and must be set later by HSSFPatriarch
  17500. </member>
  17501. <member name="M:NPOI.HSSF.Record.EscherAggregate.Children(System.Byte[],System.Int16,System.Int32)">
  17502. Unused since this Is an aggregate record. Use CreateAggregate().
  17503. @see #CreateAggregate
  17504. </member>
  17505. <member name="M:NPOI.HSSF.Record.EscherAggregate.GetEscherChild(NPOI.DDF.EscherContainerRecord,System.Int32)">
  17506. Converts the Records into UserModel
  17507. objects on the bound HSSFPatriarch
  17508. </member>
  17509. <member name="M:NPOI.HSSF.Record.EscherAggregate.AssociateShapeToObjRecord(NPOI.DDF.EscherRecord,NPOI.HSSF.Record.Record)">
  17510. <summary>
  17511. Associates an escher record to an OBJ record or a TXO record.
  17512. </summary>
  17513. <param name="r">ClientData or Textbox record</param>
  17514. <param name="objRecord">Obj or TextObj record</param>
  17515. </member>
  17516. <member name="M:NPOI.HSSF.Record.EscherAggregate.RemoveShapeToObjRecord(NPOI.DDF.EscherRecord)">
  17517. <summary>
  17518. Remove echerRecord and associated to it Obj or TextObj record
  17519. </summary>
  17520. <param name="rec">clientData or textbox record to be removed</param>
  17521. </member>
  17522. <member name="M:NPOI.HSSF.Record.EscherAggregate.GetNoteRecordByObj(NPOI.HSSF.Record.ObjRecord)">
  17523. @param obj - ObjRecord with id == NoteRecord.id
  17524. @return null if note record is not found else returns note record with id == obj.id
  17525. </member>
  17526. <member name="P:NPOI.HSSF.Record.EscherAggregate.Sid">
  17527. @return Returns the current sid.
  17528. </member>
  17529. <member name="P:NPOI.HSSF.Record.EscherAggregate.RecordSize">
  17530. @return record size, including header size of obj, text, note, drawing, continue records
  17531. </member>
  17532. <member name="P:NPOI.HSSF.Record.EscherAggregate.TailRecords">
  17533. @return unmodifiable copy of tail records. We need to access them when building shapes.
  17534. Every HSSFComment shape has a link to a NoteRecord from the tailRec collection.
  17535. </member>
  17536. <member name="T:NPOI.HSSF.Record.ExtendedFormatRecord">
  17537. Title: Extended Format Record
  17538. Description: Probably one of the more complex records. There are two breeds:
  17539. Style and Cell.
  17540. It should be noted that fields in the extended format record are
  17541. somewhat arbitrary. Almost all of the fields are bit-level, but
  17542. we name them as best as possible by functional Group. In some
  17543. places this Is better than others.
  17544. REFERENCE: PG 426 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  17545. @author Andrew C. Oliver (acoliver at apache dot org)
  17546. @version 2.0-pre
  17547. </member>
  17548. <member name="M:NPOI.HSSF.Record.ExtendedFormatRecord.#ctor">
  17549. Constructor ExtendedFormatRecord
  17550. </member>
  17551. <member name="M:NPOI.HSSF.Record.ExtendedFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17552. Constructs an ExtendedFormat record and Sets its fields appropriately.
  17553. @param in the RecordInputstream to Read the record from
  17554. </member>
  17555. <member name="M:NPOI.HSSF.Record.ExtendedFormatRecord.CloneStyleFrom(NPOI.HSSF.Record.ExtendedFormatRecord)">
  17556. Clones all the style information from another
  17557. ExtendedFormatRecord, onto this one. This
  17558. will then hold all the same style options.
  17559. If The source ExtendedFormatRecord comes from
  17560. a different Workbook, you will need to sort
  17561. out the font and format indicies yourself!
  17562. </member>
  17563. <member name="M:NPOI.HSSF.Record.ExtendedFormatRecord.Equals(System.Object)">
  17564. Will consider two different records with the same
  17565. contents as Equals, as the various indexes
  17566. that matter are embedded in the records
  17567. </member>
  17568. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FontIndex">
  17569. <summary>
  17570. Get the index to the FONT record (which font to use 0 based)
  17571. </summary>
  17572. </member>
  17573. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FormatIndex">
  17574. <summary>
  17575. Get the index to the Format record (which FORMAT to use 0-based)
  17576. </summary>
  17577. </member>
  17578. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.CellOptions">
  17579. <summary>
  17580. Gets the options bitmask - you can also use corresponding option bit Getters
  17581. (see other methods that reference this one)
  17582. </summary>
  17583. </member>
  17584. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsLocked">
  17585. <summary>
  17586. Get whether the cell Is locked or not
  17587. </summary>
  17588. </member>
  17589. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsHidden">
  17590. <summary>
  17591. Get whether the cell Is hidden or not
  17592. </summary>
  17593. </member>
  17594. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.XFType">
  17595. <summary>
  17596. Get whether the cell Is a cell or style XFRecord
  17597. </summary>
  17598. </member>
  17599. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord._123Prefix">
  17600. <summary>
  17601. Get some old holdover from lotus 123. Who cares, its all over for Lotus.
  17602. RIP Lotus.
  17603. </summary>
  17604. </member>
  17605. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.ParentIndex">
  17606. <summary>
  17607. for cell XF types this Is the parent style (usually 0/normal). For
  17608. style this should be NULL.
  17609. </summary>
  17610. </member>
  17611. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AlignmentOptions">
  17612. <summary>
  17613. Get the alignment options bitmask. See corresponding bitGetter methods
  17614. that reference this one.
  17615. </summary>
  17616. </member>
  17617. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.Alignment">
  17618. <summary>
  17619. Get the horizontal alignment of the cell.
  17620. </summary>
  17621. </member>
  17622. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.WrapText">
  17623. <summary>
  17624. Get whether to wrap the text in the cell
  17625. </summary>
  17626. </member>
  17627. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.VerticalAlignment">
  17628. <summary>
  17629. Get the vertical alignment of text in the cell
  17630. </summary>
  17631. </member>
  17632. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.JustifyLast">
  17633. <summary>
  17634. Docs just say this Is for far east versions.. (I'm guessing it
  17635. justifies for right-to-left Read languages)
  17636. </summary>
  17637. </member>
  17638. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.Rotation">
  17639. <summary>
  17640. Get the degree of rotation. (I've not actually seen this used anywhere)
  17641. </summary>
  17642. </member>
  17643. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IndentionOptions">
  17644. <summary>
  17645. Get the indent options bitmask (see corresponding bit Getters that reference
  17646. this field)
  17647. </summary>
  17648. </member>
  17649. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.Indent">
  17650. <summary>
  17651. Get indention (not sure of the Units, think its spaces)
  17652. </summary>
  17653. </member>
  17654. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.ShrinkToFit">
  17655. <summary>
  17656. Get whether to shrink the text to fit
  17657. </summary>
  17658. </member>
  17659. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.MergeCells">
  17660. <summary>
  17661. Get whether to merge cells
  17662. </summary>
  17663. </member>
  17664. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.ReadingOrder">
  17665. <summary>
  17666. Get the Reading order for far east versions (0 - Context, 1 - Left to right,
  17667. 2 - right to left) - We could use some help with support for the far east.
  17668. </summary>
  17669. </member>
  17670. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentFormat">
  17671. <summary>
  17672. Get whether or not to use the format in this XF instead of the parent XF.
  17673. </summary>
  17674. </member>
  17675. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentFont">
  17676. <summary>
  17677. Get whether or not to use the font in this XF instead of the parent XF.
  17678. </summary>
  17679. </member>
  17680. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentAlignment">
  17681. <summary>
  17682. Get whether or not to use the alignment in this XF instead of the parent XF.
  17683. </summary>
  17684. </member>
  17685. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentBorder">
  17686. <summary>
  17687. Get whether or not to use the border in this XF instead of the parent XF.
  17688. </summary>
  17689. </member>
  17690. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentPattern">
  17691. <summary>
  17692. Get whether or not to use the pattern in this XF instead of the parent XF.
  17693. (foregrount/background)
  17694. </summary>
  17695. </member>
  17696. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentCellOptions">
  17697. <summary>
  17698. Get whether or not to use the locking/hidden in this XF instead of the parent XF.
  17699. </summary>
  17700. </member>
  17701. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderOptions">
  17702. <summary>
  17703. Get the border options bitmask (see the corresponding bit Getter methods
  17704. that reference back to this one)
  17705. </summary>
  17706. </member>
  17707. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderLeft">
  17708. <summary>
  17709. Get the borderline style for the left border
  17710. </summary>
  17711. </member>
  17712. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderRight">
  17713. <summary>
  17714. Get the borderline style for the right border
  17715. </summary>
  17716. </member>
  17717. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderTop">
  17718. <summary>
  17719. Get the borderline style for the top border
  17720. </summary>
  17721. </member>
  17722. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderBottom">
  17723. <summary>
  17724. Get the borderline style for the bottom border
  17725. </summary>
  17726. </member>
  17727. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.PaletteOptions">
  17728. <summary>
  17729. Get the palette options bitmask (see the individual bit Getter methods that
  17730. reference this one)
  17731. </summary>
  17732. </member>
  17733. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.LeftBorderPaletteIdx">
  17734. <summary>
  17735. Get the palette index for the left border color
  17736. </summary>
  17737. </member>
  17738. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.RightBorderPaletteIdx">
  17739. <summary>
  17740. Get the palette index for the right border color
  17741. </summary>
  17742. </member>
  17743. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AdtlPaletteOptions">
  17744. <summary>
  17745. Get the Additional palette options bitmask (see individual bit Getter methods
  17746. that reference this method)
  17747. </summary>
  17748. </member>
  17749. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.TopBorderPaletteIdx">
  17750. <summary>
  17751. Get the palette index for the top border
  17752. </summary>
  17753. </member>
  17754. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BottomBorderPaletteIdx">
  17755. <summary>
  17756. Get the palette index for the bottom border
  17757. </summary>
  17758. </member>
  17759. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AdtlDiagBorderPaletteIdx">
  17760. <summary>
  17761. Get for diagonal borders
  17762. </summary>
  17763. </member>
  17764. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AdtlDiagLineStyle">
  17765. <summary>
  17766. Get the diagonal border line style
  17767. </summary>
  17768. </member>
  17769. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.Diagonal">
  17770. <summary>
  17771. Not sure what this Is for (maybe Fill lines?) 1 = down, 2 = up, 3 = both, 0 for none..
  17772. </summary>
  17773. </member>
  17774. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AdtlFillPattern">
  17775. <summary>
  17776. Get the Additional Fill pattern
  17777. </summary>
  17778. </member>
  17779. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FillPaletteOptions">
  17780. <summary>
  17781. Get the Fill palette options bitmask (see indivdual bit Getters that
  17782. reference this method)
  17783. </summary>
  17784. </member>
  17785. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FillForeground">
  17786. <summary>
  17787. Get the foreground palette color index
  17788. </summary>
  17789. </member>
  17790. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FillBackground">
  17791. <summary>
  17792. Get the background palette color index
  17793. </summary>
  17794. </member>
  17795. <member name="T:NPOI.HSSF.Record.ExternalNameRecord">
  17796. EXTERNALNAME<p/>
  17797. @author Josh Micich
  17798. </member>
  17799. <member name="F:NPOI.HSSF.Record.ExternalNameRecord._ddeValues">
  17800. 'rgoper' / 'Last received results of the DDE link'
  17801. (seems to be only applicable to DDE links)<br/>
  17802. Logically this is a 2-D array, which has been flattened into 1-D array here.
  17803. </member>
  17804. <member name="F:NPOI.HSSF.Record.ExternalNameRecord._nColumns">
  17805. (logical) number of columns in the {@link #_ddeValues} array
  17806. </member>
  17807. <member name="F:NPOI.HSSF.Record.ExternalNameRecord._nRows">
  17808. (logical) number of rows in the {@link #_ddeValues} array
  17809. </member>
  17810. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.IsBuiltInName">
  17811. Convenience Function to determine if the name Is a built-in name
  17812. </member>
  17813. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.IsAutomaticLink">
  17814. For OLE and DDE, links can be either 'automatic' or 'manual'
  17815. </member>
  17816. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.IsPicureLink">
  17817. only for OLE and DDE
  17818. </member>
  17819. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.IsStdDocumentNameIdentifier">
  17820. DDE links only. If <c>true</c>, this denotes the 'StdDocumentName'
  17821. </member>
  17822. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.Text">
  17823. @return the standard String representation of this name
  17824. </member>
  17825. <member name="F:NPOI.HSSF.Record.RefSubRecord._extBookIndex">
  17826. index to External Book Block (which starts with a EXTERNALBOOK record)
  17827. </member>
  17828. <member name="M:NPOI.HSSF.Record.RefSubRecord.#ctor(System.Int32,System.Int32,System.Int32)">
  17829. a Constructor for making new sub record
  17830. </member>
  17831. <member name="M:NPOI.HSSF.Record.RefSubRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17832. @param in the RecordInputstream to Read the record from
  17833. </member>
  17834. <member name="M:NPOI.HSSF.Record.RefSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  17835. called by the class that is responsible for writing this sucker.
  17836. Subclasses should implement this so that their data is passed back in a
  17837. byte array.
  17838. @param offset to begin writing at
  17839. @param data byte array containing instance data
  17840. @return number of bytes written
  17841. </member>
  17842. <member name="T:NPOI.HSSF.Record.ExternSheetRecord">
  17843. Title: Extern Sheet
  17844. Description: A List of Inndexes to SupBook
  17845. REFERENCE:
  17846. @author Libin Roman (Vista Portal LDT. Developer)
  17847. @version 1.0-pre
  17848. </member>
  17849. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17850. Constructs a Extern Sheet record and Sets its fields appropriately.
  17851. @param in the RecordInputstream to Read the record from
  17852. </member>
  17853. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.AddRef(System.Int32,System.Int32,System.Int32)">
  17854. Add a zero-based reference to a {@link org.apache.poi.hssf.record.SupBookRecord}.
  17855. <p>
  17856. If the type of the SupBook record is same-sheet referencing, Add-In referencing,
  17857. DDE data source referencing, or OLE data source referencing,
  17858. then no scope is specified and this value <em>MUST</em> be -2. Otherwise,
  17859. the scope must be set as follows:
  17860. <ol>
  17861. <li><code>-2</code> Workbook-level reference that applies to the entire workbook.</li>
  17862. <li><code>-1</code> Sheet-level reference. </li>
  17863. <li><code>&gt;=0</code> Sheet-level reference. This specifies the first sheet in the reference.
  17864. <p>
  17865. If the SupBook type is unused or external workbook referencing,
  17866. then this value specifies the zero-based index of an external sheet name,
  17867. see {@link org.apache.poi.hssf.record.SupBookRecord#getSheetNames()}.
  17868. This referenced string specifies the name of the first sheet within the external workbook that is in scope.
  17869. This sheet MUST be a worksheet or macro sheet.
  17870. </p>
  17871. <p>
  17872. If the supporting link type is self-referencing, then this value specifies the zero-based index of a
  17873. {@link org.apache.poi.hssf.record.BoundSheetRecord} record in the workbook stream that specifies
  17874. the first sheet within the scope of this reference. This sheet MUST be a worksheet or a macro sheet.
  17875. </p>
  17876. </li>
  17877. </ol></p>
  17878. @param firstSheetIndex the scope, must be -2 for add-in references
  17879. @param lastSheetIndex the scope, must be -2 for add-in references
  17880. @return index of newly added ref
  17881. </member>
  17882. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.AddREFRecord(NPOI.HSSF.Record.RefSubRecord)">
  17883. Adds REF struct (ExternSheetSubRecord)
  17884. @param rec REF struct
  17885. </member>
  17886. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.GetExtbookIndexFromRefIndex(System.Int32)">
  17887. Returns the index of the SupBookRecord for this index
  17888. </member>
  17889. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.FindRefIndexFromExtBookIndex(System.Int32)">
  17890. @return -1 if not found
  17891. </member>
  17892. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.GetFirstSheetIndexFromRefIndex(System.Int32)">
  17893. Returns the first sheet that the reference applies to, or
  17894. -1 if the referenced sheet can't be found, or -2 if the
  17895. reference is workbook scoped.
  17896. </member>
  17897. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.GetLastSheetIndexFromRefIndex(System.Int32)">
  17898. Returns the last sheet that the reference applies to, or
  17899. -1 if the referenced sheet can't be found, or -2 if the
  17900. reference is workbook scoped.
  17901. For a single sheet reference, the first and last should be
  17902. the same.
  17903. </member>
  17904. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  17905. called by the class that Is responsible for writing this sucker.
  17906. Subclasses should implement this so that their data Is passed back in a
  17907. byte array.
  17908. @param offset to begin writing at
  17909. @param data byte array containing instance data
  17910. @return number of bytes written
  17911. </member>
  17912. <member name="P:NPOI.HSSF.Record.ExternSheetRecord.NumOfREFRecords">
  17913. returns the number of REF Records, which is in model
  17914. @return number of REF records
  17915. </member>
  17916. <member name="P:NPOI.HSSF.Record.ExternSheetRecord.NumOfRefs">
  17917. @return number of REF structures
  17918. </member>
  17919. <member name="P:NPOI.HSSF.Record.ExternSheetRecord.Sid">
  17920. return the non static version of the id for this record.
  17921. </member>
  17922. <member name="T:NPOI.HSSF.Record.ExternSheetSubRecord">
  17923. Title: A sub Record for Extern Sheet
  17924. Description: Defines a named range within a workbook.
  17925. REFERENCE:
  17926. @author Libin Roman (Vista Portal LDT. Developer)
  17927. @version 1.0-pre
  17928. </member>
  17929. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.#ctor">
  17930. a Constractor for making new sub record
  17931. </member>
  17932. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17933. Constructs a Extern Sheet Sub Record record and Sets its fields appropriately.
  17934. @param in the RecordInputstream to Read the record from
  17935. </member>
  17936. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.SetIndexToSupBook(System.Int16)">
  17937. Sets the Index to the sup book
  17938. @param index sup book index
  17939. </member>
  17940. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.GetIndexToSupBook">
  17941. Gets the index to sup book
  17942. @return sup book index
  17943. </member>
  17944. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.SetIndexToFirstSupBook(System.Int16)">
  17945. Sets the index to first sheet in supbook
  17946. @param index index to first sheet
  17947. </member>
  17948. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.GetIndexToFirstSupBook">
  17949. Gets the index to first sheet from supbook
  17950. @return index to first supbook
  17951. </member>
  17952. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.SetIndexToLastSupBook(System.Int16)">
  17953. Sets the index to last sheet in supbook
  17954. @param index index to last sheet
  17955. </member>
  17956. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.GetIndexToLastSupBook">
  17957. Gets the index to last sheet in supbook
  17958. @return index to last supbook
  17959. </member>
  17960. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.Serialize(System.Int32,System.Byte[])">
  17961. called by the class that Is responsible for writing this sucker.
  17962. Subclasses should implement this so that their data Is passed back in a
  17963. byte array.
  17964. @param offset to begin writing at
  17965. @param data byte array containing instance data
  17966. @return number of bytes written
  17967. </member>
  17968. <member name="P:NPOI.HSSF.Record.ExternSheetSubRecord.RecordSize">
  17969. returns the record size
  17970. </member>
  17971. <member name="P:NPOI.HSSF.Record.ExternSheetSubRecord.Sid">
  17972. return the non static version of the id for this record.
  17973. </member>
  17974. <member name="T:NPOI.HSSF.Record.InfoSubRecord">
  17975. Extended SST table info subrecord
  17976. Contains the elements of "info" in the SST's array field
  17977. @author Andrew C. Oliver (acoliver at apache dot org)
  17978. @version 2.0-pre
  17979. @see org.apache.poi.hssf.record.ExtSSTRecord
  17980. </member>
  17981. <member name="M:NPOI.HSSF.Record.InfoSubRecord.#ctor(System.Int32,System.Int32)">
  17982. Creates new ExtSSTInfoSubRecord
  17983. </member>
  17984. <member name="T:NPOI.HSSF.Record.ExtSSTRecord">
  17985. Title: Extended Static String Table
  17986. Description: This record Is used for a quick Lookup into the SST record. This
  17987. record breaks the SST table into a Set of buckets. The offsets
  17988. to these buckets within the SST record are kept as well as the
  17989. position relative to the start of the SST record.
  17990. REFERENCE: PG 313 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  17991. @author Andrew C. Oliver (acoliver at apache dot org)
  17992. @author Jason Height (jheight at apache dot org)
  17993. @version 2.0-pre
  17994. @see org.apache.poi.hssf.record.ExtSSTInfoSubRecord
  17995. </member>
  17996. <member name="M:NPOI.HSSF.Record.ExtSSTRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17997. Constructs a EOFRecord record and Sets its fields appropriately.
  17998. @param in the RecordInputstream to Read the record from
  17999. </member>
  18000. <member name="M:NPOI.HSSF.Record.ExtSSTRecord.GetRecordSizeForStrings(System.Int32)">
  18001. Given a number of strings (in the sst), returns the size of the extsst record
  18002. </member>
  18003. <member name="P:NPOI.HSSF.Record.ExtSSTRecord.DataSize">
  18004. Returns the size of this record
  18005. </member>
  18006. <member name="T:NPOI.HSSF.Record.FilePassRecord">
  18007. Title: File Pass Record
  18008. Description: Indicates that the record after this record are encrypted. HSSF does not support encrypted excel workbooks
  18009. and the presence of this record will cause Processing to be aborted.
  18010. REFERENCE: PG 420 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18011. @author Jason Height (jheight at chariot dot net dot au)
  18012. @version 3.0-pre
  18013. </member>
  18014. <member name="T:NPOI.HSSF.Record.FileSharingRecord">
  18015. Title: FILESHARING
  18016. Description: stores the encrypted Readonly for a workbook (Write protect)
  18017. This functionality Is accessed from the options dialog box available when performing 'Save As'.<p/>
  18018. REFERENCE: PG 314 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<p/>
  18019. @author Andrew C. Oliver (acoliver at apache dot org)
  18020. </member>
  18021. <member name="M:NPOI.HSSF.Record.FileSharingRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18022. Constructs a FileSharing record and Sets its fields appropriately.
  18023. @param in the RecordInputstream to Read the record from
  18024. </member>
  18025. <member name="M:NPOI.HSSF.Record.FileSharingRecord.Clone">
  18026. Clone this record.
  18027. </member>
  18028. <member name="P:NPOI.HSSF.Record.FileSharingRecord.ReadOnly">
  18029. Get the Readonly
  18030. @return short representing if this Is Read only (1 = true)
  18031. </member>
  18032. <member name="P:NPOI.HSSF.Record.FileSharingRecord.Password">
  18033. @returns password hashed with hashPassword() (very lame)
  18034. </member>
  18035. <member name="P:NPOI.HSSF.Record.FileSharingRecord.Username">
  18036. @returns username of the user that Created the file
  18037. </member>
  18038. <member name="T:NPOI.HSSF.Record.FnGroupCountRecord">
  18039. Title: Function Group Count Record
  18040. Description: Number of built in function Groups in the current version of the
  18041. SpReadsheet (probably only used on Windoze)
  18042. REFERENCE: PG 315 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18043. @author Andrew C. Oliver (acoliver at apache dot org)
  18044. @version 2.0-pre
  18045. </member>
  18046. <member name="F:NPOI.HSSF.Record.FnGroupCountRecord.COUNT">
  18047. suggested default (14 dec)
  18048. </member>
  18049. <member name="M:NPOI.HSSF.Record.FnGroupCountRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18050. Constructs a FnGroupCount record and Sets its fields appropriately.
  18051. @param in the RecordInputstream to Read the record from
  18052. </member>
  18053. <member name="P:NPOI.HSSF.Record.FnGroupCountRecord.Count">
  18054. Get the number of built-in functions
  18055. @return number of built-in functions
  18056. </member>
  18057. <member name="T:NPOI.HSSF.Record.FontRecord">
  18058. Title: Font Record - descrbes a font in the workbook (index = 0-3,5-infinity - skip 4)
  18059. Description: An element in the Font Table
  18060. REFERENCE: PG 315 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18061. @author Andrew C. Oliver (acoliver at apache dot org)
  18062. @version 2.0-pre
  18063. </member>
  18064. <member name="M:NPOI.HSSF.Record.FontRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18065. Constructs a Font record and Sets its fields appropriately.
  18066. @param in the RecordInputstream to Read the record from
  18067. </member>
  18068. <member name="M:NPOI.HSSF.Record.FontRecord.CloneStyleFrom(NPOI.HSSF.Record.FontRecord)">
  18069. Clones all the font style information from another
  18070. FontRecord, onto this one. This
  18071. will then hold all the same font style options.
  18072. </member>
  18073. <member name="M:NPOI.HSSF.Record.FontRecord.SameProperties(NPOI.HSSF.Record.FontRecord)">
  18074. Does this FontRecord have all the same font
  18075. properties as the supplied FontRecord?
  18076. Note that {@link #equals(Object)} will check
  18077. for exact objects, while this will check
  18078. for exact contents, because normally the
  18079. font record's position makes a big
  18080. difference too.
  18081. </member>
  18082. <member name="M:NPOI.HSSF.Record.FontRecord.Equals(System.Object)">
  18083. Only returns two for the same exact object -
  18084. creating a second FontRecord with the same
  18085. properties won't be considered equal, as
  18086. the record's position in the record stream
  18087. matters.
  18088. </member>
  18089. <member name="P:NPOI.HSSF.Record.FontRecord.IsItalic">
  18090. Set the font to be italics or not
  18091. @param italics - whether the font Is italics or not
  18092. @see #SetAttributes(short)
  18093. </member>
  18094. <member name="P:NPOI.HSSF.Record.FontRecord.IsStrikeout">
  18095. Set the font to be stricken out or not
  18096. @param strike - whether the font Is stricken out or not
  18097. @see #SetAttributes(short)
  18098. </member>
  18099. <member name="P:NPOI.HSSF.Record.FontRecord.IsMacoutlined">
  18100. whether to use the mac outline font style thing (mac only) - Some mac person
  18101. should comment this instead of me doing it (since I have no idea)
  18102. @param mac - whether to do that mac font outline thing or not
  18103. @see #SetAttributes(short)
  18104. </member>
  18105. <member name="P:NPOI.HSSF.Record.FontRecord.IsMacshadowed">
  18106. whether to use the mac shado font style thing (mac only) - Some mac person
  18107. should comment this instead of me doing it (since I have no idea)
  18108. @param mac - whether to do that mac font shadow thing or not
  18109. @see #SetAttributes(short)
  18110. </member>
  18111. <member name="P:NPOI.HSSF.Record.FontRecord.Underline">
  18112. Set the type of Underlining for the font
  18113. </member>
  18114. <member name="P:NPOI.HSSF.Record.FontRecord.Family">
  18115. Set the font family (TODO)
  18116. @param f family
  18117. </member>
  18118. <member name="P:NPOI.HSSF.Record.FontRecord.Charset">
  18119. Set the Char Set
  18120. @param charSet - CharSet
  18121. </member>
  18122. <member name="P:NPOI.HSSF.Record.FontRecord.FontName">
  18123. Set the name of the font
  18124. @param fn - name of the font (i.e. "Arial")
  18125. </member>
  18126. <member name="P:NPOI.HSSF.Record.FontRecord.FontHeight">
  18127. Gets the height of the font in 1/20th point Units
  18128. @return fontheight (in points/20)
  18129. </member>
  18130. <member name="P:NPOI.HSSF.Record.FontRecord.Attributes">
  18131. Get the font attributes (see individual bit Getters that reference this method)
  18132. @return attribute - the bitmask
  18133. </member>
  18134. <member name="P:NPOI.HSSF.Record.FontRecord.ColorPaletteIndex">
  18135. Get the font's color palette index
  18136. @return cpi - font color index
  18137. </member>
  18138. <member name="P:NPOI.HSSF.Record.FontRecord.BoldWeight">
  18139. Get the bold weight for this font (100-1000dec or 0x64-0x3e8). Default Is
  18140. 0x190 for normal and 0x2bc for bold
  18141. @return bw - a number between 100-1000 for the fonts "boldness"
  18142. </member>
  18143. <member name="P:NPOI.HSSF.Record.FontRecord.SuperSubScript">
  18144. Get the type of base or subscript for the font
  18145. @return base or subscript option
  18146. </member>
  18147. <member name="T:NPOI.HSSF.Record.FooterRecord">
  18148. Title: Footer Record
  18149. Description: Specifies the footer for a sheet
  18150. REFERENCE: PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18151. @author Andrew C. Oliver (acoliver at apache dot org)
  18152. @author Shawn Laubach (slaubach at apache dot org) Modified 3/14/02
  18153. @author Jason Height (jheight at chariot dot net dot au)
  18154. @version 2.0-pre
  18155. </member>
  18156. <member name="T:NPOI.HSSF.Record.HeaderFooterBase">
  18157. Common header/footer base class
  18158. @author Josh Micich
  18159. </member>
  18160. <member name="P:NPOI.HSSF.Record.HeaderFooterBase.TextLength">
  18161. get the length of the footer string
  18162. @return length of the footer string
  18163. </member>
  18164. <member name="M:NPOI.HSSF.Record.FooterRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18165. <summary>
  18166. Initializes a new instance of the <see cref="T:NPOI.HSSF.Record.FooterRecord"/> class.
  18167. </summary>
  18168. <param name="in1">the RecordInputstream to Read the record from</param>
  18169. </member>
  18170. <member name="M:NPOI.HSSF.Record.FooterRecord.ToString">
  18171. <summary>
  18172. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  18173. </summary>
  18174. <returns>
  18175. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  18176. </returns>
  18177. </member>
  18178. <member name="P:NPOI.HSSF.Record.FooterRecord.Sid">
  18179. <summary>
  18180. </summary>
  18181. <value></value>
  18182. return the non static version of the id for this record.
  18183. </member>
  18184. <member name="T:NPOI.HSSF.Record.FormatRecord">
  18185. Title: Format Record
  18186. Description: describes a number format -- those goofy strings like $(#,###)
  18187. REFERENCE: PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18188. @author Andrew C. Oliver (acoliver at apache dot org)
  18189. @author Shawn M. Laubach (slaubach at apache dot org)
  18190. @version 2.0-pre
  18191. </member>
  18192. <member name="M:NPOI.HSSF.Record.FormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18193. Constructs a Format record and Sets its fields appropriately.
  18194. @param in the RecordInputstream to Read the record from
  18195. </member>
  18196. <member name="P:NPOI.HSSF.Record.FormatRecord.IndexCode">
  18197. Get the format index code (for built in formats)
  18198. @return the format index code
  18199. @see org.apache.poi.hssf.model.Workbook
  18200. </member>
  18201. <member name="P:NPOI.HSSF.Record.FormatRecord.FormatString">
  18202. Get the format string
  18203. @return the format string
  18204. </member>
  18205. <member name="T:NPOI.HSSF.Record.SpecialCachedValue">
  18206. Manages the cached formula result values of other types besides numeric.
  18207. Excel encodes the same 8 bytes that would be field_4_value with various NaN
  18208. values that are decoded/encoded by this class.
  18209. </member>
  18210. <member name="F:NPOI.HSSF.Record.SpecialCachedValue.BIT_MARKER">
  18211. deliberately chosen by Excel in order to encode other values within Double NaNs
  18212. </member>
  18213. <member name="M:NPOI.HSSF.Record.SpecialCachedValue.Create(System.Int64)">
  18214. @return <c>null</c> if the double value encoded by <c>valueLongBits</c>
  18215. is a normal (non NaN) double value.
  18216. </member>
  18217. <member name="T:NPOI.HSSF.Record.FormulaRecord">
  18218. Formula Record.
  18219. REFERENCE: PG 317/444 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18220. @author Andrew C. Oliver (acoliver at apache dot org)
  18221. @author Jason Height (jheight at chariot dot net dot au)
  18222. @version 2.0-pre
  18223. </member>
  18224. <member name="F:NPOI.HSSF.Record.FormulaRecord.specialCachedValue">
  18225. Since the NaN support seems sketchy (different constants) we'll store and spit it out directly
  18226. </member>
  18227. <member name="M:NPOI.HSSF.Record.FormulaRecord.#ctor">
  18228. Creates new FormulaRecord
  18229. </member>
  18230. <member name="M:NPOI.HSSF.Record.FormulaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18231. Constructs a Formula record and Sets its fields appropriately.
  18232. Note - id must be 0x06 (NOT 0x406 see MSKB #Q184647 for an
  18233. "explanation of this bug in the documentation) or an exception
  18234. will be throw upon validation
  18235. @param in the RecordInputstream to Read the record from
  18236. </member>
  18237. <member name="P:NPOI.HSSF.Record.FormulaRecord.HasCachedResultString">
  18238. @return <c>true</c> if this {@link FormulaRecord} is followed by a
  18239. {@link StringRecord} representing the cached text result of the formula
  18240. evaluation.
  18241. </member>
  18242. <member name="P:NPOI.HSSF.Record.FormulaRecord.Value">
  18243. Get the calculated value of the formula
  18244. @return calculated value
  18245. </member>
  18246. <member name="P:NPOI.HSSF.Record.FormulaRecord.Options">
  18247. Get the option flags
  18248. @return bitmask
  18249. </member>
  18250. <member name="P:NPOI.HSSF.Record.FormulaRecord.ParsedExpression">
  18251. Get the stack as a list
  18252. @return list of tokens (casts stack to a list and returns it!)
  18253. this method can return null Is we are Unable to Create Ptgs from
  18254. existing excel file
  18255. callers should Check for null!
  18256. </member>
  18257. <member name="T:NPOI.HSSF.Record.GridsetRecord">
  18258. Title: GridSet Record.
  18259. Description: flag denoting whether the user specified that gridlines are used when
  18260. printing.
  18261. REFERENCE: PG 320 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18262. @author Andrew C. Oliver (acoliver at apache dot org)
  18263. @author Glen Stampoultzis (glens at apache.org)
  18264. @author Jason Height (jheight at chariot dot net dot au)
  18265. @version 2.0-pre
  18266. </member>
  18267. <member name="M:NPOI.HSSF.Record.GridsetRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18268. Constructs a GridSet record and Sets its fields appropriately.
  18269. @param in the RecordInputstream to Read the record from
  18270. </member>
  18271. <member name="P:NPOI.HSSF.Record.GridsetRecord.Gridset">
  18272. Get whether the gridlines are shown during printing.
  18273. @return gridSet - true if gridlines are NOT printed, false if they are.
  18274. </member>
  18275. <member name="T:NPOI.HSSF.Record.GutsRecord">
  18276. Title: Guts Record
  18277. Description: Row/column gutter sizes
  18278. REFERENCE: PG 320 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18279. @author Andrew C. Oliver (acoliver at apache dot org)
  18280. @author Jason Height (jheight at chariot dot net dot au)
  18281. @version 2.0-pre
  18282. </member>
  18283. <member name="M:NPOI.HSSF.Record.GutsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18284. Constructs a Guts record and Sets its fields appropriately.
  18285. @param in the RecordInputstream to Read the record from
  18286. </member>
  18287. <member name="P:NPOI.HSSF.Record.GutsRecord.LeftRowGutter">
  18288. Get the size of the gutter that appears at the left of the rows
  18289. @return gutter size in screen Units
  18290. </member>
  18291. <member name="P:NPOI.HSSF.Record.GutsRecord.TopColGutter">
  18292. Get the size of the gutter that appears at the above the columns
  18293. @return gutter size in screen Units
  18294. </member>
  18295. <member name="P:NPOI.HSSF.Record.GutsRecord.RowLevelMax">
  18296. Get the maximum outline level for the row gutter.
  18297. @return maximum outline level
  18298. </member>
  18299. <member name="P:NPOI.HSSF.Record.GutsRecord.ColLevelMax">
  18300. Get the maximum outline level for the col gutter.
  18301. @return maximum outline level
  18302. </member>
  18303. <member name="T:NPOI.HSSF.Record.HCenterRecord">
  18304. Title: HCenter record
  18305. Description: whether to center between horizontal margins
  18306. REFERENCE: PG 320 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18307. @author Andrew C. Oliver (acoliver at apache dot org)
  18308. @author Jason Height (jheight at chariot dot net dot au)
  18309. @version 2.0-pre
  18310. </member>
  18311. <member name="M:NPOI.HSSF.Record.HCenterRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18312. Constructs an HCenter record and Sets its fields appropriately.
  18313. @param in the RecordInputstream to Read the record from
  18314. </member>
  18315. <member name="P:NPOI.HSSF.Record.HCenterRecord.HCenter">
  18316. Get whether or not to horizonatally center this sheet.
  18317. @return center - t/f
  18318. </member>
  18319. <member name="T:NPOI.HSSF.Record.HeaderFooterRecord">
  18320. The HEADERFOOTER record stores information Added in Office Excel 2007 for headers/footers.
  18321. @author Yegor Kozlov
  18322. </member>
  18323. <member name="M:NPOI.HSSF.Record.HeaderFooterRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18324. construct a HeaderFooterRecord record. No fields are interpreted and the record will
  18325. be Serialized in its original form more or less
  18326. @param in the RecordInputstream to read the record from
  18327. </member>
  18328. <member name="M:NPOI.HSSF.Record.HeaderFooterRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  18329. spit the record out AS IS. no interpretation or identification
  18330. </member>
  18331. <member name="P:NPOI.HSSF.Record.HeaderFooterRecord.Guid">
  18332. If this header belongs to a specific sheet view , the sheet view?s GUID will be saved here.
  18333. If it is zero, it means the current sheet. Otherwise, this field MUST match the guid field
  18334. of the preceding {@link UserSViewBegin} record.
  18335. @return the sheet view's GUID
  18336. </member>
  18337. <member name="P:NPOI.HSSF.Record.HeaderFooterRecord.IsCurrentSheet">
  18338. @return whether this record belongs to the current sheet
  18339. </member>
  18340. <member name="T:NPOI.HSSF.Record.HeaderRecord">
  18341. Title: Header Record
  18342. Description: Specifies a header for a sheet
  18343. REFERENCE: PG 321 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18344. @author Andrew C. Oliver (acoliver at apache dot org)
  18345. @author Shawn Laubach (slaubach at apache dot org) Modified 3/14/02
  18346. @author Jason Height (jheight at chariot dot net dot au)
  18347. @version 2.0-pre
  18348. </member>
  18349. <member name="M:NPOI.HSSF.Record.HeaderRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18350. Constructs an Header record and Sets its fields appropriately.
  18351. @param in the RecordInputstream to Read the record from
  18352. </member>
  18353. <member name="T:NPOI.HSSF.Record.HideObjRecord">
  18354. Title: Hide Object Record
  18355. Description: flag defines whether to hide placeholders and object
  18356. REFERENCE: PG 321 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18357. @author Andrew C. Oliver (acoliver at apache dot org)
  18358. @version 2.0-pre
  18359. </member>
  18360. <member name="M:NPOI.HSSF.Record.HideObjRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18361. Constructs an HideObj record and Sets its fields appropriately.
  18362. @param in the RecordInputstream to Read the record from
  18363. </member>
  18364. <member name="M:NPOI.HSSF.Record.HideObjRecord.SetHideObj(System.Int16)">
  18365. Set hide object options
  18366. @param hide options
  18367. @see #HIDE_ALL
  18368. @see #SHOW_PLACEHOLDERS
  18369. @see #SHOW_ALL
  18370. </member>
  18371. <member name="M:NPOI.HSSF.Record.HideObjRecord.GetHideObj">
  18372. Get hide object options
  18373. @return hide options
  18374. @see #HIDE_ALL
  18375. @see #SHOW_PLACEHOLDERS
  18376. @see #SHOW_ALL
  18377. </member>
  18378. <member name="T:NPOI.HSSF.Record.HorizontalPageBreakRecord">
  18379. HorizontalPageBreak record that stores page breaks at rows
  18380. This class Is just used so that SID Compares work properly in the RecordFactory
  18381. @see PageBreakRecord
  18382. @author Danny Mui (dmui at apache dot org)
  18383. </member>
  18384. <member name="T:NPOI.HSSF.Record.PageBreakRecord">
  18385. Record that Contains the functionality page _breaks (horizontal and vertical)
  18386. The other two classes just specifically Set the SIDS for record creation.
  18387. REFERENCE: Microsoft Excel SDK page 322 and 420
  18388. @see HorizontalPageBreakRecord
  18389. @see VerticalPageBreakRecord
  18390. @author Danny Mui (dmui at apache dot org)
  18391. </member>
  18392. <member name="M:NPOI.HSSF.Record.PageBreakRecord.AddBreak(System.Int32,System.Int32,System.Int32)">
  18393. Adds the page break at the specified parameters
  18394. @param main Depending on sid, will determine row or column to put page break (zero-based)
  18395. @param subFrom No user-interface to Set (defaults to minumum, 0)
  18396. @param subTo No user-interface to Set
  18397. </member>
  18398. <member name="M:NPOI.HSSF.Record.PageBreakRecord.RemoveBreak(System.Int32)">
  18399. Removes the break indicated by the parameter
  18400. @param main (zero-based)
  18401. </member>
  18402. <member name="M:NPOI.HSSF.Record.PageBreakRecord.GetBreak(System.Int32)">
  18403. Retrieves the region at the row/column indicated
  18404. @param main FIXME: Document this!
  18405. @return The Break or null if no break exists at the row/col specified.
  18406. </member>
  18407. <member name="T:NPOI.HSSF.Record.PageBreakRecord.Break">
  18408. Since both records store 2byte integers (short), no point in
  18409. differentiating it in the records.
  18410. The subs (rows or columns, don't seem to be able to Set but excel Sets
  18411. them automatically)
  18412. </member>
  18413. <member name="M:NPOI.HSSF.Record.HorizontalPageBreakRecord.#ctor">
  18414. </member>
  18415. <member name="M:NPOI.HSSF.Record.HorizontalPageBreakRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18416. @param in the RecordInputstream to Read the record from
  18417. </member>
  18418. <member name="T:NPOI.HSSF.Record.HyperlinkRecord">
  18419. The <c>HyperlinkRecord</c> wraps an HLINK-record
  18420. from the Excel-97 format.
  18421. Supports only external links for now (eg http://)
  18422. @author Mark Hissink Muller <a href="mailto:mark@hissinkmuller.nl">mark@hissinkmuller.nl</a>
  18423. @author Yegor Kozlov (yegor at apache dot org)
  18424. </member>
  18425. <member name="F:NPOI.HSSF.Record.HyperlinkRecord.HLINK_URL">
  18426. Link flags
  18427. </member>
  18428. <member name="F:NPOI.HSSF.Record.HyperlinkRecord.URL_uninterpretedTail">
  18429. Tail of a URL link
  18430. </member>
  18431. <member name="F:NPOI.HSSF.Record.HyperlinkRecord.FILE_uninterpretedTail">
  18432. Tail of a file link
  18433. </member>
  18434. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._range">
  18435. cell range of this hyperlink
  18436. </member>
  18437. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._guid">
  18438. 16-byte GUID
  18439. </member>
  18440. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._fileOpts">
  18441. Some sort of options for file links.
  18442. </member>
  18443. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._linkOpts">
  18444. Link options. Can include any of HLINK_* flags.
  18445. </member>
  18446. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._label">
  18447. Test label
  18448. </member>
  18449. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._moniker">
  18450. Moniker. Makes sense only for URL and file links
  18451. </member>
  18452. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._shortFilename">
  18453. in 8:3 DOS format No Unicode string header,
  18454. always 8-bit characters, zero-terminated
  18455. </member>
  18456. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._address">
  18457. Link
  18458. </member>
  18459. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._textMark">
  18460. Text describing a place in document. In Excel UI, this is appended to the
  18461. address, (after a '#' delimiter).<br/>
  18462. This field is optional. If present, the {@link #HLINK_PLACE} must be set.
  18463. </member>
  18464. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._uninterpretedTail">
  18465. Remaining bytes
  18466. </member>
  18467. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.#ctor">
  18468. Create a new hyperlink
  18469. </member>
  18470. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18471. Read hyperlink from input stream
  18472. @param in the stream to Read from
  18473. </member>
  18474. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.CreateUrlLink">
  18475. <summary>
  18476. Initialize a new url link
  18477. </summary>
  18478. </member>
  18479. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.CreateFileLink">
  18480. <summary>
  18481. Initialize a new file link
  18482. </summary>
  18483. </member>
  18484. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.CreateDocumentLink">
  18485. <summary>
  18486. Initialize a new document link
  18487. </summary>
  18488. </member>
  18489. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.FirstColumn">
  18490. Return the column of the first cell that Contains the hyperlink
  18491. @return the 0-based column of the first cell that Contains the hyperlink
  18492. </member>
  18493. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.LastColumn">
  18494. Set the column of the last cell that Contains the hyperlink
  18495. @return the 0-based column of the last cell that Contains the hyperlink
  18496. </member>
  18497. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.FirstRow">
  18498. Return the row of the first cell that Contains the hyperlink
  18499. @return the 0-based row of the first cell that Contains the hyperlink
  18500. </member>
  18501. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.LastRow">
  18502. Return the row of the last cell that Contains the hyperlink
  18503. @return the 0-based row of the last cell that Contains the hyperlink
  18504. </member>
  18505. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.Guid">
  18506. Returns a 16-byte guid identifier. Seems to always equal {@link STD_MONIKER}
  18507. @return 16-byte guid identifier
  18508. </member>
  18509. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.Moniker">
  18510. Returns a 16-byte moniker.
  18511. @return 16-byte moniker
  18512. </member>
  18513. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.Label">
  18514. Return text label for this hyperlink
  18515. @return text to Display
  18516. </member>
  18517. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.Address">
  18518. Hypelink Address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
  18519. @return the Address of this hyperlink
  18520. </member>
  18521. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.LinkOptions">
  18522. Link options. Must be a combination of HLINK_* constants.
  18523. </member>
  18524. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.LabelOptions">
  18525. Label options
  18526. </member>
  18527. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.FileOptions">
  18528. Options for a file link
  18529. </member>
  18530. <member name="T:NPOI.HSSF.Record.IndexRecord">
  18531. Title: Index Record
  18532. Description: Occurs right after BOF, tells you where the DBCELL records are for a sheet
  18533. Important for locating cells
  18534. NOT USED IN THIS RELEASE
  18535. REFERENCE: PG 323 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18536. @author Andrew C. Oliver (acoliver at apache dot org)
  18537. @author Jason Height (jheight at chariot dot net dot au)
  18538. @version 2.0-pre
  18539. </member>
  18540. <member name="M:NPOI.HSSF.Record.IndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18541. Constructs an Index record and Sets its fields appropriately.
  18542. @param in the RecordInputstream to Read the record from
  18543. </member>
  18544. <member name="M:NPOI.HSSF.Record.IndexRecord.GetRecordSizeForBlockCount(System.Int32)">
  18545. Returns the size of an INdexRecord when it needs to index the specified number of blocks
  18546. </member>
  18547. <member name="T:NPOI.HSSF.Record.InterfaceEndRecord">
  18548. Title: Interface End Record
  18549. Description: Shows where the Interface Records end (MMS)
  18550. (has no fields)
  18551. REFERENCE: PG 324 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18552. @author Andrew C. Oliver (acoliver at apache dot org)
  18553. @version 2.0-pre
  18554. </member>
  18555. <member name="M:NPOI.HSSF.Record.InterfaceEndRecord.Create(NPOI.HSSF.Record.RecordInputStream)">
  18556. Constructs an InterfaceEnd record and Sets its fields appropriately.
  18557. @param in the RecordInputstream to Read the record from
  18558. </member>
  18559. <member name="M:NPOI.HSSF.Record.InterfaceEndRecord.GetDataSize">
  18560. <summary>
  18561. for test TestInterfaceEndRecord.TestCreate()
  18562. </summary>
  18563. <returns></returns>
  18564. </member>
  18565. <member name="T:NPOI.HSSF.Record.InterfaceHdrRecord">
  18566. Title: Interface Header Record
  18567. Description: Defines the beginning of Interface records (MMS)
  18568. REFERENCE: PG 324 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18569. @author Andrew C. Oliver (acoliver at apache dot org)
  18570. @version 2.0-pre
  18571. </member>
  18572. <member name="F:NPOI.HSSF.Record.InterfaceHdrRecord.CODEPAGE">
  18573. suggested (and probably correct) default
  18574. </member>
  18575. <member name="M:NPOI.HSSF.Record.InterfaceHdrRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18576. Constructs an Codepage record and Sets its fields appropriately.
  18577. @param in the RecordInputstream to Read the record from
  18578. </member>
  18579. <member name="T:NPOI.HSSF.Record.IterationRecord">
  18580. Title: Iteration Record
  18581. Description: Tells whether to iterate over forumla calculations or not
  18582. (if a formula Is dependant upon another formula's result)
  18583. (odd feature for something that can only have 32 elements in
  18584. a formula!)
  18585. REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18586. @author Andrew C. Oliver (acoliver at apache dot org)
  18587. @author Jason Height (jheight at chariot dot net dot au)
  18588. @version 2.0-pre
  18589. </member>
  18590. <member name="M:NPOI.HSSF.Record.IterationRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18591. Constructs an Iteration record and Sets its fields appropriately.
  18592. @param in the RecordInputstream to Read the record from
  18593. </member>
  18594. <member name="P:NPOI.HSSF.Record.IterationRecord.Iteration">
  18595. Get whether or not to iterate for calculations
  18596. @return whether iterative calculations are turned off or on
  18597. </member>
  18598. <member name="T:NPOI.HSSF.Record.LabelRecord">
  18599. Label Record - Read only support for strings stored directly in the cell.. Don't
  18600. use this (except to Read), use LabelSST instead
  18601. REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18602. @see org.apache.poi.hssf.record.LabelSSTRecord
  18603. </member>
  18604. <member name="M:NPOI.HSSF.Record.LabelRecord.#ctor">
  18605. Creates new LabelRecord
  18606. </member>
  18607. <member name="M:NPOI.HSSF.Record.LabelRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18608. Constructs an Label record and Sets its fields appropriately.
  18609. @param in the RecordInputstream to Read the record from
  18610. </member>
  18611. <member name="M:NPOI.HSSF.Record.LabelRecord.Serialize(System.Int32,System.Byte[])">
  18612. THROWS A RUNTIME EXCEPTION.. USE LABELSSTRecords. YOU HAVE NO REASON to use LABELRecord!!
  18613. </member>
  18614. <member name="P:NPOI.HSSF.Record.LabelRecord.StringLength">
  18615. Get the number of Chars this string Contains
  18616. @return number of Chars
  18617. </member>
  18618. <member name="P:NPOI.HSSF.Record.LabelRecord.IsUncompressedUnicode">
  18619. Is this Uncompressed Unicode (16bit)? Or just 8-bit compressed?
  18620. @return IsUnicode - True for 16bit- false for 8bit
  18621. </member>
  18622. <member name="P:NPOI.HSSF.Record.LabelRecord.Value">
  18623. Get the value
  18624. @return the text string
  18625. @see #GetStringLength
  18626. </member>
  18627. <member name="T:NPOI.HSSF.Record.LabelSSTRecord">
  18628. Title: Label SST Record
  18629. Description: Refers to a string in the shared string table and Is a column
  18630. value.
  18631. REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18632. @author Andrew C. Oliver (acoliver at apache dot org)
  18633. @author Jason Height (jheight at chariot dot net dot au)
  18634. @version 2.0-pre
  18635. </member>
  18636. <member name="M:NPOI.HSSF.Record.LabelSSTRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18637. Constructs an LabelSST record and Sets its fields appropriately.
  18638. @param in the RecordInputstream to Read the record from
  18639. </member>
  18640. <member name="P:NPOI.HSSF.Record.LabelSSTRecord.SSTIndex">
  18641. Get the index to the string in the SSTRecord
  18642. @return index of string in the SST Table
  18643. @see org.apache.poi.hssf.record.SSTRecord
  18644. </member>
  18645. <member name="T:NPOI.HSSF.Record.LeftMarginRecord">
  18646. Record for the left margin.
  18647. NOTE: This source was automatically generated.
  18648. @author Shawn Laubach (slaubach at apache dot org)
  18649. </member>
  18650. <member name="M:NPOI.HSSF.Record.LeftMarginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18651. Constructs a LeftMargin record and Sets its fields appropriately.
  18652. @param in the RecordInputstream to Read the record from
  18653. </member>
  18654. <member name="P:NPOI.HSSF.Record.LeftMarginRecord.Margin">
  18655. Get the margin field for the LeftMargin record.
  18656. </member>
  18657. <member name="T:NPOI.HSSF.Record.LinkedDataFormulaField">
  18658. Not implemented yet. May commit it anyway just so people can see
  18659. where I'm heading.
  18660. @author Glen Stampoultzis (glens at apache.org)
  18661. </member>
  18662. <member name="T:NPOI.HSSF.Record.MergeCellsRecord">
  18663. Title: Merged Cells Record
  18664. Description: Optional record defining a square area of cells to "merged" into
  18665. one cell.
  18666. REFERENCE: NONE (UNDOCUMENTED PRESENTLY)
  18667. @author Andrew C. Oliver (acoliver at apache dot org)
  18668. @version 2.0-pre
  18669. </member>
  18670. <member name="F:NPOI.HSSF.Record.MergeCellsRecord._regions">
  18671. sometimes the regions array is shared with other MergedCellsRecords
  18672. </member>
  18673. <member name="M:NPOI.HSSF.Record.MergeCellsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18674. Constructs a MergedCellsRecord and Sets its fields appropriately
  18675. @param in the RecordInputstream to Read the record from
  18676. </member>
  18677. <member name="M:NPOI.HSSF.Record.MergeCellsRecord.GetAreaAt(System.Int32)">
  18678. @return MergedRegion at the given index representing the area that is Merged (r1,c1 - r2,c2)
  18679. </member>
  18680. <member name="P:NPOI.HSSF.Record.MergeCellsRecord.NumAreas">
  18681. Get the number of merged areas. If this drops down to 0 you should just go
  18682. ahead and delete the record.
  18683. @return number of areas
  18684. </member>
  18685. <member name="T:NPOI.HSSF.Record.MMSRecord">
  18686. Title: MMS Record
  18687. Description: defines how many Add menu and del menu options are stored
  18688. in the file. Should always be Set to 0 for HSSF workbooks
  18689. REFERENCE: PG 328 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18690. @author Andrew C. Oliver (acoliver at apache dot org)
  18691. @version 2.0-pre
  18692. </member>
  18693. <member name="M:NPOI.HSSF.Record.MMSRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18694. Constructs a MMS record and Sets its fields appropriately.
  18695. @param in the RecordInputstream to Read the record from
  18696. </member>
  18697. <member name="P:NPOI.HSSF.Record.MMSRecord.AddMenuCount">
  18698. Set number of Add menu options (Set to 0)
  18699. @param am number of Add menu options
  18700. </member>
  18701. <member name="P:NPOI.HSSF.Record.MMSRecord.DelMenuCount">
  18702. Set number of del menu options (Set to 0)
  18703. @param dm number of del menu options
  18704. </member>
  18705. <member name="T:NPOI.HSSF.Record.MulBlankRecord">
  18706. Title: Mulitple Blank cell record
  18707. Description: Represents a Set of columns in a row with no value but with styling.
  18708. In this release we have Read-only support for this record type.
  18709. The RecordFactory Converts this to a Set of BlankRecord objects.
  18710. REFERENCE: PG 329 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18711. @author Andrew C. Oliver (acoliver at apache dot org)
  18712. @author Glen Stampoultzis (glens at apache.org)
  18713. @version 2.0-pre
  18714. @see org.apache.poi.hssf.record.BlankRecord
  18715. </member>
  18716. <member name="M:NPOI.HSSF.Record.MulBlankRecord.#ctor">
  18717. Creates new MulBlankRecord
  18718. </member>
  18719. <member name="M:NPOI.HSSF.Record.MulBlankRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18720. Constructs a MulBlank record and Sets its fields appropriately.
  18721. @param in the RecordInputstream to Read the record from
  18722. </member>
  18723. <member name="M:NPOI.HSSF.Record.MulBlankRecord.GetXFAt(System.Int32)">
  18724. returns the xf index for column (coffset = column - field_2_first_col)
  18725. @param coffset the column (coffset = column - field_2_first_col)
  18726. @return the XF index for the column
  18727. </member>
  18728. <member name="P:NPOI.HSSF.Record.MulBlankRecord.Row">
  18729. Get the row number of the cells this represents
  18730. @return row number
  18731. </member>
  18732. <member name="P:NPOI.HSSF.Record.MulBlankRecord.FirstColumn">
  18733. starting column (first cell this holds in the row)
  18734. @return first column number
  18735. </member>
  18736. <member name="P:NPOI.HSSF.Record.MulBlankRecord.LastColumn">
  18737. ending column (last cell this holds in the row)
  18738. @return first column number
  18739. </member>
  18740. <member name="P:NPOI.HSSF.Record.MulBlankRecord.NumColumns">
  18741. Get the number of columns this Contains (last-first +1)
  18742. @return number of columns (last - first +1)
  18743. </member>
  18744. <member name="T:NPOI.HSSF.Record.MulRKRecord">
  18745. Used to store multiple RK numbers on a row. 1 MulRk = Multiple Cell values.
  18746. HSSF just Converts this into multiple NUMBER records. Read-ONLY SUPPORT!
  18747. REFERENCE: PG 330 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18748. @author Andrew C. Oliver (acoliver at apache dot org)
  18749. @version 2.0-pre
  18750. </member>
  18751. <member name="M:NPOI.HSSF.Record.MulRKRecord.#ctor">
  18752. Creates new MulRKRecord
  18753. </member>
  18754. <member name="M:NPOI.HSSF.Record.MulRKRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18755. Constructs a MulRK record and Sets its fields appropriately.
  18756. @param in the RecordInputstream to Read the record from
  18757. </member>
  18758. <member name="M:NPOI.HSSF.Record.MulRKRecord.GetXFAt(System.Int32)">
  18759. returns the xf index for column (coffset = column - field_2_first_col)
  18760. @return the XF index for the column
  18761. </member>
  18762. <member name="M:NPOI.HSSF.Record.MulRKRecord.GetRKNumberAt(System.Int32)">
  18763. returns the rk number for column (coffset = column - field_2_first_col)
  18764. @return the value (decoded into a double)
  18765. </member>
  18766. <member name="P:NPOI.HSSF.Record.MulRKRecord.FirstColumn">
  18767. starting column (first cell this holds in the row)
  18768. @return first column number
  18769. </member>
  18770. <member name="P:NPOI.HSSF.Record.MulRKRecord.LastColumn">
  18771. ending column (last cell this holds in the row)
  18772. @return first column number
  18773. </member>
  18774. <member name="P:NPOI.HSSF.Record.MulRKRecord.NumColumns">
  18775. Get the number of columns this Contains (last-first +1)
  18776. @return number of columns (last - first +1)
  18777. </member>
  18778. <member name="T:NPOI.HSSF.Record.NameCommentRecord">
  18779. Title: NAMECMT Record (0x0894)
  18780. Description: Defines a comment associated with a specified name.
  18781. REFERENCE:
  18782. @author Andrew Shirley (aks at corefiling.co.uk)
  18783. </member>
  18784. <member name="M:NPOI.HSSF.Record.NameCommentRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18785. @param ris the RecordInputstream to read the record from
  18786. </member>
  18787. <member name="P:NPOI.HSSF.Record.NameCommentRecord.Sid">
  18788. return the non static version of the id for this record.
  18789. </member>
  18790. <member name="P:NPOI.HSSF.Record.NameCommentRecord.NameText">
  18791. @return the name of the NameRecord to which this comment applies.
  18792. </member>
  18793. <member name="P:NPOI.HSSF.Record.NameCommentRecord.CommentText">
  18794. @return the text of the comment.
  18795. </member>
  18796. <member name="T:NPOI.HSSF.Record.NameRecord">
  18797. Title: Name Record (aka Named Range)
  18798. Description: Defines a named range within a workbook.
  18799. REFERENCE:
  18800. @author Libin Roman (Vista Portal LDT. Developer)
  18801. @author Sergei Kozello (sergeikozello at mail.ru)
  18802. @author Glen Stampoultzis (glens at apache.org)
  18803. @version 1.0-pre
  18804. </member>
  18805. <member name="F:NPOI.HSSF.Record.NameRecord.sid">
  18806. </member>
  18807. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_CONSOLIDATE_AREA">
  18808. Included for completeness sake, not implemented
  18809. </member>
  18810. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_AUTO_OPEN">
  18811. Included for completeness sake, not implemented
  18812. </member>
  18813. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_AUTO_CLOSE">
  18814. Included for completeness sake, not implemented
  18815. </member>
  18816. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_DATABASE">
  18817. Included for completeness sake, not implemented
  18818. </member>
  18819. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_CRITERIA">
  18820. Included for completeness sake, not implemented
  18821. </member>
  18822. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_RECORDER">
  18823. Included for completeness sake, not implemented
  18824. </member>
  18825. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_DATA_FORM">
  18826. Included for completeness sake, not implemented
  18827. </member>
  18828. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_AUTO_ACTIVATE">
  18829. Included for completeness sake, not implemented
  18830. </member>
  18831. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_AUTO_DEACTIVATE">
  18832. Included for completeness sake, not implemented
  18833. </member>
  18834. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_SHEET_TITLE">
  18835. Included for completeness sake, not implemented
  18836. </member>
  18837. <member name="F:NPOI.HSSF.Record.NameRecord.field_5_externSheetIndex_plus1">
  18838. One-based extern index of sheet (resolved via LinkTable). Zero if this is a global name
  18839. </member>
  18840. <member name="F:NPOI.HSSF.Record.NameRecord.field_6_sheetNumber">
  18841. the one based sheet number.
  18842. </member>
  18843. <member name="M:NPOI.HSSF.Record.NameRecord.#ctor">
  18844. Creates new NameRecord
  18845. </member>
  18846. <member name="M:NPOI.HSSF.Record.NameRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18847. Constructs a Name record and Sets its fields appropriately.
  18848. @param in the RecordInputstream to Read the record from
  18849. </member>
  18850. <member name="M:NPOI.HSSF.Record.NameRecord.#ctor(System.Byte,System.Int32)">
  18851. Constructor to Create a built-in named region
  18852. @param builtin Built-in byte representation for the name record, use the public constants
  18853. @param index
  18854. </member>
  18855. <member name="M:NPOI.HSSF.Record.NameRecord.SetFunction(System.Boolean)">
  18856. Indicates that the defined name refers to a user-defined function.
  18857. This attribute is used when there is an add-in or other code project associated with the file.
  18858. @param function <c>true</c> indicates the name refers to a function.
  18859. </member>
  18860. <member name="M:NPOI.HSSF.Record.NameRecord.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  18861. called by the class that Is responsible for writing this sucker.
  18862. Subclasses should implement this so that their data Is passed back in a
  18863. @param offset to begin writing at
  18864. @param data byte array containing instance data
  18865. @return number of bytes written
  18866. </member>
  18867. <member name="M:NPOI.HSSF.Record.NameRecord.ToString">
  18868. @see Object#ToString()
  18869. </member>
  18870. <member name="M:NPOI.HSSF.Record.NameRecord.TranslateBuiltInName(System.Byte)">
  18871. Creates a human Readable name for built in types
  18872. @return Unknown if the built-in name cannot be translated
  18873. </member>
  18874. <member name="P:NPOI.HSSF.Record.NameRecord.FnGroup">
  18875. @return function Group
  18876. @see FnGroupCountRecord
  18877. </member>
  18878. <member name="P:NPOI.HSSF.Record.NameRecord.OptionFlag">
  18879. Gets the option flag
  18880. @return option flag
  18881. </member>
  18882. <member name="P:NPOI.HSSF.Record.NameRecord.KeyboardShortcut">
  18883. returns the keyboard shortcut
  18884. @return keyboard shortcut
  18885. </member>
  18886. <member name="P:NPOI.HSSF.Record.NameRecord.NameTextLength">
  18887. **
  18888. </member>
  18889. <member name="P:NPOI.HSSF.Record.NameRecord.HasFormula">
  18890. @return <c>true</c> if name has a formula (named range or defined value)
  18891. </member>
  18892. <member name="P:NPOI.HSSF.Record.NameRecord.IsHiddenName">
  18893. @return true if name Is hidden
  18894. </member>
  18895. <member name="P:NPOI.HSSF.Record.NameRecord.IsFunctionName">
  18896. @return true if name Is a function
  18897. </member>
  18898. <member name="P:NPOI.HSSF.Record.NameRecord.IsCommandName">
  18899. @return true if name Is a command
  18900. </member>
  18901. <member name="P:NPOI.HSSF.Record.NameRecord.IsMacro">
  18902. @return true if function macro or command macro
  18903. </member>
  18904. <member name="P:NPOI.HSSF.Record.NameRecord.IsComplexFunction">
  18905. @return true if array formula or user defined
  18906. </member>
  18907. <member name="P:NPOI.HSSF.Record.NameRecord.IsBuiltInName">
  18908. Convenience Function to determine if the name Is a built-in name
  18909. </member>
  18910. <member name="P:NPOI.HSSF.Record.NameRecord.NameText">
  18911. Gets the name
  18912. @return name
  18913. </member>
  18914. <member name="P:NPOI.HSSF.Record.NameRecord.BuiltInName">
  18915. Gets the Built In Name
  18916. @return the built in Name
  18917. </member>
  18918. <member name="P:NPOI.HSSF.Record.NameRecord.NameDefinition">
  18919. Gets the definition, reference (Formula)
  18920. @return definition -- can be null if we cant Parse ptgs
  18921. </member>
  18922. <member name="P:NPOI.HSSF.Record.NameRecord.CustomMenuText">
  18923. Get the custom menu text
  18924. @return custom menu text
  18925. </member>
  18926. <member name="P:NPOI.HSSF.Record.NameRecord.DescriptionText">
  18927. Gets the description text
  18928. @return description text
  18929. </member>
  18930. <member name="P:NPOI.HSSF.Record.NameRecord.HelpTopicText">
  18931. Get the help topic text
  18932. @return gelp topic text
  18933. </member>
  18934. <member name="P:NPOI.HSSF.Record.NameRecord.StatusBarText">
  18935. Gets the status bar text
  18936. @return status bar text
  18937. </member>
  18938. <member name="P:NPOI.HSSF.Record.NameRecord.SheetNumber">
  18939. For named ranges, and built-in names
  18940. @return the 1-based sheet number.
  18941. </member>
  18942. <member name="P:NPOI.HSSF.Record.NameRecord.ExternSheetNumber">
  18943. Gets the extern sheet number
  18944. @return extern sheet index
  18945. </member>
  18946. <member name="P:NPOI.HSSF.Record.NameRecord.Sid">
  18947. return the non static version of the id for this record.
  18948. </member>
  18949. <member name="T:NPOI.HSSF.Record.NoteRecord">
  18950. NOTE: Comment Associated with a Cell (1Ch)
  18951. @author Yegor Kozlov
  18952. </member>
  18953. <member name="F:NPOI.HSSF.Record.NoteRecord.NOTE_HIDDEN">
  18954. Flag indicating that the comment Is hidden (default)
  18955. </member>
  18956. <member name="F:NPOI.HSSF.Record.NoteRecord.NOTE_VISIBLE">
  18957. Flag indicating that the comment Is visible
  18958. </member>
  18959. <member name="F:NPOI.HSSF.Record.NoteRecord.field_7_padding">
  18960. Saves padding byte value to reduce delta during round-trip serialization.<br/>
  18961. The documentation is not clear about how padding should work. In any case
  18962. Excel(2007) does something different.
  18963. </member>
  18964. <member name="M:NPOI.HSSF.Record.NoteRecord.#ctor">
  18965. Construct a new <c>NoteRecord</c> and
  18966. Fill its data with the default values
  18967. </member>
  18968. <member name="M:NPOI.HSSF.Record.NoteRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18969. Constructs a <c>NoteRecord</c> and Fills its fields
  18970. from the supplied <c>RecordInputStream</c>.
  18971. @param in the stream to Read from
  18972. </member>
  18973. <member name="M:NPOI.HSSF.Record.NoteRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  18974. Serialize the record data into the supplied array of bytes
  18975. @param offset offset in the <c>data</c>
  18976. @param data the data to Serialize into
  18977. @return size of the record
  18978. </member>
  18979. <member name="M:NPOI.HSSF.Record.NoteRecord.ToString">
  18980. Convert this record to string.
  18981. Used by BiffViewer and other utulities.
  18982. </member>
  18983. <member name="P:NPOI.HSSF.Record.NoteRecord.Sid">
  18984. @return id of this record.
  18985. </member>
  18986. <member name="P:NPOI.HSSF.Record.NoteRecord.DataSize">
  18987. Size of record
  18988. </member>
  18989. <member name="P:NPOI.HSSF.Record.NoteRecord.Row">
  18990. Return the row that Contains the comment
  18991. @return the row that Contains the comment
  18992. </member>
  18993. <member name="P:NPOI.HSSF.Record.NoteRecord.Column">
  18994. Return the column that Contains the comment
  18995. @return the column that Contains the comment
  18996. </member>
  18997. <member name="P:NPOI.HSSF.Record.NoteRecord.Flags">
  18998. Options flags.
  18999. @return the options flag
  19000. @see #NOTE_VISIBLE
  19001. @see #NOTE_HIDDEN
  19002. </member>
  19003. <member name="P:NPOI.HSSF.Record.NoteRecord.ShapeId">
  19004. Object id for OBJ record that Contains the comment
  19005. </member>
  19006. <member name="P:NPOI.HSSF.Record.NoteRecord.Author">
  19007. Name of the original comment author
  19008. @return the name of the original author of the comment
  19009. </member>
  19010. <member name="P:NPOI.HSSF.Record.NoteRecord.AuthorIsMultibyte">
  19011. For unit testing only!
  19012. </member>
  19013. <member name="T:NPOI.HSSF.Record.NumberRecord">
  19014. Contains a numeric cell value.
  19015. REFERENCE: PG 334 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19016. @author Andrew C. Oliver (acoliver at apache dot org)
  19017. @author Jason Height (jheight at chariot dot net dot au)
  19018. @version 2.0-pre
  19019. </member>
  19020. <member name="M:NPOI.HSSF.Record.NumberRecord.#ctor">
  19021. Creates new NumberRecord
  19022. </member>
  19023. <member name="M:NPOI.HSSF.Record.NumberRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19024. Constructs a Number record and Sets its fields appropriately.
  19025. @param in the RecordInputstream to Read the record from
  19026. </member>
  19027. <member name="P:NPOI.HSSF.Record.NumberRecord.Value">
  19028. Get the value for the cell
  19029. @return double representing the value
  19030. </member>
  19031. <member name="T:NPOI.HSSF.Record.ObjectProtectRecord">
  19032. Title: Object Protect Record
  19033. Description: Protect embedded object with the lamest "security" ever invented.
  19034. This record tells "I want to protect my objects" with lame security. It
  19035. appears in conjunction with the PASSWORD and PROTECT records as well as its
  19036. scenario protect cousin.
  19037. REFERENCE: PG 368 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19038. @author Andrew C. Oliver (acoliver at apache dot org)
  19039. </member>
  19040. <member name="M:NPOI.HSSF.Record.ObjectProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19041. Constructs a Protect record and Sets its fields appropriately.
  19042. @param in the RecordInputstream to Read the record from
  19043. </member>
  19044. <member name="P:NPOI.HSSF.Record.ObjectProtectRecord.Protect">
  19045. Get whether the sheet Is protected or not
  19046. @return whether to protect the sheet or not
  19047. </member>
  19048. <member name="T:NPOI.HSSF.Record.ObjRecord">
  19049. The obj record is used to hold various graphic objects and controls.
  19050. @author Glen Stampoultzis (glens at apache.org)
  19051. </member>
  19052. <member name="F:NPOI.HSSF.Record.ObjRecord._uninterpretedData">
  19053. used when POI has no idea what is going on
  19054. </member>
  19055. <member name="F:NPOI.HSSF.Record.ObjRecord._isPaddedToQuadByteMultiple">
  19056. Excel seems to tolerate padding to quad or double byte length
  19057. </member>
  19058. <member name="M:NPOI.HSSF.Record.ObjRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19059. Constructs a OBJ record and Sets its fields appropriately.
  19060. @param in the RecordInputstream to Read the record from
  19061. </member>
  19062. <member name="M:NPOI.HSSF.Record.ObjRecord.CanPaddingBeDiscarded(System.Byte[],System.Int32)">
  19063. Some XLS files have ObjRecords with nearly 8Kb of excessive padding. These were probably
  19064. written by a version of POI (around 3.1) which incorrectly interpreted the second short of
  19065. the ftLbs subrecord (0x1FEE) as a length, and read that many bytes as padding (other bugs
  19066. helped allow this to occur).
  19067. Excel reads files with this excessive padding OK, truncating the over-sized ObjRecord back
  19068. to the its proper size. POI does the same.
  19069. </member>
  19070. <member name="P:NPOI.HSSF.Record.ObjRecord.RecordSize">
  19071. Size of record (excluding 4 byte header)
  19072. </member>
  19073. <member name="T:NPOI.HSSF.Record.PaletteRecord">
  19074. PaletteRecord - Supports custom palettes.
  19075. @author Andrew C. Oliver (acoliver at apache dot org)
  19076. @author Brian Sanders (bsanders at risklabs dot com) - custom palette editing
  19077. @version 2.0-pre
  19078. </member>
  19079. <member name="F:NPOI.HSSF.Record.PaletteRecord.STANDARD_PALETTE_SIZE">
  19080. The standard size of an XLS palette
  19081. </member>
  19082. <member name="F:NPOI.HSSF.Record.PaletteRecord.FIRST_COLOR_INDEX">
  19083. The byte index of the first color
  19084. </member>
  19085. <member name="M:NPOI.HSSF.Record.PaletteRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19086. Constructs a PaletteRecord record and Sets its fields appropriately.
  19087. @param in the RecordInputstream to Read the record from
  19088. </member>
  19089. <member name="M:NPOI.HSSF.Record.PaletteRecord.ClearColors">
  19090. <summary>
  19091. Dangerous! Only call this if you intend to replace the colors!
  19092. </summary>
  19093. </member>
  19094. <member name="M:NPOI.HSSF.Record.PaletteRecord.GetColor(System.Int16)">
  19095. Returns the color value at a given index
  19096. @return the RGB triplet for the color, or null if the specified index
  19097. does not exist
  19098. </member>
  19099. <member name="M:NPOI.HSSF.Record.PaletteRecord.SetColor(System.Int16,System.Byte,System.Byte,System.Byte)">
  19100. Sets the color value at a given index
  19101. If the given index Is greater than the current last color index,
  19102. then black Is Inserted at every index required to make the palette continuous.
  19103. @param byteIndex the index to Set; if this index Is less than 0x8 or greater than
  19104. 0x40, then no modification Is made
  19105. </member>
  19106. <member name="M:NPOI.HSSF.Record.PaletteRecord.CreateDefaultPalette">
  19107. Creates the default palette as PaletteRecord binary data
  19108. @see org.apache.poi.hssf.model.Workbook#createPalette
  19109. </member>
  19110. <member name="T:NPOI.HSSF.Record.PColor">
  19111. PColor - element in the list of colors - consider it a "struct"
  19112. </member>
  19113. <member name="T:NPOI.HSSF.Record.PaneRecord">
  19114. * Describes the frozen and Unfozen panes.
  19115. * NOTE: This source Is automatically generated please do not modify this file. Either subclass or
  19116. * Remove the record in src/records/definitions.
  19117. * @author Glen Stampoultzis (glens at apache.org)
  19118. </member>
  19119. <member name="M:NPOI.HSSF.Record.PaneRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19120. Constructs a Pane record and Sets its fields appropriately.
  19121. @param in the RecordInputstream to Read the record from
  19122. </member>
  19123. <member name="P:NPOI.HSSF.Record.PaneRecord.X">
  19124. Get the x field for the Pane record.
  19125. </member>
  19126. <member name="P:NPOI.HSSF.Record.PaneRecord.Y">
  19127. Get the y field for the Pane record.
  19128. </member>
  19129. <member name="P:NPOI.HSSF.Record.PaneRecord.TopRow">
  19130. Get the top row field for the Pane record.
  19131. </member>
  19132. <member name="P:NPOI.HSSF.Record.PaneRecord.LeftColumn">
  19133. Get the left column field for the Pane record.
  19134. </member>
  19135. <member name="P:NPOI.HSSF.Record.PaneRecord.ActivePane">
  19136. Get the active pane field for the Pane record.
  19137. @return One of
  19138. ACTIVE_PANE_LOWER_RIGHT
  19139. ACTIVE_PANE_UPPER_RIGHT
  19140. ACTIVE_PANE_LOWER_LEFT
  19141. ACTIVE_PANE_UPPER_LEFT
  19142. </member>
  19143. <member name="T:NPOI.HSSF.Record.PasswordRecord">
  19144. Title: Password Record
  19145. Description: stores the encrypted password for a sheet or workbook (HSSF doesn't support encryption)
  19146. REFERENCE: PG 371 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19147. @author Andrew C. Oliver (acoliver at apache dot org)
  19148. @version 2.0-pre
  19149. </member>
  19150. <member name="M:NPOI.HSSF.Record.PasswordRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19151. Constructs a Password record and Sets its fields appropriately.
  19152. @param in the RecordInputstream to Read the record from
  19153. </member>
  19154. <member name="M:NPOI.HSSF.Record.PasswordRecord.Clone">
  19155. Clone this record.
  19156. </member>
  19157. <member name="P:NPOI.HSSF.Record.PasswordRecord.Password">
  19158. Get the password
  19159. @return short representing the password
  19160. </member>
  19161. <member name="T:NPOI.HSSF.Record.PasswordRev4Record">
  19162. Title: Protection Revision 4 password Record
  19163. Description: Stores the (2 byte??!!) encrypted password for a shared
  19164. workbook
  19165. REFERENCE: PG 374 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19166. @author Andrew C. Oliver (acoliver at apache dot org)
  19167. @version 2.0-pre
  19168. </member>
  19169. <member name="M:NPOI.HSSF.Record.PasswordRev4Record.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19170. Constructs a PasswordRev4 (PROT4REVPASS) record and Sets its fields appropriately.
  19171. @param in the RecordInputstream to Read the record from
  19172. </member>
  19173. <member name="M:NPOI.HSSF.Record.PasswordRev4Record.SetPassword(System.Int16)">
  19174. set the password
  19175. @param pw representing the password
  19176. </member>
  19177. <member name="T:NPOI.HSSF.Record.PivotTable.DataItemRecord">
  19178. SXDI - Data Item (0x00C5)<br/>
  19179. @author Patrick Cheng
  19180. </member>
  19181. <member name="T:NPOI.HSSF.Record.PivotTable.ExtendedPivotTableViewFieldsRecord">
  19182. SXVDEX - Extended PivotTable View Fields (0x0100)<br/>
  19183. @author Patrick Cheng
  19184. </member>
  19185. <member name="F:NPOI.HSSF.Record.PivotTable.ExtendedPivotTableViewFieldsRecord.STRING_NOT_PRESENT_LEN">
  19186. the value of the <c>cchSubName</c> field when the subName is not present
  19187. </member>
  19188. <member name="T:NPOI.HSSF.Record.PivotTable.PageItemRecord">
  19189. SXPI - Page Item (0x00B6)<br/>
  19190. @author Patrick Cheng
  19191. </member>
  19192. <member name="F:NPOI.HSSF.Record.PivotTable.PageItemRecord.FieldInfo._isxvi">
  19193. Index to the View Item SXVI(0x00B2) record
  19194. </member>
  19195. <member name="F:NPOI.HSSF.Record.PivotTable.PageItemRecord.FieldInfo._isxvd">
  19196. Index to the {@link ViewFieldsRecord} SXVD(0x00B1) record
  19197. </member>
  19198. <member name="F:NPOI.HSSF.Record.PivotTable.PageItemRecord.FieldInfo._idObj">
  19199. Object ID for the drop-down arrow
  19200. </member>
  19201. <member name="T:NPOI.HSSF.Record.PivotTable.StreamIDRecord">
  19202. SXIDSTM - Stream ID (0x00D5)<br/>
  19203. @author Patrick Cheng
  19204. </member>
  19205. <member name="T:NPOI.HSSF.Record.PivotTable.ViewDefinitionRecord">
  19206. SXVIEW - View Definition (0x00B0)<br/>
  19207. @author Patrick Cheng
  19208. </member>
  19209. <member name="T:NPOI.HSSF.Record.PivotTable.ViewFieldsRecord">
  19210. SXVD - View Fields (0x00B1)<br/>
  19211. @author Patrick Cheng
  19212. </member>
  19213. <member name="F:NPOI.HSSF.Record.PivotTable.ViewFieldsRecord.STRING_NOT_PRESENT_LEN">
  19214. the value of the <c>cchName</c> field when the name is not present
  19215. </member>
  19216. <member name="F:NPOI.HSSF.Record.PivotTable.ViewFieldsRecord.BASE_SIZE">
  19217. 5 shorts
  19218. </member>
  19219. <member name="T:NPOI.HSSF.Record.PivotTable.ViewFieldsRecord.Axis">
  19220. values for the {@link ViewFieldsRecord#sxaxis} field
  19221. </member>
  19222. <member name="T:NPOI.HSSF.Record.PivotTable.ViewSourceRecord">
  19223. SXVS - View Source (0x00E3)<br/>
  19224. @author Patrick Cheng
  19225. </member>
  19226. <member name="T:NPOI.HSSF.Record.PrecisionRecord">
  19227. Title: Precision Record
  19228. Description: defines whether to store with full precision or what's Displayed by the gui
  19229. (meaning have really screwed up and skewed figures or only think you do!)
  19230. REFERENCE: PG 372 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19231. @author Andrew C. Oliver (acoliver at apache dot org)
  19232. @version 2.0-pre
  19233. </member>
  19234. <member name="M:NPOI.HSSF.Record.PrecisionRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19235. Constructs a Precision record and Sets its fields appropriately.
  19236. @param in the RecordInputstream to Read the record from
  19237. </member>
  19238. <member name="P:NPOI.HSSF.Record.PrecisionRecord.FullPrecision">
  19239. Get whether to use full precision or just skew all you figures all to hell.
  19240. @return fullprecision - or not
  19241. </member>
  19242. <member name="T:NPOI.HSSF.Record.PrintGridlinesRecord">
  19243. Title: Print Gridlines Record
  19244. Description: whether to print the gridlines when you enjoy you spReadsheet on paper.
  19245. REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19246. @author Andrew C. Oliver (acoliver at apache dot org)
  19247. @author Jason Height (jheight at chariot dot net dot au)
  19248. @version 2.0-pre
  19249. </member>
  19250. <member name="M:NPOI.HSSF.Record.PrintGridlinesRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19251. Constructs a PrintGridlines record and Sets its fields appropriately.
  19252. @param in the RecordInputstream to Read the record from
  19253. </member>
  19254. <member name="P:NPOI.HSSF.Record.PrintGridlinesRecord.PrintGridlines">
  19255. Get whether or not to print the gridlines (and make your spReadsheet ugly)
  19256. @return make spReadsheet ugly - Y/N
  19257. </member>
  19258. <member name="T:NPOI.HSSF.Record.PrintHeadersRecord">
  19259. Title: Print Headers Record
  19260. Description: Whether or not to print the row/column headers when you
  19261. enjoy your spReadsheet in the physical form.
  19262. REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19263. @author Andrew C. Oliver (acoliver at apache dot org)
  19264. @author Jason Height (jheight at chariot dot net dot au)
  19265. @version 2.0-pre
  19266. </member>
  19267. <member name="M:NPOI.HSSF.Record.PrintHeadersRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19268. Constructs a PrintHeaders record and Sets its fields appropriately.
  19269. @param in the RecordInputstream to Read the record from
  19270. </member>
  19271. <member name="P:NPOI.HSSF.Record.PrintHeadersRecord.PrintHeaders">
  19272. <summary>
  19273. Get whether to print the headers - y/n
  19274. </summary>
  19275. <value><c>true</c> if [print headers]; otherwise, <c>false</c>.</value>
  19276. </member>
  19277. <member name="T:NPOI.HSSF.Record.PrintSetupRecord">
  19278. Title: Print Setup Record
  19279. Description: Stores print Setup options -- bogus for HSSF (and marked as such)
  19280. REFERENCE: PG 385 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19281. @author Andrew C. Oliver (acoliver at apache dot org)
  19282. @author Jason Height (jheight at chariot dot net dot au)
  19283. @version 2.0-pre
  19284. </member>
  19285. <member name="M:NPOI.HSSF.Record.PrintSetupRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19286. Constructs a PrintSetup (SetUP) record and Sets its fields appropriately.
  19287. @param in the RecordInputstream to Read the record from
  19288. </member>
  19289. <member name="T:NPOI.HSSF.Record.ProtectionRev4Record">
  19290. Title: Protection Revision 4 Record
  19291. Description: describes whether this is a protected shared/tracked workbook
  19292. ( HSSF does not support encryption because we don't feel like going to jail )
  19293. REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19294. @author Andrew C. Oliver (acoliver at apache dot org)
  19295. @version 2.0-pre
  19296. </member>
  19297. <member name="M:NPOI.HSSF.Record.ProtectionRev4Record.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19298. Constructs a ProtectionRev4 record and Sets its fields appropriately.
  19299. @param in the RecordInputstream to Read the record from
  19300. </member>
  19301. <member name="P:NPOI.HSSF.Record.ProtectionRev4Record.Protect">
  19302. Get whether the this is protected shared/tracked workbook or not
  19303. @return whether to protect the workbook or not
  19304. </member>
  19305. <member name="T:NPOI.HSSF.Record.ProtectRecord">
  19306. Title: Protect Record
  19307. Description: defines whether a sheet or workbook is protected (HSSF DOES NOT SUPPORT ENCRYPTION)
  19308. (kindly ask the US government to stop having arcane stupid encryption laws and we'll support it)
  19309. (after all terrorists will all use US-legal encrypton right??)
  19310. HSSF now supports the simple "protected" sheets (where they are not encrypted and open office et al
  19311. ignore the password record entirely).
  19312. REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19313. @author Andrew C. Oliver (acoliver at apache dot org)
  19314. </member>
  19315. <member name="M:NPOI.HSSF.Record.ProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19316. Constructs a Protect record and Sets its fields appropriately.
  19317. @param in the RecordInputstream to Read the record from
  19318. </member>
  19319. <member name="P:NPOI.HSSF.Record.ProtectRecord.Protect">
  19320. Get whether the sheet is protected or not
  19321. @return whether to protect the sheet or not
  19322. </member>
  19323. <member name="T:NPOI.HSSF.Record.RecalcIdRecord">
  19324. Title: Recalc Id Record
  19325. Description: This record Contains an ID that marks when a worksheet was last
  19326. recalculated. It's an optimization Excel uses to determine if it
  19327. needs to recalculate the spReadsheet when it's opened. So far, only
  19328. the two values <c>0xC1 0x01 0x00 0x00 0x80 0x38 0x01 0x00</c>
  19329. (do not recalculate) and <c>0xC1 0x01 0x00 0x00 0x60 0x69 0x01
  19330. 0x00</c> have been seen. If the field <c>isNeeded</c> Is
  19331. Set to false (default), then this record Is swallowed during the
  19332. serialization Process
  19333. REFERENCE: http://chicago.sourceforge.net/devel/docs/excel/biff8.html
  19334. @author Luc Girardin (luc dot girardin at macrofocus dot com)
  19335. @version 2.0-pre
  19336. @see org.apache.poi.hssf.model.Workbook
  19337. </member>
  19338. <member name="F:NPOI.HSSF.Record.RecalcIdRecord._engineId">
  19339. An unsigned integer that specifies the recalculation engine identifier
  19340. of the recalculation engine that performed the last recalculation.
  19341. If the value is less than the recalculation engine identifier associated with the application,
  19342. the application will recalculate the results of all formulas on
  19343. this workbook immediately after loading the file
  19344. </member>
  19345. <member name="M:NPOI.HSSF.Record.RecalcIdRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19346. Constructs a RECALCID record and Sets its fields appropriately.
  19347. @param in the RecordInputstream to Read the record from
  19348. </member>
  19349. <member name="T:NPOI.HSSF.Record.RecordFactory">
  19350. Title: Record Factory
  19351. Description: Takes a stream and outputs an array of Record objects.
  19352. @deprecated use {@link org.apache.poi.hssf.eventmodel.EventRecordFactory} instead
  19353. @see org.apache.poi.hssf.eventmodel.EventRecordFactory
  19354. @author Andrew C. Oliver (acoliver at apache dot org)
  19355. @author Marc Johnson (mjohnson at apache dot org)
  19356. @author Glen Stampoultzis (glens at apache.org)
  19357. @author Csaba Nagy (ncsaba at yahoo dot com)
  19358. </member>
  19359. <member name="F:NPOI.HSSF.Record.RecordFactory._recordCreatorsById">
  19360. cache of the recordsToMap();
  19361. </member>
  19362. <member name="M:NPOI.HSSF.Record.RecordFactory.GetRecordClass(System.Int32)">
  19363. Debug / diagnosis method<br/>
  19364. Gets the POI implementation class for a given <tt>sid</tt>. Only a subset of the any BIFF
  19365. records are actually interpreted by POI. A few others are known but not interpreted
  19366. (see {@link UnknownRecord#getBiffName(int)}).
  19367. @return the POI implementation class for the specified record <tt>sid</tt>.
  19368. <code>null</code> if the specified record is not interpreted by POI.
  19369. </member>
  19370. <member name="M:NPOI.HSSF.Record.RecordFactory.SetCapacity(System.Int32)">
  19371. Changes the default capacity (10000) to handle larger files
  19372. </member>
  19373. <member name="M:NPOI.HSSF.Record.RecordFactory.CreateRecords(System.IO.Stream)">
  19374. Create an array of records from an input stream
  19375. @param in the InputStream from which the records will be
  19376. obtained
  19377. @return an array of Records Created from the InputStream
  19378. @exception RecordFormatException on error Processing the
  19379. InputStream
  19380. </member>
  19381. <member name="M:NPOI.HSSF.Record.RecordFactory.ConvertBlankRecords(NPOI.HSSF.Record.MulBlankRecord)">
  19382. Converts a {@link MulBlankRecord} into an equivalent array of {@link BlankRecord}s
  19383. </member>
  19384. <member name="M:NPOI.HSSF.Record.RecordFactory.ConvertToNumberRecord(NPOI.HSSF.Record.RKRecord)">
  19385. <summary>
  19386. RK record is a slightly smaller alternative to NumberRecord
  19387. POI likes NumberRecord better
  19388. </summary>
  19389. <param name="rk">The rk.</param>
  19390. <returns></returns>
  19391. </member>
  19392. <member name="M:NPOI.HSSF.Record.RecordFactory.ConvertRKRecords(NPOI.HSSF.Record.MulRKRecord)">
  19393. <summary>
  19394. Converts a MulRKRecord into an equivalent array of NumberRecords
  19395. </summary>
  19396. <param name="mrk">The MRK.</param>
  19397. <returns></returns>
  19398. </member>
  19399. <member name="T:NPOI.HSSF.Record.RecordFactory.ReflectionMethodRecordCreator">
  19400. A "create" method is used instead of the usual constructor if the created record might
  19401. be of a different class to the declaring class.
  19402. </member>
  19403. <member name="T:NPOI.HSSF.Record.RecordFactoryInputStream">
  19404. A stream based way to get at complete records, with
  19405. as low a memory footprint as possible.
  19406. This handles Reading from a RecordInputStream, turning
  19407. the data into full records, processing continue records
  19408. etc.
  19409. Most users should use {@link HSSFEventFactory} /
  19410. {@link HSSFListener} and have new records pushed to
  19411. them, but this does allow for a "pull" style of coding.
  19412. </member>
  19413. <member name="F:NPOI.HSSF.Record.RecordFactoryInputStream._unreadRecordBuffer">
  19414. Temporarily stores a group of {@link Record}s, for future return by {@link #nextRecord()}.
  19415. This is used at the start of the workbook stream, and also when the most recently read
  19416. underlying record is a {@link MulRKRecord}
  19417. </member>
  19418. <member name="F:NPOI.HSSF.Record.RecordFactoryInputStream._unreadRecordIndex">
  19419. used to help iterating over the unread records
  19420. </member>
  19421. <member name="F:NPOI.HSSF.Record.RecordFactoryInputStream._lastRecord">
  19422. The most recent record that we gave to the user
  19423. </member>
  19424. <member name="F:NPOI.HSSF.Record.RecordFactoryInputStream._lastDrawingRecord">
  19425. The most recent DrawingRecord seen
  19426. </member>
  19427. <member name="M:NPOI.HSSF.Record.RecordFactoryInputStream.#ctor(System.IO.Stream,System.Boolean)">
  19428. @param shouldIncludeContinueRecords caller can pass <c>false</c> if loose
  19429. {@link ContinueRecord}s should be skipped (this is sometimes useful in event based
  19430. processing).
  19431. </member>
  19432. <member name="M:NPOI.HSSF.Record.RecordFactoryInputStream.NextRecord">
  19433. Returns the next (complete) record from the
  19434. stream, or null if there are no more.
  19435. </member>
  19436. <member name="M:NPOI.HSSF.Record.RecordFactoryInputStream.GetNextUnreadRecord">
  19437. @return the next {@link Record} from the multiple record group as expanded from
  19438. a recently read {@link MulRKRecord}. <code>null</code> if not present.
  19439. </member>
  19440. <member name="M:NPOI.HSSF.Record.RecordFactoryInputStream.ReadNextRecord">
  19441. @return the next available record, or <code>null</code> if
  19442. this pass didn't return a record that's
  19443. suitable for returning (eg was a continue record).
  19444. </member>
  19445. <member name="T:NPOI.HSSF.Record.RecordFactoryInputStream.StreamEncryptionInfo">
  19446. Keeps track of the sizes of the Initial records up to and including {@link FilePassRecord}
  19447. Needed for protected files because each byte is encrypted with respect to its absolute
  19448. position from the start of the stream.
  19449. </member>
  19450. <member name="P:NPOI.HSSF.Record.RecordFactoryInputStream.StreamEncryptionInfo.LastRecord">
  19451. @return last record scanned while looking for encryption info.
  19452. This will typically be the first or second record Read. Possibly <code>null</code>
  19453. if stream was empty
  19454. </member>
  19455. <member name="P:NPOI.HSSF.Record.RecordFactoryInputStream.StreamEncryptionInfo.HasBOFRecord">
  19456. <c>false</c> in some test cases
  19457. </member>
  19458. <member name="T:NPOI.HSSF.Record.RecordInputStream">
  19459. Title: Record Input Stream
  19460. Description: Wraps a stream and provides helper methods for the construction of records.
  19461. @author Jason Height (jheight @ apache dot org)
  19462. </member>
  19463. <member name="F:NPOI.HSSF.Record.RecordInputStream.MAX_RECORD_DATA_SIZE">
  19464. Maximum size of a single record (minus the 4 byte header) without a continue
  19465. </member>
  19466. <member name="F:NPOI.HSSF.Record.RecordInputStream._bhi">
  19467. Header {@link LittleEndianInput} facet of the wrapped {@link InputStream}
  19468. </member>
  19469. <member name="F:NPOI.HSSF.Record.RecordInputStream._dataInput">
  19470. Data {@link LittleEndianInput} facet of the wrapped {@link InputStream}
  19471. </member>
  19472. <member name="M:NPOI.HSSF.Record.RecordInputStream.#ctor(System.IO.Stream)">
  19473. the record identifier of the BIFF record currently being read
  19474. </member>
  19475. <member name="M:NPOI.HSSF.Record.RecordInputStream.Read">
  19476. This method will Read a byte from the current record
  19477. </member>
  19478. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadNextSid">
  19479. @return the sid of the next record or {@link #INVALID_SID_VALUE} if at end of stream
  19480. </member>
  19481. <member name="M:NPOI.HSSF.Record.RecordInputStream.NextRecord">
  19482. Moves to the next record in the stream.
  19483. <i>Note: The auto continue flag is Reset to true</i>
  19484. </member>
  19485. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadByte">
  19486. Reads an 8 bit, signed value
  19487. </member>
  19488. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadShort">
  19489. Reads a 16 bit, signed value
  19490. </member>
  19491. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadUByte">
  19492. Reads an 8 bit, Unsigned value
  19493. </member>
  19494. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadUShort">
  19495. Reads a 16 bit,un- signed value.
  19496. @return
  19497. </member>
  19498. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadUnicodeLEString(System.Int32)">
  19499. given a byte array of 16-bit Unicode Chars, compress to 8-bit and
  19500. return a string
  19501. { 0x16, 0x00 } -0x16
  19502. @param Length the Length of the string
  19503. @return the Converted string
  19504. @exception ArgumentException if len is too large (i.e.,
  19505. there is not enough data in string to Create a String of that
  19506. Length)
  19507. </member>
  19508. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadRemainder">
  19509. Returns the remaining bytes for the current record.
  19510. @return The remaining bytes of the current record.
  19511. </member>
  19512. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadAllContinuedRemainder">
  19513. Reads all byte data for the current record, including any
  19514. that overlaps into any following continue records.
  19515. @deprecated Best to write a input stream that wraps this one where there Is
  19516. special sub record that may overlap continue records.
  19517. </member>
  19518. <member name="M:NPOI.HSSF.Record.RecordInputStream.GetNextSid">
  19519. @return sid of next record. Can be called after hasNextRecord()
  19520. </member>
  19521. <member name="P:NPOI.HSSF.Record.RecordInputStream.Remaining">
  19522. The remaining number of bytes in the <i>current</i> record.
  19523. @return The number of bytes remaining in the current record
  19524. </member>
  19525. <member name="P:NPOI.HSSF.Record.RecordInputStream.IsContinueNext">
  19526. Returns true iif a Continue record is next in the excel stream _currentDataOffset
  19527. @return True when a ContinueRecord is next.
  19528. </member>
  19529. <member name="T:NPOI.HSSF.Record.RefModeRecord">
  19530. Title: RefMode Record
  19531. Description: Describes which reference mode to use
  19532. REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19533. @author Andrew C. Oliver (acoliver at apache dot org)
  19534. @author Jason Height (jheight at chariot dot net dot au)
  19535. @version 2.0-pre
  19536. </member>
  19537. <member name="M:NPOI.HSSF.Record.RefModeRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19538. Constructs a RefMode record and Sets its fields appropriately.
  19539. @param in the RecordInputstream to Read the record from
  19540. </member>
  19541. <member name="P:NPOI.HSSF.Record.RefModeRecord.Mode">
  19542. Get the reference mode to use (HSSF uses/assumes A1)
  19543. @return mode to use
  19544. @see #USE_A1_MODE
  19545. @see #USE_R1C1_MODE
  19546. </member>
  19547. <member name="T:NPOI.HSSF.Record.RefreshAllRecord">
  19548. Title: Refresh All Record
  19549. Description: Flag whether to refresh all external data when loading a sheet.
  19550. (which hssf doesn't support anyhow so who really cares?)
  19551. REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19552. @author Andrew C. Oliver (acoliver at apache dot org)
  19553. @version 2.0-pre
  19554. </member>
  19555. <member name="M:NPOI.HSSF.Record.RefreshAllRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19556. Constructs a RefreshAll record and Sets its fields appropriately.
  19557. @param in the RecordInputstream to Read the record from
  19558. </member>
  19559. <member name="P:NPOI.HSSF.Record.RefreshAllRecord.RefreshAll">
  19560. Get whether to refresh all external data when loading a sheet
  19561. @return refreshall or not
  19562. </member>
  19563. <member name="T:NPOI.HSSF.Record.RightMarginRecord">
  19564. Record for the right margin. * NOTE: This source was automatically generated. * @author Shawn Laubach (slaubach at apache dot org)
  19565. </member>
  19566. <member name="M:NPOI.HSSF.Record.RightMarginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19567. Constructs a RightMargin record and Sets its fields appropriately. * * @param id id must be 0x27 or an exception * will be throw upon validation * @param size size the size of the data area of the record * @param data data of the record (should not contain sid/len)
  19568. </member>
  19569. <member name="P:NPOI.HSSF.Record.RightMarginRecord.Margin">
  19570. Get the margin field for the RightMargin record.
  19571. </member>
  19572. <member name="T:NPOI.HSSF.Record.RKRecord">
  19573. Title: RK Record
  19574. Description: An internal 32 bit number with the two most significant bits
  19575. storing the type. This is part of a bizarre scheme to save disk
  19576. space and memory (gee look at all the other whole records that
  19577. are in the file just "cause"..,far better to waste Processor
  19578. cycles on this then leave on of those "valuable" records out).
  19579. We support this in Read-ONLY mode. HSSF Converts these to NUMBER records
  19580. REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19581. @author Andrew C. Oliver (acoliver at apache dot org)
  19582. @author Jason Height (jheight at chariot dot net dot au)
  19583. @version 2.0-pre
  19584. @see org.apache.poi.hssf.record.NumberRecord
  19585. </member>
  19586. <member name="M:NPOI.HSSF.Record.RKRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19587. Constructs a RK record and Sets its fields appropriately.
  19588. @param in the RecordInputstream to Read the record from
  19589. </member>
  19590. <member name="P:NPOI.HSSF.Record.RKRecord.RKType">
  19591. Get the type of the number
  19592. @return one of these values:
  19593. <OL START="0">
  19594. <LI>RK_IEEE_NUMBER</LI>
  19595. <LI>RK_IEEE_NUMBER_TIMES_100</LI>
  19596. <LI>RK_INTEGER</LI>
  19597. <LI>RK_INTEGER_TIMES_100</LI>
  19598. </OL>
  19599. </member>
  19600. <member name="P:NPOI.HSSF.Record.RKRecord.RKNumber">
  19601. Extract the value of the number
  19602. The mechanism for determining the value is dependent on the two
  19603. low order bits of the raw number. If bit 1 is Set, the number
  19604. is an integer and can be cast directly as a double, otherwise,
  19605. it's apparently the exponent and mantissa of a double (and the
  19606. remaining low-order bits of the double's mantissa are 0's).
  19607. If bit 0 is Set, the result of the conversion to a double Is
  19608. divided by 100; otherwise, the value is left alone.
  19609. [Insert picture of Screwy Squirrel in full Napoleonic regalia]
  19610. @return the value as a proper double (hey, it <B>could</B>
  19611. happen)
  19612. </member>
  19613. <member name="T:NPOI.HSSF.Record.RowRecord">
  19614. Title: Row Record
  19615. Description: stores the row information for the sheet.
  19616. REFERENCE: PG 379 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19617. @author Andrew C. Oliver (acoliver at apache dot org)
  19618. @author Jason Height (jheight at chariot dot net dot au)
  19619. @version 2.0-pre
  19620. </member>
  19621. <member name="F:NPOI.HSSF.Record.RowRecord.MAX_ROW_NUMBER">
  19622. The maximum row number that excel can handle (zero based) ie 65536 rows Is
  19623. max number of rows.
  19624. </member>
  19625. <member name="F:NPOI.HSSF.Record.RowRecord.field_7_option_flags">
  19626. 16 bit options flags
  19627. </member>
  19628. <member name="M:NPOI.HSSF.Record.RowRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19629. Constructs a Row record and Sets its fields appropriately.
  19630. @param in the RecordInputstream to Read the record from
  19631. </member>
  19632. <member name="P:NPOI.HSSF.Record.RowRecord.IsEmpty">
  19633. Get the logical row number for this row (0 based index)
  19634. @return row - the row number
  19635. </member>
  19636. <member name="P:NPOI.HSSF.Record.RowRecord.FirstCol">
  19637. Get the logical col number for the first cell this row (0 based index)
  19638. @return col - the col number
  19639. </member>
  19640. <member name="P:NPOI.HSSF.Record.RowRecord.LastCol">
  19641. Get the logical col number for the last cell this row plus one (0 based index)
  19642. @return col - the last col number + 1
  19643. </member>
  19644. <member name="P:NPOI.HSSF.Record.RowRecord.Height">
  19645. Get the height of the row
  19646. @return height of the row
  19647. </member>
  19648. <member name="P:NPOI.HSSF.Record.RowRecord.Optimize">
  19649. Get whether to optimize or not (Set to 0)
  19650. @return optimize (Set to 0)
  19651. </member>
  19652. <member name="P:NPOI.HSSF.Record.RowRecord.OptionFlags">
  19653. Gets the option bitmask. (use the individual bit Setters that refer to this
  19654. method)
  19655. @return options - the bitmask
  19656. </member>
  19657. <member name="P:NPOI.HSSF.Record.RowRecord.OutlineLevel">
  19658. Get the outline level of this row
  19659. @return ol - the outline level
  19660. @see #GetOptionFlags()
  19661. </member>
  19662. <member name="P:NPOI.HSSF.Record.RowRecord.Colapsed">
  19663. Get whether or not to colapse this row
  19664. @return c - colapse or not
  19665. @see #GetOptionFlags()
  19666. </member>
  19667. <member name="P:NPOI.HSSF.Record.RowRecord.ZeroHeight">
  19668. Get whether or not to Display this row with 0 height
  19669. @return - z height is zero or not.
  19670. @see #GetOptionFlags()
  19671. </member>
  19672. <member name="P:NPOI.HSSF.Record.RowRecord.BadFontHeight">
  19673. Get whether the font and row height are not compatible
  19674. @return - f -true if they aren't compatible (damn not logic)
  19675. @see #GetOptionFlags()
  19676. </member>
  19677. <member name="P:NPOI.HSSF.Record.RowRecord.Formatted">
  19678. Get whether the row has been formatted (even if its got all blank cells)
  19679. @return formatted or not
  19680. @see #GetOptionFlags()
  19681. </member>
  19682. <member name="P:NPOI.HSSF.Record.RowRecord.XFIndex">
  19683. if the row is formatted then this is the index to the extended format record
  19684. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  19685. @return index to the XF record or bogus value (undefined) if Isn't formatted
  19686. </member>
  19687. <member name="P:NPOI.HSSF.Record.RowRecord.TopBorder">
  19688. bit that specifies whether any cell in the row has a thick top border, or any
  19689. cell in the row directly above the current row has a thick bottom border.
  19690. @param f has thick top border
  19691. </member>
  19692. <member name="P:NPOI.HSSF.Record.RowRecord.BottomBorder">
  19693. A bit that specifies whether any cell in the row has a medium or thick
  19694. bottom border, or any cell in the row directly below the current row has
  19695. a medium or thick top border.
  19696. @param f has thick bottom border
  19697. </member>
  19698. <member name="P:NPOI.HSSF.Record.RowRecord.PhoeneticGuide">
  19699. A bit that specifies whether the phonetic guide feature is enabled for
  19700. any cell in this row.
  19701. @param f use phoenetic guide
  19702. </member>
  19703. <member name="T:NPOI.HSSF.Record.SaveRecalcRecord">
  19704. Title: Save Recalc Record
  19705. Description: defines whether to recalculate before saving (Set to true)
  19706. REFERENCE: PG 381 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19707. @author Andrew C. Oliver (acoliver at apache dot org)
  19708. @author Jason Height (jheight at chariot dot net dot au)
  19709. @version 2.0-pre
  19710. </member>
  19711. <member name="M:NPOI.HSSF.Record.SaveRecalcRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19712. Constructs an SaveRecalc record and Sets its fields appropriately.
  19713. @param in the RecordInputstream to Read the record from
  19714. </member>
  19715. <member name="P:NPOI.HSSF.Record.SaveRecalcRecord.Recalc">
  19716. Get whether to recalculate formulas/etc before saving or not
  19717. @return recalc - whether to recalculate or not
  19718. </member>
  19719. <member name="T:NPOI.HSSF.Record.ScenarioProtectRecord">
  19720. Title: Scenario Protect Record
  19721. Description: I have no idea what a Scenario is or why on would want to
  19722. protect it with the lamest "security" ever invented. However this record tells
  19723. excel "I want to protect my scenarios" (0xAF) with lame security. It appears
  19724. in conjunction with the PASSWORD and PROTECT records as well as its object
  19725. protect cousin.
  19726. REFERENCE: PG 383 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19727. @author Andrew C. Oliver (acoliver at apache dot org)
  19728. </member>
  19729. <member name="M:NPOI.HSSF.Record.ScenarioProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19730. Constructs a Protect record and Sets its fields appropriately.
  19731. @param in the RecordInputstream to Read the record from
  19732. </member>
  19733. <member name="P:NPOI.HSSF.Record.ScenarioProtectRecord.Protect">
  19734. Get whether the sheet is protected or not
  19735. @return whether to protect the sheet or not
  19736. </member>
  19737. <member name="T:NPOI.HSSF.Record.SCLRecord">
  19738. * Specifies the window's zoom magnification. If this record Isn't present then the windows zoom is 100%. see p384 Excel Dev Kit
  19739. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  19740. * Remove the record in src/records/definitions.
  19741. * @author Andrew C. Oliver (acoliver at apache.org)
  19742. </member>
  19743. <member name="M:NPOI.HSSF.Record.SCLRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19744. Constructs a SCL record and Sets its fields appropriately.
  19745. @param in the RecordInputstream to Read the record from
  19746. </member>
  19747. <member name="P:NPOI.HSSF.Record.SCLRecord.DataSize">
  19748. Size of record (exluding 4 byte header)
  19749. </member>
  19750. <member name="P:NPOI.HSSF.Record.SCLRecord.Numerator">
  19751. Get the numerator field for the SCL record.
  19752. </member>
  19753. <member name="P:NPOI.HSSF.Record.SCLRecord.Denominator">
  19754. Get the denominator field for the SCL record.
  19755. </member>
  19756. <member name="T:NPOI.HSSF.Record.SelectionRecord">
  19757. Title: Selection Record
  19758. Description: shows the user's selection on the sheet
  19759. for Write Set num refs to 0
  19760. TODO : Fully implement reference subrecords.
  19761. REFERENCE: PG 291 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19762. @author Andrew C. Oliver (acoliver at apache dot org)
  19763. @author Jason Height (jheight at chariot dot net dot au)
  19764. @author Glen Stampoultzis (glens at apache.org)
  19765. </member>
  19766. <member name="M:NPOI.HSSF.Record.SelectionRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19767. <summary>
  19768. Constructs a Selection record and Sets its fields appropriately.
  19769. </summary>
  19770. <param name="in1">the RecordInputstream to Read the record from</param>
  19771. </member>
  19772. <member name="P:NPOI.HSSF.Record.SelectionRecord.Pane">
  19773. <summary>
  19774. Gets or sets the pane this is for.
  19775. </summary>
  19776. <value>The pane.</value>
  19777. </member>
  19778. <member name="P:NPOI.HSSF.Record.SelectionRecord.ActiveCellRow">
  19779. <summary>
  19780. Gets or sets the active cell row.
  19781. </summary>
  19782. <value>row number of active cell</value>
  19783. </member>
  19784. <member name="P:NPOI.HSSF.Record.SelectionRecord.ActiveCellCol">
  19785. <summary>
  19786. Gets or sets the active cell's col
  19787. </summary>
  19788. <value>number of active cell</value>
  19789. </member>
  19790. <member name="P:NPOI.HSSF.Record.SelectionRecord.ActiveCellRef">
  19791. <summary>
  19792. Gets or sets the active cell's reference number
  19793. </summary>
  19794. <value>ref number of active cell</value>
  19795. </member>
  19796. <member name="T:NPOI.HSSF.Record.SharedFormulaRecord">
  19797. Title: SharedFormulaRecord
  19798. Description: Primarily used as an excel optimization so that multiple similar formulas
  19799. are not written out too many times. We should recognize this record and
  19800. Serialize as Is since this Is used when Reading templates.
  19801. Note: the documentation says that the SID Is BC where biffviewer reports 4BC. The hex dump shows
  19802. that the two byte sid representation to be 'BC 04' that Is consistent with the other high byte
  19803. record types.
  19804. @author Danny Mui at apache dot org
  19805. </member>
  19806. <member name="M:NPOI.HSSF.Record.SharedFormulaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19807. @param in the RecordInputstream to Read the record from
  19808. </member>
  19809. <member name="M:NPOI.HSSF.Record.SharedFormulaRecord.ToString">
  19810. print a sort of string representation ([SHARED FORMULA RECORD] id = x [/SHARED FORMULA RECORD])
  19811. </member>
  19812. <member name="M:NPOI.HSSF.Record.SharedFormulaRecord.GetFormulaTokens(NPOI.HSSF.Record.FormulaRecord)">
  19813. @return the equivalent {@link Ptg} array that the formula would have, were it not shared.
  19814. </member>
  19815. <member name="T:NPOI.HSSF.Record.SSTDeserializer">
  19816. Handles the task of deserializing a SST string. The two main entry points are
  19817. @author Glen Stampoultzis (glens at apache.org)
  19818. @author Jason Height (jheight at apache.org)
  19819. </member>
  19820. <member name="M:NPOI.HSSF.Record.SSTDeserializer.ManufactureStrings(System.Int32,NPOI.HSSF.Record.RecordInputStream)">
  19821. This Is the starting point where strings are constructed. Note that
  19822. strings may span across multiple continuations. Read the SST record
  19823. carefully before beginning to hack.
  19824. </member>
  19825. <member name="T:NPOI.HSSF.Record.SSTRecord">
  19826. Title: Static String Table Record
  19827. Description: This holds all the strings for LabelSSTRecords.
  19828. REFERENCE: PG 389 Microsoft Excel 97 Developer's Kit (ISBN:
  19829. 1-57231-498-2)
  19830. @author Andrew C. Oliver (acoliver at apache dot org)
  19831. @author Marc Johnson (mjohnson at apache dot org)
  19832. @author Glen Stampoultzis (glens at apache.org)
  19833. @see org.apache.poi.hssf.record.LabelSSTRecord
  19834. @see org.apache.poi.hssf.record.ContinueRecord
  19835. </member>
  19836. <member name="F:NPOI.HSSF.Record.SSTRecord.MAX_RECORD_SIZE">
  19837. how big can an SST record be? As big as any record can be: 8228 bytes
  19838. </member>
  19839. <member name="F:NPOI.HSSF.Record.SSTRecord.STD_RECORD_OVERHEAD">
  19840. standard record overhead: two shorts (record id plus data space size)
  19841. </member>
  19842. <member name="F:NPOI.HSSF.Record.SSTRecord.SST_RECORD_OVERHEAD">
  19843. SST overhead: the standard record overhead, plus the number of strings and the number of Unique strings -- two ints
  19844. </member>
  19845. <member name="F:NPOI.HSSF.Record.SSTRecord.MAX_DATA_SPACE">
  19846. how much data can we stuff into an SST record? That would be _max minus the standard SST record overhead
  19847. </member>
  19848. <member name="F:NPOI.HSSF.Record.SSTRecord.field_1_num_strings">
  19849. Union of strings in the SST and EXTSST
  19850. </member>
  19851. <member name="F:NPOI.HSSF.Record.SSTRecord.field_2_num_unique_strings">
  19852. according to docs ONLY SST
  19853. </member>
  19854. <member name="F:NPOI.HSSF.Record.SSTRecord.bucketAbsoluteOffsets">
  19855. Offsets from the beginning of the SST record (even across continuations)
  19856. </member>
  19857. <member name="F:NPOI.HSSF.Record.SSTRecord.bucketRelativeOffsets">
  19858. Offsets relative the start of the current SST or continue record
  19859. </member>
  19860. <member name="M:NPOI.HSSF.Record.SSTRecord.#ctor">
  19861. default constructor
  19862. </member>
  19863. <member name="M:NPOI.HSSF.Record.SSTRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19864. Constructs an SST record and Sets its fields appropriately.
  19865. @param in the RecordInputstream to Read the record from
  19866. </member>
  19867. <member name="M:NPOI.HSSF.Record.SSTRecord.AddString(NPOI.HSSF.Record.UnicodeString)">
  19868. Add a string.
  19869. @param string string to be Added
  19870. @return the index of that string in the table
  19871. </member>
  19872. <member name="M:NPOI.HSSF.Record.SSTRecord.GetString(System.Int32)">
  19873. Get a particular string by its index
  19874. @param id index into the array of strings
  19875. @return the desired string
  19876. </member>
  19877. <member name="M:NPOI.HSSF.Record.SSTRecord.ToString">
  19878. Return a debugging string representation
  19879. @return string representation
  19880. </member>
  19881. <member name="M:NPOI.HSSF.Record.SSTRecord.GetHashCode">
  19882. @return hashcode
  19883. </member>
  19884. <member name="M:NPOI.HSSF.Record.SSTRecord.GetStrings">
  19885. @return an iterator of the strings we hold. All instances are
  19886. UnicodeStrings
  19887. </member>
  19888. <member name="M:NPOI.HSSF.Record.SSTRecord.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  19889. called by the class that Is responsible for writing this sucker.
  19890. Subclasses should implement this so that their data Is passed back in a
  19891. byte array.
  19892. @return size
  19893. </member>
  19894. <member name="M:NPOI.HSSF.Record.SSTRecord.CreateExtSSTRecord(System.Int32)">
  19895. Creates an extended string record based on the current contents of
  19896. the current SST record. The offset within the stream to the SST record
  19897. Is required because the extended string record points directly to the
  19898. strings in the SST record.
  19899. NOTE: THIS FUNCTION MUST ONLY BE CALLED AFTER THE SST RECORD HAS BEEN
  19900. SERIALIZED.
  19901. @param sstOffset The offset in the stream to the start of the
  19902. SST record.
  19903. @return The new SST record.
  19904. </member>
  19905. <member name="M:NPOI.HSSF.Record.SSTRecord.CalcExtSSTRecordSize">
  19906. Calculates the size in bytes of the EXTSST record as it would be if the
  19907. record was Serialized.
  19908. @return The size of the ExtSST record in bytes.
  19909. </member>
  19910. <member name="P:NPOI.HSSF.Record.SSTRecord.NumStrings">
  19911. @return number of strings
  19912. </member>
  19913. <member name="P:NPOI.HSSF.Record.SSTRecord.NumUniqueStrings">
  19914. @return number of Unique strings
  19915. </member>
  19916. <member name="P:NPOI.HSSF.Record.SSTRecord.Sid">
  19917. @return sid
  19918. </member>
  19919. <member name="P:NPOI.HSSF.Record.SSTRecord.CountStrings">
  19920. @return count of the strings we hold.
  19921. </member>
  19922. <member name="T:NPOI.HSSF.Record.SSTSerializer">
  19923. This class handles serialization of SST records. It utilizes the record processor
  19924. class write individual records. This has been refactored from the SSTRecord class.
  19925. @author Glen Stampoultzis (glens at apache.org)
  19926. </member>
  19927. <member name="F:NPOI.HSSF.Record.SSTSerializer.bucketAbsoluteOffsets">
  19928. OffSets from the beginning of the SST record (even across continuations)
  19929. </member>
  19930. <member name="F:NPOI.HSSF.Record.SSTSerializer.bucketRelativeOffsets">
  19931. OffSets relative the start of the current SST or continue record
  19932. </member>
  19933. <member name="T:NPOI.HSSF.Record.StringRecord">
  19934. Supports the STRING record structure.
  19935. @author Glen Stampoultzis (glens at apache.org)
  19936. </member>
  19937. <member name="M:NPOI.HSSF.Record.StringRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19938. Constructs a String record and Sets its fields appropriately.
  19939. @param in the RecordInputstream to Read the record from
  19940. </member>
  19941. <member name="M:NPOI.HSSF.Record.StringRecord.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  19942. called by the class that Is responsible for writing this sucker.
  19943. Subclasses should implement this so that their data Is passed back in a
  19944. byte array.
  19945. @param offset to begin writing at
  19946. @param data byte array containing instance data
  19947. @return number of bytes written
  19948. </member>
  19949. <member name="P:NPOI.HSSF.Record.StringRecord.Sid">
  19950. return the non static version of the id for this record.
  19951. </member>
  19952. <member name="P:NPOI.HSSF.Record.StringRecord.String">
  19953. @return The string represented by this record.
  19954. </member>
  19955. <member name="T:NPOI.HSSF.Record.StyleRecord">
  19956. Title: Style Record
  19957. Description: Describes a builtin to the gui or user defined style
  19958. REFERENCE: PG 390 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19959. @author Andrew C. Oliver (acoliver at apache dot org)
  19960. @author aviks : string fixes for UserDefined Style
  19961. @version 2.0-pre
  19962. </member>
  19963. <member name="M:NPOI.HSSF.Record.StyleRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19964. Constructs a Style record and Sets its fields appropriately.
  19965. @param in the RecordInputstream to Read the record from
  19966. </member>
  19967. <member name="M:NPOI.HSSF.Record.StyleRecord.SetBuiltinStyle(System.Int32)">
  19968. if this is a builtin style set the number of the built in style
  19969. @param builtinStyleId style number (0-7)
  19970. </member>
  19971. <member name="P:NPOI.HSSF.Record.StyleRecord.XFIndex">
  19972. Get the actual index of the style extended format record
  19973. @see #Index
  19974. @return index of the xf record
  19975. </member>
  19976. <member name="P:NPOI.HSSF.Record.StyleRecord.Name">
  19977. Get the style's name
  19978. @return name of the style
  19979. @see #NameLength
  19980. </member>
  19981. <member name="P:NPOI.HSSF.Record.StyleRecord.OutlineStyleLevel">
  19982. Get the row or column level of the style (if builtin 1||2)
  19983. </member>
  19984. <member name="T:NPOI.HSSF.Record.CommonObjectType">
  19985. * The common object data record is used to store all common preferences for an excel object.
  19986. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  19987. * Remove the record in src/records/definitions.
  19988. * @author Glen Stampoultzis (glens at apache.org)
  19989. </member>
  19990. <member name="M:NPOI.HSSF.Record.CommonObjectDataSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  19991. Constructs a CommonObjectData record and Sets its fields appropriately.
  19992. @param in the RecordInputstream to Read the record from
  19993. </member>
  19994. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.DataSize">
  19995. Size of record (exluding 4 byte header)
  19996. </member>
  19997. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.ObjectType">
  19998. Get the object type field for the CommonObjectData record.
  19999. </member>
  20000. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.ObjectId">
  20001. Get the object id field for the CommonObjectData record.
  20002. </member>
  20003. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.Option">
  20004. Get the option field for the CommonObjectData record.
  20005. </member>
  20006. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.Reserved1">
  20007. Get the reserved1 field for the CommonObjectData record.
  20008. </member>
  20009. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.Reserved2">
  20010. Get the reserved2 field for the CommonObjectData record.
  20011. </member>
  20012. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.Reserved3">
  20013. Get the reserved3 field for the CommonObjectData record.
  20014. </member>
  20015. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.IsLocked">
  20016. true if object is locked when sheet has been protected
  20017. @return the locked field value.
  20018. </member>
  20019. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.IsPrintable">
  20020. object appears when printed
  20021. @return the printable field value.
  20022. </member>
  20023. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.IsAutoFill">
  20024. whether object uses an automatic Fill style
  20025. @return the autoFill field value.
  20026. </member>
  20027. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.IsAutoline">
  20028. whether object uses an automatic line style
  20029. @return the autoline field value.
  20030. </member>
  20031. <member name="T:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord">
  20032. A sub-record within the OBJ record which stores a reference to an object
  20033. stored in a Separate entry within the OLE2 compound file.
  20034. @author Daniel Noll
  20035. </member>
  20036. <member name="F:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord.field_2_refPtg">
  20037. either an area or a cell ref
  20038. </member>
  20039. <member name="F:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord.field_4_unknownByte">
  20040. Formulas often have a single non-zero trailing byte.
  20041. This is in a similar position to he pre-streamId padding
  20042. It is unknown if the value is important (it seems to mirror a value a few bytes earlier)
  20043. </member>
  20044. <member name="M:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  20045. Constructs an EmbeddedObjectRef record and Sets its fields appropriately.
  20046. @param in the record input stream.
  20047. </member>
  20048. <member name="P:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord.StreamId">
  20049. Gets the stream ID containing the actual data. The data itself
  20050. can be found under a top-level directory entry in the OLE2 filesystem
  20051. under the name "MBD<var>xxxxxxxx</var>" where <var>xxxxxxxx</var> is
  20052. this ID converted into hex (in big endian order, funnily enough.)
  20053. @return the data stream ID. Possibly <c>null</c>
  20054. </member>
  20055. <member name="T:NPOI.HSSF.Record.EndSubRecord">
  20056. * The end data record is used to denote the end of the subrecords.
  20057. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  20058. * Remove the record in src/records/definitions.
  20059. * @author Glen Stampoultzis (glens at apache.org)
  20060. </member>
  20061. <member name="M:NPOI.HSSF.Record.EndSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  20062. Constructs a End record and Sets its fields appropriately.
  20063. @param in the RecordInputstream to Read the record from
  20064. </member>
  20065. <member name="P:NPOI.HSSF.Record.EndSubRecord.DataSize">
  20066. Size of record (exluding 4 byte header)
  20067. </member>
  20068. <member name="T:NPOI.HSSF.Record.GroupMarkerSubRecord">
  20069. * The Group marker record is used as a position holder for Groups.
  20070. * @author Glen Stampoultzis (glens at apache.org)
  20071. </member>
  20072. <member name="M:NPOI.HSSF.Record.GroupMarkerSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  20073. Constructs a Group marker record and Sets its fields appropriately.
  20074. @param in the RecordInputstream to Read the record from
  20075. </member>
  20076. <member name="P:NPOI.HSSF.Record.GroupMarkerSubRecord.DataSize">
  20077. Size of record (exluding 4 byte header)
  20078. </member>
  20079. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._cbFContinued">
  20080. From [MS-XLS].pdf 2.5.147 FtLbsData:
  20081. An unsigned integer that indirectly specifies whether
  20082. some of the data in this structure appear in a subsequent Continue record.
  20083. If _cbFContinued is 0x00, all of the fields in this structure except sid and _cbFContinued
  20084. MUST NOT exist. If this entire structure is Contained within the same record,
  20085. then _cbFContinued MUST be greater than or equal to the size, in bytes,
  20086. of this structure, not including the four bytes for the ft and _cbFContinued fields
  20087. </member>
  20088. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._unknownPreFormulaInt">
  20089. a formula that specifies the range of cell values that are the items in this list.
  20090. </member>
  20091. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._cLines">
  20092. An unsigned integer that specifies the number of items in the list.
  20093. </member>
  20094. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._iSel">
  20095. An unsigned integer that specifies the one-based index of the first selected item in this list.
  20096. A value of 0x00 specifies there is no currently selected item.
  20097. </member>
  20098. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._flags">
  20099. flags that tell what data follows
  20100. </member>
  20101. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._idEdit">
  20102. An ObjId that specifies the edit box associated with this list.
  20103. A value of 0x00 specifies that there is no edit box associated with this list.
  20104. </member>
  20105. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._dropData">
  20106. An optional LbsDropData that specifies properties for this dropdown control.
  20107. This field MUST exist if and only if the Containing Obj?s cmo.ot is equal to 0x14.
  20108. </member>
  20109. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._rgLines">
  20110. An optional array of strings where each string specifies an item in the list.
  20111. The number of elements in this array, if it exists, MUST be {@link #_cLines}
  20112. </member>
  20113. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._bsels">
  20114. An optional array of bools that specifies
  20115. which items in the list are part of a multiple selection
  20116. </member>
  20117. <member name="M:NPOI.HSSF.Record.LbsDataSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32,System.Int32)">
  20118. @param in the stream to read data from
  20119. @param cbFContinued the seconf short in the record header
  20120. @param cmoOt the Containing Obj's {@link CommonObjectDataSubRecord#field_1_objectType}
  20121. </member>
  20122. <member name="M:NPOI.HSSF.Record.LbsDataSubRecord.CreateAutoFilterInstance">
  20123. @return a new instance of LbsDataSubRecord to construct auto-filters
  20124. @see org.apache.poi.hssf.model.ComboboxShape#createObjRecord(org.apache.poi.hssf.usermodel.HSSFSimpleShape, int)
  20125. </member>
  20126. <member name="P:NPOI.HSSF.Record.LbsDataSubRecord.Formula">
  20127. @return the formula that specifies the range of cell values that are the items in this list.
  20128. </member>
  20129. <member name="P:NPOI.HSSF.Record.LbsDataSubRecord.NumberOfItems">
  20130. @return the number of items in the list
  20131. </member>
  20132. <member name="T:NPOI.HSSF.Record.LbsDropData">
  20133. This structure specifies properties of the dropdown list control
  20134. </member>
  20135. <member name="F:NPOI.HSSF.Record.LbsDropData.STYLE_COMBO_DROPDOWN">
  20136. Combo dropdown control
  20137. </member>
  20138. <member name="F:NPOI.HSSF.Record.LbsDropData.STYLE_COMBO_EDIT_DROPDOWN">
  20139. Combo Edit dropdown control
  20140. </member>
  20141. <member name="F:NPOI.HSSF.Record.LbsDropData.STYLE_COMBO_SIMPLE_DROPDOWN">
  20142. Simple dropdown control (just the dropdown button)
  20143. </member>
  20144. <member name="F:NPOI.HSSF.Record.LbsDropData._wStyle">
  20145. An unsigned integer that specifies the style of this dropdown.
  20146. </member>
  20147. <member name="F:NPOI.HSSF.Record.LbsDropData._cLine">
  20148. An unsigned integer that specifies the number of lines to be displayed in the dropdown.
  20149. </member>
  20150. <member name="F:NPOI.HSSF.Record.LbsDropData._dxMin">
  20151. An unsigned integer that specifies the smallest width in pixels allowed for the dropdown window
  20152. </member>
  20153. <member name="F:NPOI.HSSF.Record.LbsDropData._str">
  20154. a string that specifies the current string value in the dropdown
  20155. </member>
  20156. <member name="F:NPOI.HSSF.Record.LbsDropData._unused">
  20157. Optional, undefined and MUST be ignored.
  20158. This field MUST exist if and only if the size of str in bytes is an odd number
  20159. </member>
  20160. <member name="T:NPOI.HSSF.Record.NoteStructureSubRecord">
  20161. Represents a NoteStructure (0xD) sub record.
  20162. The docs say nothing about it. The Length of this record is always 26 bytes.
  20163. @author Yegor Kozlov
  20164. </member>
  20165. <member name="M:NPOI.HSSF.Record.NoteStructureSubRecord.#ctor">
  20166. Construct a new <c>NoteStructureSubRecord</c> and
  20167. Fill its data with the default values
  20168. </member>
  20169. <member name="M:NPOI.HSSF.Record.NoteStructureSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  20170. Constructs a NoteStructureSubRecord and Sets its fields appropriately.
  20171. </member>
  20172. <member name="M:NPOI.HSSF.Record.NoteStructureSubRecord.ToString">
  20173. Convert this record to string.
  20174. Used by BiffViewer and other utulities.
  20175. </member>
  20176. <member name="M:NPOI.HSSF.Record.NoteStructureSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  20177. Serialize the record data into the supplied array of bytes
  20178. @param offset offset in the <c>data</c>
  20179. @param data the data to Serialize into
  20180. @return size of the record
  20181. </member>
  20182. <member name="P:NPOI.HSSF.Record.NoteStructureSubRecord.DataSize">
  20183. Size of record
  20184. </member>
  20185. <member name="P:NPOI.HSSF.Record.NoteStructureSubRecord.Sid">
  20186. @return id of this record.
  20187. </member>
  20188. <member name="T:NPOI.HSSF.Record.ScrollableObjectSubRecord">
  20189. <summary>
  20190. FtSbs structure
  20191. </summary>
  20192. </member>
  20193. <member name="T:NPOI.HSSF.Record.SupBookRecord">
  20194. Title: Sup Book (EXTERNALBOOK)
  20195. Description: A External Workbook Description (Suplemental Book)
  20196. Its only a dummy record for making new ExternSheet Record
  20197. REFERENCE: 5.38
  20198. @author Libin Roman (Vista Portal LDT. Developer)
  20199. @author Andrew C. Oliver (acoliver@apache.org)
  20200. </member>
  20201. <member name="M:NPOI.HSSF.Record.SupBookRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20202. Constructs a Extern Sheet record and Sets its fields appropriately.
  20203. @param id id must be 0x16 or an exception will be throw upon validation
  20204. @param size the size of the data area of the record
  20205. @param data data of the record (should not contain sid/len)
  20206. </member>
  20207. <member name="T:NPOI.HSSF.Record.TabIdRecord">
  20208. Title: Sheet Tab Index Array Record
  20209. Description: Contains an array of sheet id's. Sheets always keep their ID
  20210. regardless of what their name Is.
  20211. REFERENCE: PG 412 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  20212. @author Andrew C. Oliver (acoliver at apache dot org)
  20213. @version 2.0-pre
  20214. </member>
  20215. <member name="M:NPOI.HSSF.Record.TabIdRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20216. Constructs a TabID record and Sets its fields appropriately.
  20217. @param in the RecordInputstream to Read the record from
  20218. </member>
  20219. <member name="M:NPOI.HSSF.Record.TabIdRecord.SetTabIdArray(System.Int16[])">
  20220. Set the tab array. (0,1,2).
  20221. @param array of tab id's {0,1,2}
  20222. </member>
  20223. <member name="M:NPOI.HSSF.Record.TabIdRecord.ToString">
  20224. Get the tab array. (0,1,2).
  20225. @return array of tab id's {0,1,2}
  20226. </member>
  20227. <member name="T:NPOI.HSSF.Record.TableRecord">
  20228. DATATABLE (0x0236)<p/>
  20229. TableRecord - The record specifies a data table.
  20230. This record Is preceded by a single Formula record that
  20231. defines the first cell in the data table, which should
  20232. only contain a single Ptg, {@link TblPtg}.
  20233. See p536 of the June 08 binary docs
  20234. </member>
  20235. <member name="T:NPOI.HSSF.Record.TableStylesRecord">
  20236. TABLESTYLES (0x088E)<br/>
  20237. @author Patrick Cheng
  20238. </member>
  20239. <member name="F:NPOI.HSSF.Record.TextObjectRecord._linkRefPtg">
  20240. expect tRef, tRef3D, tArea, tArea3D or tName
  20241. </member>
  20242. <member name="F:NPOI.HSSF.Record.TextObjectRecord._unknownPostFormulaByte">
  20243. Not clear if needed . Excel seems to be OK if this byte is not present.
  20244. Value is often the same as the earlier firstColumn byte.
  20245. </member>
  20246. <member name="P:NPOI.HSSF.Record.TextObjectRecord.TextOrientation">
  20247. Get the text orientation field for the TextObjectBase record.
  20248. @return a TextOrientation
  20249. </member>
  20250. <member name="P:NPOI.HSSF.Record.TextObjectRecord.HorizontalTextAlignment">
  20251. @return the Horizontal text alignment field value.
  20252. </member>
  20253. <member name="P:NPOI.HSSF.Record.TextObjectRecord.VerticalTextAlignment">
  20254. @return the Vertical text alignment field value.
  20255. </member>
  20256. <member name="P:NPOI.HSSF.Record.TextObjectRecord.IsTextLocked">
  20257. Text has been locked
  20258. @return the text locked field value.
  20259. </member>
  20260. <member name="T:NPOI.HSSF.Record.TopMarginRecord">
  20261. Record for the top margin.
  20262. NOTE: This source was automatically generated.
  20263. @author Shawn Laubach (slaubach at apache dot org)
  20264. </member>
  20265. <member name="M:NPOI.HSSF.Record.TopMarginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20266. Constructs a TopMargin record and Sets its fields appropriately.
  20267. @param in the RecordInputstream to Read the record from
  20268. </member>
  20269. <member name="P:NPOI.HSSF.Record.TopMarginRecord.Margin">
  20270. Get the margin field for the TopMargin record.
  20271. </member>
  20272. <member name="T:NPOI.HSSF.Record.UncalcedRecord">
  20273. Title: Uncalced Record
  20274. If this record occurs in the Worksheet Substream, it indicates that the formulas have not
  20275. been recalculated before the document was saved.
  20276. @author Olivier Leprince
  20277. </member>
  20278. <member name="M:NPOI.HSSF.Record.UncalcedRecord.#ctor">
  20279. Default constructor
  20280. </member>
  20281. <member name="M:NPOI.HSSF.Record.UncalcedRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20282. Read constructor
  20283. </member>
  20284. <member name="T:NPOI.HSSF.Record.UnknownRecord">
  20285. Title: Unknown Record (for debugging)
  20286. Description: Unknown record just tells you the sid so you can figure out
  20287. what records you are missing. Also helps us Read/modify sheets we
  20288. don't know all the records to. (HSSF leaves these alone!)
  20289. Company: SuperLink Software, Inc.
  20290. @author Andrew C. Oliver (acoliver at apache dot org)
  20291. @author Jason Height (jheight at chariot dot net dot au)
  20292. @author Glen Stampoultzis (glens at apache.org)
  20293. </member>
  20294. <member name="M:NPOI.HSSF.Record.UnknownRecord.#ctor(System.Int32,System.Byte[])">
  20295. @param id id of the record -not Validated, just stored for serialization
  20296. @param data the data
  20297. </member>
  20298. <member name="M:NPOI.HSSF.Record.UnknownRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20299. construct an Unknown record. No fields are interperated and the record will
  20300. be Serialized in its original form more or less
  20301. @param in the RecordInputstream to Read the record from
  20302. </member>
  20303. <member name="M:NPOI.HSSF.Record.UnknownRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  20304. spit the record out AS IS. no interpretation or identification
  20305. </member>
  20306. <member name="M:NPOI.HSSF.Record.UnknownRecord.ToString">
  20307. print a sort of string representation ([UNKNOWN RECORD] id = x [/UNKNOWN RECORD])
  20308. </member>
  20309. <member name="M:NPOI.HSSF.Record.UnknownRecord.GetBiffName(System.Int32)">
  20310. These BIFF record types are known but still uninterpreted by POI
  20311. @return the documented name of this BIFF record type, <code>null</code> if unknown to POI
  20312. </member>
  20313. <member name="M:NPOI.HSSF.Record.UnknownRecord.IsObservedButUnknown(System.Int32)">
  20314. @return <c>true</c> if the unknown record id has been observed in POI unit tests
  20315. </member>
  20316. <member name="M:NPOI.HSSF.Record.UnknownRecord.Clone">
  20317. Unlike the other Record.Clone methods this Is a shallow Clone
  20318. </member>
  20319. <member name="T:NPOI.HSSF.Record.UserSViewBegin">
  20320. The UserSViewBegin record specifies Settings for a custom view associated with the sheet.
  20321. This record also marks the start of custom view records, which save custom view Settings.
  20322. Records between {@link UserSViewBegin} and {@link UserSViewEnd} contain Settings for the custom view,
  20323. not Settings for the sheet itself.
  20324. @author Yegor Kozlov
  20325. </member>
  20326. <member name="M:NPOI.HSSF.Record.UserSViewBegin.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20327. construct an UserSViewBegin record. No fields are interpreted and the record will
  20328. be Serialized in its original form more or less
  20329. @param in the RecordInputstream to read the record from
  20330. </member>
  20331. <member name="M:NPOI.HSSF.Record.UserSViewBegin.Serialize(NPOI.Util.ILittleEndianOutput)">
  20332. spit the record out AS IS. no interpretation or identification
  20333. </member>
  20334. <member name="P:NPOI.HSSF.Record.UserSViewBegin.Guid">
  20335. @return Globally unique identifier for the custom view
  20336. </member>
  20337. <member name="T:NPOI.HSSF.Record.UserSViewEnd">
  20338. The UserSViewEnd record marks the end of the Settings for a custom view associated with the sheet
  20339. @author Yegor Kozlov
  20340. </member>
  20341. <member name="M:NPOI.HSSF.Record.UserSViewEnd.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20342. construct an UserSViewEnd record. No fields are interpreted and the record will
  20343. be Serialized in its original form more or less
  20344. @param in the RecordInputstream to read the record from
  20345. </member>
  20346. <member name="M:NPOI.HSSF.Record.UserSViewEnd.Serialize(NPOI.Util.ILittleEndianOutput)">
  20347. spit the record out AS IS. no interpretation or identification
  20348. </member>
  20349. <member name="T:NPOI.HSSF.Record.UseSelFSRecord">
  20350. Title: Use Natural Language Formulas Flag
  20351. Description: Tells the GUI if this was written by something that can use
  20352. "natural language" formulas. HSSF can't.
  20353. REFERENCE: PG 420 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  20354. @author Andrew C. Oliver (acoliver at apache dot org)
  20355. @version 2.0-pre
  20356. </member>
  20357. <member name="M:NPOI.HSSF.Record.UseSelFSRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20358. Constructs a UseSelFS record and Sets its fields appropriately.
  20359. @param in the RecordInputstream to Read the record from
  20360. </member>
  20361. <member name="T:NPOI.HSSF.Record.VCenterRecord">
  20362. Title: VCenter record
  20363. Description: tells whether to center the sheet between vertical margins
  20364. REFERENCE: PG 420 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  20365. @author Andrew C. Oliver (acoliver at apache dot org)
  20366. @author Jason Height (jheight at chariot dot net dot au)
  20367. @version 2.0-pre
  20368. </member>
  20369. <member name="M:NPOI.HSSF.Record.VCenterRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20370. Constructs a VCENTER record and Sets its fields appropriately.
  20371. @param in the RecordInputstream to Read the record from
  20372. </member>
  20373. <member name="P:NPOI.HSSF.Record.VCenterRecord.VCenter">
  20374. Get whether to center vertically or not
  20375. @return vcenter or not
  20376. </member>
  20377. <member name="T:NPOI.HSSF.Record.VerticalPageBreakRecord">
  20378. VerticalPageBreak record that stores page breaks at columns
  20379. This class Is just used so that SID Compares work properly in the RecordFactory
  20380. @see PageBreakRecord
  20381. @author Danny Mui (dmui at apache dot org)
  20382. </member>
  20383. <member name="M:NPOI.HSSF.Record.VerticalPageBreakRecord.#ctor">
  20384. </member>
  20385. <member name="M:NPOI.HSSF.Record.VerticalPageBreakRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20386. @param in the RecordInputstream to Read the record from
  20387. </member>
  20388. <member name="T:NPOI.HSSF.Record.WindowOneRecord">
  20389. Title: Window1 Record
  20390. Description: Stores the attributes of the workbook window. This Is basically
  20391. so the gui knows how big to make the window holding the spReadsheet
  20392. document.
  20393. REFERENCE: PG 421 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  20394. @author Andrew C. Oliver (acoliver at apache dot org)
  20395. @version 2.0-pre
  20396. </member>
  20397. <member name="M:NPOI.HSSF.Record.WindowOneRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20398. Constructs a WindowOne record and Sets its fields appropriately.
  20399. @param in the RecordInputstream to Read the record from
  20400. </member>
  20401. <member name="P:NPOI.HSSF.Record.WindowOneRecord.HorizontalHold">
  20402. Get the horizontal position of the window (in 1/20ths of a point)
  20403. @return h - horizontal location
  20404. </member>
  20405. <member name="P:NPOI.HSSF.Record.WindowOneRecord.VerticalHold">
  20406. Get the vertical position of the window (in 1/20ths of a point)
  20407. @return v - vertical location
  20408. </member>
  20409. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Width">
  20410. Get the width of the window
  20411. @return width
  20412. </member>
  20413. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Height">
  20414. Get the height of the window
  20415. @return height
  20416. </member>
  20417. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Options">
  20418. Get the options bitmask (see bit Setters)
  20419. @return o - the bitmask
  20420. </member>
  20421. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Hidden">
  20422. Get whether the window Is hidden or not
  20423. @return Ishidden or not
  20424. </member>
  20425. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Iconic">
  20426. Get whether the window has been iconized or not
  20427. @return iconize or not
  20428. </member>
  20429. <member name="P:NPOI.HSSF.Record.WindowOneRecord.DisplayHorizontalScrollbar">
  20430. Get whether to Display the horizontal scrollbar or not
  20431. @return Display or not
  20432. </member>
  20433. <member name="P:NPOI.HSSF.Record.WindowOneRecord.DisplayVerticalScrollbar">
  20434. Get whether to Display the vertical scrollbar or not
  20435. @return Display or not
  20436. </member>
  20437. <member name="P:NPOI.HSSF.Record.WindowOneRecord.DisplayTabs">
  20438. Get whether to Display the tabs or not
  20439. @return Display or not
  20440. </member>
  20441. <member name="P:NPOI.HSSF.Record.WindowOneRecord.ActiveSheetIndex">
  20442. @return the index of the currently Displayed sheet
  20443. </member>
  20444. <member name="P:NPOI.HSSF.Record.WindowOneRecord.SelectedTab">
  20445. deprecated May 2008
  20446. @deprecated - Misleading name - use GetActiveSheetIndex()
  20447. </member>
  20448. <member name="P:NPOI.HSSF.Record.WindowOneRecord.FirstVisibleTab">
  20449. @return the first visible sheet in the worksheet tab-bar.
  20450. I.E. the scroll position of the tab-bar.
  20451. </member>
  20452. <member name="P:NPOI.HSSF.Record.WindowOneRecord.DisplayedTab">
  20453. deprecated May 2008
  20454. @deprecated - Misleading name - use GetFirstVisibleTab()
  20455. </member>
  20456. <member name="P:NPOI.HSSF.Record.WindowOneRecord.NumSelectedTabs">
  20457. Get the number of selected tabs
  20458. @return number of tabs
  20459. </member>
  20460. <member name="P:NPOI.HSSF.Record.WindowOneRecord.TabWidthRatio">
  20461. ratio of the width of the tabs to the horizontal scrollbar
  20462. @return ratio
  20463. </member>
  20464. <member name="T:NPOI.HSSF.Record.WindowProtectRecord">
  20465. Title: Window Protect Record
  20466. Description: flags whether workbook windows are protected
  20467. REFERENCE: PG 424 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  20468. @author Andrew C. Oliver (acoliver at apache dot org)
  20469. @version 2.0-pre
  20470. </member>
  20471. <member name="M:NPOI.HSSF.Record.WindowProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20472. Constructs a WindowProtect record and Sets its fields appropriately.
  20473. @param in the RecordInputstream to Read the record from
  20474. </member>
  20475. <member name="P:NPOI.HSSF.Record.WindowProtectRecord.Protect">
  20476. Is this window protected or not
  20477. @return protected or not
  20478. </member>
  20479. <member name="T:NPOI.HSSF.Record.WindowTwoRecord">
  20480. Title: Window Two Record
  20481. Description: sheet window Settings
  20482. REFERENCE: PG 422 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  20483. @author Andrew C. Oliver (acoliver at apache dot org)
  20484. @author Jason Height (jheight at chariot dot net dot au)
  20485. @version 2.0-pre
  20486. </member>
  20487. <member name="M:NPOI.HSSF.Record.WindowTwoRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20488. Constructs a WindowTwo record and Sets its fields appropriately.
  20489. @param in the RecordInputstream to Read the record from
  20490. </member>
  20491. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.Options">
  20492. Get the options bitmask or just use the bit Setters.
  20493. @return options
  20494. </member>
  20495. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayFormulas">
  20496. Get whether the window should Display formulas
  20497. @return formulas or not
  20498. </member>
  20499. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayGridlines">
  20500. Get whether the window should Display gridlines
  20501. @return gridlines or not
  20502. </member>
  20503. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayRowColHeadings">
  20504. Get whether the window should Display row and column headings
  20505. @return headings or not
  20506. </member>
  20507. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.FreezePanes">
  20508. Get whether the window should freeze panes
  20509. @return freeze panes or not
  20510. </member>
  20511. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayZeros">
  20512. Get whether the window should Display zero values
  20513. @return zeros or not
  20514. </member>
  20515. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DefaultHeader">
  20516. Get whether the window should Display a default header
  20517. @return header or not
  20518. </member>
  20519. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.Arabic">
  20520. Is this arabic?
  20521. @return arabic or not
  20522. </member>
  20523. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayGuts">
  20524. Get whether the outline symbols are displaed
  20525. @return symbols or not
  20526. </member>
  20527. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.FreezePanesNoSplit">
  20528. freeze Unsplit panes or not
  20529. @return freeze or not
  20530. </member>
  20531. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.IsSelected">
  20532. sheet tab Is selected
  20533. @return selected or not
  20534. </member>
  20535. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.IsActive">
  20536. Is the sheet currently Displayed in the window
  20537. @return Displayed or not
  20538. </member>
  20539. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.Paged">
  20540. deprecated May 2008
  20541. @deprecated use IsActive()
  20542. </member>
  20543. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.SavedInPageBreakPreview">
  20544. was the sheet saved in page break view
  20545. @return pagebreaksaved or not
  20546. </member>
  20547. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.TopRow">
  20548. Get the top row visible in the window
  20549. @return toprow
  20550. </member>
  20551. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.LeftCol">
  20552. Get the leftmost column Displayed in the window
  20553. @return leftmost
  20554. </member>
  20555. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.HeaderColor">
  20556. Get the palette index for the header color
  20557. @return color
  20558. </member>
  20559. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.PageBreakZoom">
  20560. zoom magification in page break view
  20561. @return zoom
  20562. </member>
  20563. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.NormalZoom">
  20564. Get the zoom magnification in normal view
  20565. @return zoom
  20566. </member>
  20567. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.Reserved">
  20568. Get the reserved bits - why would you do this?
  20569. @return reserved stuff -probably garbage
  20570. </member>
  20571. <member name="T:NPOI.HSSF.Record.WriteAccessRecord">
  20572. Title: Write Access Record
  20573. Description: Stores the username of that who owns the spReadsheet generator
  20574. (on Unix the user's login, on Windoze its the name you typed when
  20575. you installed the thing)
  20576. REFERENCE: PG 424 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  20577. @author Andrew C. Oliver (acoliver at apache dot org)
  20578. @version 2.0-pre
  20579. </member>
  20580. <member name="F:NPOI.HSSF.Record.WriteAccessRecord.PADDING">
  20581. this record is always padded to a constant length
  20582. </member>
  20583. <member name="M:NPOI.HSSF.Record.WriteAccessRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20584. Constructs a WriteAccess record and Sets its fields appropriately.
  20585. @param in the RecordInputstream to Read the record from
  20586. </member>
  20587. <member name="P:NPOI.HSSF.Record.WriteAccessRecord.Username">
  20588. Get the username for the user that Created the report. HSSF uses the logged in user. On
  20589. natively Created M$ Excel sheet this would be the name you typed in when you installed it
  20590. in most cases.
  20591. @return username of the user who Is logged in (probably "tomcat" or "apache")
  20592. </member>
  20593. <member name="T:NPOI.HSSF.Record.WriteProtectRecord">
  20594. Title: Write Protect Record
  20595. Description: Indicated that the sheet/workbook Is Write protected.
  20596. REFERENCE: PG 425 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  20597. @version 3.0-pre
  20598. </member>
  20599. <member name="M:NPOI.HSSF.Record.WriteProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20600. Constructs a WriteAccess record and Sets its fields appropriately.
  20601. @param in the RecordInputstream to Read the record from
  20602. </member>
  20603. <member name="T:NPOI.HSSF.Record.WSBoolRecord">
  20604. Title: WSBool Record.
  20605. Description: stores workbook Settings (aka its a big "everything we didn't
  20606. put somewhere else")
  20607. REFERENCE: PG 425 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  20608. @author Andrew C. Oliver (acoliver at apache dot org)
  20609. @author Glen Stampoultzis (gstamp@iprimus.com.au)
  20610. @author Jason Height (jheight at chariot dot net dot au)
  20611. @version 2.0-pre
  20612. </member>
  20613. <member name="M:NPOI.HSSF.Record.WSBoolRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20614. Constructs a WSBool record and Sets its fields appropriately.
  20615. @param in the RecordInputstream to Read the record from
  20616. </member>
  20617. <member name="P:NPOI.HSSF.Record.WSBoolRecord.WSBool1">
  20618. Get first byte (see bit Getters)
  20619. </member>
  20620. <member name="P:NPOI.HSSF.Record.WSBoolRecord.Autobreaks">
  20621. <summary>
  20622. Whether to show automatic page breaks or not
  20623. </summary>
  20624. </member>
  20625. <member name="P:NPOI.HSSF.Record.WSBoolRecord.Dialog">
  20626. <summary>
  20627. Whether sheet is a dialog sheet or not
  20628. </summary>
  20629. </member>
  20630. <member name="P:NPOI.HSSF.Record.WSBoolRecord.RowSumsBelow">
  20631. <summary>
  20632. Get if row summaries appear below detail in the outline
  20633. </summary>
  20634. </member>
  20635. <member name="P:NPOI.HSSF.Record.WSBoolRecord.RowSumsRight">
  20636. <summary>
  20637. Get if col summaries appear right of the detail in the outline
  20638. </summary>
  20639. </member>
  20640. <member name="P:NPOI.HSSF.Record.WSBoolRecord.WSBool2">
  20641. <summary>
  20642. Get the second byte (see bit Getters)
  20643. </summary>
  20644. </member>
  20645. <member name="P:NPOI.HSSF.Record.WSBoolRecord.FitToPage">
  20646. <summary>
  20647. fit to page option is on
  20648. </summary>
  20649. </member>
  20650. <member name="P:NPOI.HSSF.Record.WSBoolRecord.DisplayGuts">
  20651. <summary>
  20652. Whether to display the guts or not
  20653. </summary>
  20654. </member>
  20655. <member name="P:NPOI.HSSF.Record.WSBoolRecord.AlternateExpression">
  20656. <summary>
  20657. whether alternate expression evaluation is on
  20658. </summary>
  20659. </member>
  20660. <member name="P:NPOI.HSSF.Record.WSBoolRecord.AlternateFormula">
  20661. <summary>
  20662. whether alternative formula entry is on
  20663. </summary>
  20664. </member>
  20665. <member name="T:NPOI.HSSF.UserModel.HSSFChart">
  20666. Has methods for construction of a chart object.
  20667. @author Glen Stampoultzis (glens at apache.org)
  20668. </member>
  20669. <member name="M:NPOI.HSSF.UserModel.HSSFChart.CreateBarChart(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet)">
  20670. Creates a bar chart. API needs some work. :)
  20671. NOTE: Does not yet work... checking it in just so others
  20672. can take a look.
  20673. </member>
  20674. <member name="M:NPOI.HSSF.UserModel.HSSFChart.GetSheetCharts(NPOI.HSSF.UserModel.HSSFSheet)">
  20675. Returns all the charts for the given sheet.
  20676. NOTE: You won't be able to do very much with
  20677. these charts yet, as this is very limited support
  20678. </member>
  20679. <member name="M:NPOI.HSSF.UserModel.HSSFChart.SetValueRange(System.Int32,System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{System.Double})">
  20680. Set value range (basic Axis Options)
  20681. @param axisIndex 0 - primary axis, 1 - secondary axis
  20682. @param minimum minimum value; Double.NaN - automatic; null - no change
  20683. @param maximum maximum value; Double.NaN - automatic; null - no change
  20684. @param majorUnit major unit value; Double.NaN - automatic; null - no change
  20685. @param minorUnit minor unit value; Double.NaN - automatic; null - no change
  20686. </member>
  20687. <member name="P:NPOI.HSSF.UserModel.HSSFChart.ChartX">
  20688. Get the X offset of the chart
  20689. </member>
  20690. <member name="P:NPOI.HSSF.UserModel.HSSFChart.ChartY">
  20691. Get the Y offset of the chart
  20692. </member>
  20693. <member name="P:NPOI.HSSF.UserModel.HSSFChart.ChartWidth">
  20694. Get the width of the chart. {@link ChartRecord}
  20695. </member>
  20696. <member name="P:NPOI.HSSF.UserModel.HSSFChart.ChartHeight">
  20697. Get the height of the chart. {@link ChartRecord}
  20698. </member>
  20699. <member name="P:NPOI.HSSF.UserModel.HSSFChart.Series">
  20700. Returns the series of the chart
  20701. </member>
  20702. <member name="P:NPOI.HSSF.UserModel.HSSFChart.ChartTitle">
  20703. Returns the chart's title, if there is one,
  20704. or null if not
  20705. </member>
  20706. <member name="T:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries">
  20707. A series in a chart
  20708. </member>
  20709. <member name="M:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.GetDataName">
  20710. @return record with data names
  20711. </member>
  20712. <member name="M:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.GetDataValues">
  20713. @return record with data values
  20714. </member>
  20715. <member name="M:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.GetDataCategoryLabels">
  20716. @return record with data category labels
  20717. </member>
  20718. <member name="M:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.GetDataSecondaryCategoryLabels">
  20719. @return record with data secondary category labels
  20720. </member>
  20721. <member name="M:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.GetSeries">
  20722. @return record with series
  20723. </member>
  20724. <member name="P:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.ValueType">
  20725. See {@link SeriesRecord}
  20726. </member>
  20727. <member name="P:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.SeriesTitle">
  20728. Returns the series' title, if there is one,
  20729. or null if not
  20730. </member>
  20731. <member name="T:NPOI.HSSF.UserModel.HSSFErrorConstants">
  20732. <summary>
  20733. Contains raw Excel error codes (as defined in OOO's excelfileformat.pdf (2.5.6)
  20734. @author Michael Harhen
  20735. </summary>
  20736. </member>
  20737. <member name="F:NPOI.HSSF.UserModel.HSSFErrorConstants.ERROR_NULL">
  20738. <b>#NULL!</b> - Intersection of two cell ranges is empty
  20739. </member>
  20740. <member name="F:NPOI.HSSF.UserModel.HSSFErrorConstants.ERROR_DIV_0">
  20741. <b>#DIV/0!</b> - Division by zero
  20742. </member>
  20743. <member name="F:NPOI.HSSF.UserModel.HSSFErrorConstants.ERROR_VALUE">
  20744. <b>#VALUE!</b> - Wrong type of operand
  20745. </member>
  20746. <member name="F:NPOI.HSSF.UserModel.HSSFErrorConstants.ERROR_REF">
  20747. <b>#REF!</b> - Illegal or deleted cell reference
  20748. </member>
  20749. <member name="F:NPOI.HSSF.UserModel.HSSFErrorConstants.ERROR_NAME">
  20750. <b>#NAME?</b> - Wrong function or range name
  20751. </member>
  20752. <member name="F:NPOI.HSSF.UserModel.HSSFErrorConstants.ERROR_NUM">
  20753. <b>#NUM!</b> - Value range overflow
  20754. </member>
  20755. <member name="F:NPOI.HSSF.UserModel.HSSFErrorConstants.ERROR_NA">
  20756. <b>#N/A</b> - Argument or function not available
  20757. </member>
  20758. <member name="M:NPOI.HSSF.UserModel.HSSFErrorConstants.GetText(System.Int32)">
  20759. <summary>
  20760. Gets standard Excel error literal for the specified error code.
  20761. @throws ArgumentException if the specified error code is not one of the 7
  20762. standard error codes
  20763. </summary>
  20764. <param name="errorCode">The error code.</param>
  20765. <returns></returns>
  20766. </member>
  20767. <member name="M:NPOI.HSSF.UserModel.HSSFErrorConstants.IsValidCode(System.Int32)">
  20768. <summary>
  20769. Determines whether [is valid code] [the specified error code].
  20770. </summary>
  20771. <param name="errorCode">The error code.</param>
  20772. <returns>
  20773. <c>true</c> if the specified error code is a standard Excel error code.; otherwise, <c>false</c>.
  20774. </returns>
  20775. </member>
  20776. <member name="T:NPOI.POIFS.Common.POIFSBigBlockSize">
  20777. <p>A class describing attributes of the Big Block Size</p>
  20778. </member>
  20779. <member name="M:NPOI.POIFS.Common.POIFSBigBlockSize.GetHeaderValue">
  20780. Returns the value that Gets written into the
  20781. header.
  20782. Is the power of two that corresponds to the
  20783. size of the block, eg 512 => 9
  20784. </member>
  20785. <member name="T:NPOI.POIFS.Common.POIFSConstants">
  20786. <summary>
  20787. A repository for constants shared by POI classes.
  20788. @author Marc Johnson (mjohnson at apache dot org)
  20789. </summary>
  20790. </member>
  20791. <member name="F:NPOI.POIFS.Common.POIFSConstants.SMALLER_BIG_BLOCK_SIZE">
  20792. Most files use 512 bytes as their big block size
  20793. </member>
  20794. <member name="F:NPOI.POIFS.Common.POIFSConstants.LARGER_BIG_BLOCK_SIZE">
  20795. Some use 4096 bytes
  20796. </member>
  20797. <member name="F:NPOI.POIFS.Common.POIFSConstants.BIG_BLOCK_SIZE">
  20798. Most files use 512 bytes as their big block size
  20799. </member>
  20800. <member name="F:NPOI.POIFS.Common.POIFSConstants.MINI_BLOCK_SIZE">
  20801. Most files use 512 bytes as their big block size
  20802. </member>
  20803. <member name="F:NPOI.POIFS.Common.POIFSConstants.SMALL_BLOCK_SIZE">
  20804. How big a block in the small block stream is. Fixed size
  20805. </member>
  20806. <member name="F:NPOI.POIFS.Common.POIFSConstants.PROPERTY_SIZE">
  20807. How big a single property is
  20808. </member>
  20809. <member name="F:NPOI.POIFS.Common.POIFSConstants.BIG_BLOCK_MINIMUM_DOCUMENT_SIZE">
  20810. The minimum size of a document before it's stored using
  20811. Big Blocks (normal streams). Smaller documents go in the
  20812. Mini Stream (SBAT / Small Blocks)
  20813. </member>
  20814. <member name="F:NPOI.POIFS.Common.POIFSConstants.LARGEST_REGULAR_SECTOR_NUMBER">
  20815. The highest sector number you're allowed, 0xFFFFFFFA
  20816. </member>
  20817. <member name="F:NPOI.POIFS.Common.POIFSConstants.FAT_SECTOR_BLOCK">
  20818. Indicates the sector holds a FAT block (0xFFFFFFFD)
  20819. </member>
  20820. <member name="F:NPOI.POIFS.Common.POIFSConstants.DIFAT_SECTOR_BLOCK">
  20821. Indicates the sector holds a DIFAT block (0xFFFFFFFC)
  20822. </member>
  20823. <member name="F:NPOI.POIFS.Common.POIFSConstants.END_OF_CHAIN">
  20824. Indicates the sector is the end of a chain (0xFFFFFFFE)
  20825. </member>
  20826. <member name="F:NPOI.POIFS.Common.POIFSConstants.UNUSED_BLOCK">
  20827. Indicates the sector is not used (0xFFFFFFFF)
  20828. </member>
  20829. <member name="F:NPOI.POIFS.Common.POIFSConstants.OOXML_FILE_HEADER">
  20830. The first 4 bytes of an OOXML file, used in detection
  20831. </member>
  20832. <member name="T:NPOI.POIFS.Dev.POIFSViewEngine">
  20833. <summary>
  20834. This class contains methods used to inspect POIFSViewable objects
  20835. @author Marc Johnson (mjohnson at apache dot org)
  20836. </summary>
  20837. </member>
  20838. <member name="M:NPOI.POIFS.Dev.POIFSViewEngine.InspectViewable(System.Object,System.Boolean,System.Int32,System.String)">
  20839. <summary>
  20840. Inspect an object that may be viewable, and drill down if told to
  20841. </summary>
  20842. <param name="viewable">the object to be viewed</param>
  20843. <param name="drilldown">if <c>true</c> and the object implements POIFSViewable, inspect the objects' contents</param>
  20844. <param name="indentLevel">how far in to indent each string</param>
  20845. <param name="indentString">string to use for indenting</param>
  20846. <returns>a List of Strings holding the content</returns>
  20847. </member>
  20848. <member name="M:NPOI.POIFS.Dev.POIFSViewEngine.Indent(System.Int32,System.String,System.String)">
  20849. <summary>
  20850. Indents the specified indent level.
  20851. </summary>
  20852. <param name="indentLevel">how far in to indent each string</param>
  20853. <param name="indentString">string to use for indenting</param>
  20854. <param name="data">The data.</param>
  20855. <returns></returns>
  20856. </member>
  20857. <member name="T:NPOI.POIFS.EventFileSystem.POIFSReader">
  20858. <summary>
  20859. An event-driven Reader for POIFS file systems. Users of this class
  20860. first Create an instance of it, then use the RegisterListener
  20861. methods to Register POIFSReaderListener instances for specific
  20862. documents. Once all the listeners have been Registered, the Read()
  20863. method is called, which results in the listeners being notified as
  20864. their documents are Read.
  20865. @author Marc Johnson (mjohnson at apache dot org)
  20866. </summary>
  20867. </member>
  20868. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.#ctor">
  20869. <summary>
  20870. Initializes a new instance of the <see cref="T:NPOI.POIFS.EventFileSystem.POIFSReader"/> class.
  20871. </summary>
  20872. </member>
  20873. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.Read(System.IO.Stream)">
  20874. <summary>
  20875. Read from an InputStream and Process the documents we Get
  20876. </summary>
  20877. <param name="stream">the InputStream from which to Read the data</param>
  20878. <returns>POIFSDocument list</returns>
  20879. </member>
  20880. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.RegisterListener(NPOI.POIFS.EventFileSystem.POIFSReaderListener)">
  20881. Register a POIFSReaderListener for all documents
  20882. @param listener the listener to be registered
  20883. @exception NullPointerException if listener is null
  20884. @exception IllegalStateException if read() has already been
  20885. called
  20886. </member>
  20887. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.RegisterListener(NPOI.POIFS.EventFileSystem.POIFSReaderListener,System.String)">
  20888. Register a POIFSReaderListener for a document in the root
  20889. directory
  20890. @param listener the listener to be registered
  20891. @param name the document name
  20892. @exception NullPointerException if listener is null or name is
  20893. null or empty
  20894. @exception IllegalStateException if read() has already been
  20895. called
  20896. </member>
  20897. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.RegisterListener(NPOI.POIFS.EventFileSystem.POIFSReaderListener,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String)">
  20898. Register a POIFSReaderListener for a document in the specified
  20899. directory
  20900. @param listener the listener to be registered
  20901. @param path the document path; if null, the root directory is
  20902. assumed
  20903. @param name the document name
  20904. @exception NullPointerException if listener is null or name is
  20905. null or empty
  20906. @exception IllegalStateException if read() has already been
  20907. called
  20908. </member>
  20909. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.ProcessProperties(NPOI.POIFS.Storage.BlockList,NPOI.POIFS.Storage.BlockList,System.Collections.IEnumerator,NPOI.POIFS.FileSystem.POIFSDocumentPath)">
  20910. <summary>
  20911. Processes the properties.
  20912. </summary>
  20913. <param name="small_blocks">The small_blocks.</param>
  20914. <param name="big_blocks">The big_blocks.</param>
  20915. <param name="properties">The properties.</param>
  20916. <param name="path">The path.</param>
  20917. <returns></returns>
  20918. </member>
  20919. <member name="T:NPOI.POIFS.EventFileSystem.POIFSReaderEvent">
  20920. Class POIFSReaderEvent
  20921. @author Marc Johnson (mjohnson at apache dot org)
  20922. @version %I%, %G%
  20923. </member>
  20924. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderEvent.#ctor(NPOI.POIFS.FileSystem.DocumentInputStream,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String)">
  20925. package scoped constructor
  20926. @param stream the DocumentInputStream, freshly opened
  20927. @param path the path of the document
  20928. @param documentName the name of the document
  20929. </member>
  20930. <member name="P:NPOI.POIFS.EventFileSystem.POIFSReaderEvent.Stream">
  20931. @return the DocumentInputStream, freshly opened
  20932. </member>
  20933. <member name="P:NPOI.POIFS.EventFileSystem.POIFSReaderEvent.Path">
  20934. @return the document's path
  20935. </member>
  20936. <member name="P:NPOI.POIFS.EventFileSystem.POIFSReaderEvent.Name">
  20937. @return the document's name
  20938. </member>
  20939. <member name="T:NPOI.POIFS.EventFileSystem.POIFSReaderEventArgs">
  20940. <summary>
  20941. EventArgs for POIFSReader
  20942. author: Tony Qu
  20943. </summary>
  20944. </member>
  20945. <member name="T:NPOI.POIFS.EventFileSystem.POIFSReaderListener">
  20946. Interface POIFSReaderListener
  20947. @author Marc Johnson (mjohnson at apache dot org)
  20948. @version %I%, %G%
  20949. </member>
  20950. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderListener.ProcessPOIFSReaderEvent(NPOI.POIFS.EventFileSystem.POIFSReaderEvent)">
  20951. Process a POIFSReaderEvent that this listener had Registered
  20952. for
  20953. @param event the POIFSReaderEvent
  20954. </member>
  20955. <member name="T:NPOI.POIFS.EventFileSystem.POIFSReaderRegistry">
  20956. A registry for POIFSReaderListeners and the DocumentDescriptors of
  20957. the documents those listeners are interested in
  20958. @author Marc Johnson (mjohnson at apache dot org)
  20959. @version %I%, %G%
  20960. </member>
  20961. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderRegistry.#ctor">
  20962. Construct the registry
  20963. </member>
  20964. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderRegistry.RegisterListener(NPOI.POIFS.EventFileSystem.POIFSReaderListener,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String)">
  20965. Register a POIFSReaderListener for a particular document
  20966. @param listener the listener
  20967. @param path the path of the document of interest
  20968. @param documentName the name of the document of interest
  20969. </member>
  20970. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderRegistry.RegisterListener(NPOI.POIFS.EventFileSystem.POIFSReaderListener)">
  20971. Register for all documents
  20972. @param listener the listener who wants to Get all documents
  20973. </member>
  20974. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderRegistry.GetListeners(NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String)">
  20975. Get am iterator of listeners for a particular document
  20976. @param path the document path
  20977. @param name the name of the document
  20978. @return an Iterator POIFSReaderListeners; may be empty
  20979. </member>
  20980. <member name="T:NPOI.SS.Formula.Eval.Forked.ForkedEvaluationCell">
  20981. Represents a cell being used for forked Evaluation that has had a value Set different from the
  20982. corresponding cell in the shared master workbook.
  20983. @author Josh Micich
  20984. </member>
  20985. <member name="T:NPOI.SS.Formula.IEvaluationCell">
  20986. Abstracts a cell for the purpose of formula evaluation. This interface represents both formula
  20987. and non-formula cells.<br/>
  20988. Implementors of this class must implement {@link #HashCode()} and {@link #Equals(Object)}
  20989. To provide an <em>identity</em> relationship based on the underlying HSSF or XSSF cell <p/>
  20990. For POI internal use only
  20991. @author Josh Micich
  20992. </member>
  20993. <member name="F:NPOI.SS.Formula.Eval.Forked.ForkedEvaluationCell._masterCell">
  20994. corresponding cell from master workbook
  20995. </member>
  20996. <member name="T:NPOI.SS.Formula.Eval.Forked.ForkedEvaluationSheet">
  20997. Represents a sheet being used for forked Evaluation. Initially, objects of this class contain
  20998. only the cells from the master workbook. By calling {@link #getOrCreateUpdatableCell(int, int)},
  20999. the master cell object is logically Replaced with a {@link ForkedEvaluationCell} instance, which
  21000. will be used in all subsequent Evaluations.
  21001. @author Josh Micich
  21002. </member>
  21003. <member name="T:NPOI.SS.Formula.IEvaluationSheet">
  21004. Abstracts a sheet for the purpose of formula evaluation.<br/>
  21005. For POI internal use only
  21006. @author Josh Micich
  21007. </member>
  21008. <member name="M:NPOI.SS.Formula.IEvaluationSheet.GetCell(System.Int32,System.Int32)">
  21009. @return <c>null</c> if there is no cell at the specified coordinates
  21010. </member>
  21011. <member name="F:NPOI.SS.Formula.Eval.Forked.ForkedEvaluationSheet._sharedCellsByRowCol">
  21012. Only cells which have been split are Put in this map. (This has been done to conserve memory).
  21013. </member>
  21014. <member name="T:NPOI.SS.Formula.Eval.Forked.ForkedEvaluationWorkbook">
  21015. Represents a workbook being used for forked Evaluation. Most operations are delegated to the
  21016. shared master workbook, except those that potentially involve cell values that may have been
  21017. updated After a call to {@link #getOrCreateUpdatableCell(String, int, int)}.
  21018. @author Josh Micich
  21019. </member>
  21020. <member name="T:NPOI.SS.Formula.IEvaluationWorkbook">
  21021. Abstracts a workbook for the purpose of formula evaluation.<br/>
  21022. For POI internal use only
  21023. @author Josh Micich
  21024. </member>
  21025. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetSheetIndex(NPOI.SS.Formula.IEvaluationSheet)">
  21026. @return -1 if the specified sheet is from a different book
  21027. </member>
  21028. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetExternalSheet(System.Int32)">
  21029. HSSF Only - fetch the external-style sheet details
  21030. <p>Return will have no workbook set if it's actually in our own workbook</p>
  21031. </member>
  21032. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetExternalSheet(System.String,System.String,System.Int32)">
  21033. XSSF Only - fetch the external-style sheet details
  21034. <p>Return will have no workbook set if it's actually in our own workbook</p>
  21035. </member>
  21036. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.ConvertFromExternSheetIndex(System.Int32)">
  21037. HSSF Only - convert an external sheet index to an internal sheet index,
  21038. for an external-style reference to one of this workbook's own sheets
  21039. </member>
  21040. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetExternalName(System.Int32,System.Int32)">
  21041. HSSF Only - fetch the external-style name details
  21042. </member>
  21043. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetExternalName(System.String,System.String,System.Int32)">
  21044. XSSF Only - fetch the external-style name details
  21045. </member>
  21046. <member name="T:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator">
  21047. An alternative workbook Evaluator that saves memory in situations where a single workbook is
  21048. concurrently and independently Evaluated many times. With standard formula Evaluation, around
  21049. 90% of memory consumption is due to loading of the {@link HSSFWorkbook} or {@link NPOI.xssf.usermodel.XSSFWorkbook}.
  21050. This class enables a 'master workbook' to be loaded just once and shared between many Evaluation
  21051. clients. Each Evaluation client Creates its own {@link ForkedEvaluator} and can Set cell values
  21052. that will be used for local Evaluations (and don't disturb Evaluations on other Evaluators).
  21053. @author Josh Micich
  21054. </member>
  21055. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.Create(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier)">
  21056. @deprecated (Sep 2009) (reduce overloading) use {@link #Create(Workbook, IStabilityClassifier, UDFFinder)}
  21057. </member>
  21058. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.Create(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier,NPOI.SS.Formula.Udf.UDFFinder)">
  21059. @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
  21060. </member>
  21061. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.UpdateCell(System.String,System.Int32,System.Int32,NPOI.SS.Formula.Eval.ValueEval)">
  21062. Sets the specified cell to the supplied <tt>value</tt>
  21063. @param sheetName the name of the sheet Containing the cell
  21064. @param rowIndex zero based
  21065. @param columnIndex zero based
  21066. </member>
  21067. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.CopyUpdatedCells(NPOI.SS.UserModel.IWorkbook)">
  21068. Copies the values of all updated cells (modified by calls to {@link
  21069. #updateCell(String, int, int, ValueEval)}) to the supplied <tt>workbook</tt>.<br/>
  21070. Typically, the supplied <tt>workbook</tt> is a writable copy of the 'master workbook',
  21071. but at the very least it must contain sheets with the same names.
  21072. </member>
  21073. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.Evaluate(System.String,System.Int32,System.Int32)">
  21074. If cell Contains a formula, the formula is Evaluated and returned,
  21075. else the CellValue simply copies the appropriate cell value from
  21076. the cell and also its cell type. This method should be preferred over
  21077. EvaluateInCell() when the call should not modify the contents of the
  21078. original cell.
  21079. @param sheetName the name of the sheet Containing the cell
  21080. @param rowIndex zero based
  21081. @param columnIndex zero based
  21082. @return <code>null</code> if the supplied cell is <code>null</code> or blank
  21083. </member>
  21084. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.SetupEnvironment(System.String[],NPOI.SS.Formula.Eval.Forked.ForkedEvaluator[])">
  21085. Coordinates several formula Evaluators together so that formulas that involve external
  21086. references can be Evaluated.
  21087. @param workbookNames the simple file names used to identify the workbooks in formulas
  21088. with external links (for example "MyData.xls" as used in a formula "[MyData.xls]Sheet1!A1")
  21089. @param Evaluators all Evaluators for the full Set of workbooks required by the formulas.
  21090. </member>
  21091. <member name="T:NPOI.SS.Formula.Functions.Iserr">
  21092. contribute by Pavel Egorov
  21093. https://github.com/xoposhiy/npoi/commit/27b34a2389030c7115a666ace65daafda40d61af
  21094. Implementation of Excel <tt>ISERR()</tt> function.<p/>
  21095. <b>Syntax</b>:<br/>
  21096. <b>ISERR</b>(<b>value</b>)<p/>
  21097. <b>value</b> The value to be tested<p/>
  21098. Returns the logical value <tt>TRUE</tt> if value refers to any error value except
  21099. <tt>'#N/A'</tt>; otherwise, it returns <tt>FALSE</tt>.
  21100. </member>
  21101. <member name="T:NPOI.SS.Formula.Functions.LogicalFunction">
  21102. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  21103. </member>
  21104. <member name="M:NPOI.SS.Formula.Functions.LogicalFunction.Evaluate(NPOI.SS.Formula.Eval.ValueEval)">
  21105. @param arg any {@link ValueEval}, potentially {@link BlankEval} or {@link ErrorEval}.
  21106. </member>
  21107. <member name="T:NPOI.SS.Formula.PTG.SharedFormula">
  21108. Encapsulates logic to convert shared formulaa into non shared equivalent
  21109. </member>
  21110. <member name="M:NPOI.SS.Formula.PTG.SharedFormula.ConvertSharedFormulas(NPOI.SS.Formula.PTG.Ptg[],System.Int32,System.Int32)">
  21111. Creates a non shared formula from the shared formula counterpart, i.e.
  21112. Converts the shared formula into the equivalent {@link org.apache.poi.ss.formula.ptg.Ptg} array that it would have,
  21113. were it not shared.
  21114. @param ptgs parsed tokens of the shared formula
  21115. @param formulaRow
  21116. @param formulaColumn
  21117. </member>
  21118. <member name="F:NPOI.SS.UserModel.BorderDiagonal.None">
  21119. <summary>
  21120. No diagional border
  21121. </summary>
  21122. </member>
  21123. <member name="F:NPOI.SS.UserModel.BorderDiagonal.Backward">
  21124. <summary>
  21125. Backward diagional border, from left-top to right-bottom
  21126. </summary>
  21127. </member>
  21128. <member name="F:NPOI.SS.UserModel.BorderDiagonal.Forward">
  21129. <summary>
  21130. Forward diagional border, from right-top to left-bottom
  21131. </summary>
  21132. </member>
  21133. <member name="F:NPOI.SS.UserModel.BorderDiagonal.Both">
  21134. <summary>
  21135. Both forward and backward diagional border
  21136. </summary>
  21137. </member>
  21138. <member name="M:NPOI.SS.UserModel.Charts.IChartDataSource`1.GetPointAt(System.Int32)">
  21139. Returns point value at specified index.
  21140. @param index index to value from
  21141. @return point value at specified index.
  21142. @throws {@code IndexOutOfBoundsException} if index
  21143. parameter not in range {@code 0 &lt;= index &lt;= pointCount}
  21144. </member>
  21145. <member name="P:NPOI.SS.UserModel.Charts.IChartDataSource`1.PointCount">
  21146. Return number of points contained by data source.
  21147. @return number of points contained by data source
  21148. </member>
  21149. <member name="P:NPOI.SS.UserModel.Charts.IChartDataSource`1.IsReference">
  21150. Returns {@code true} if charts data source is valid cell range.
  21151. @return {@code true} if charts data source is valid cell range
  21152. </member>
  21153. <member name="P:NPOI.SS.UserModel.Charts.IChartDataSource`1.IsNumeric">
  21154. Returns {@code true} if data source points should be treated as numbers.
  21155. @return {@code true} if data source points should be treated as numbers
  21156. </member>
  21157. <member name="P:NPOI.SS.UserModel.Charts.IChartDataSource`1.FormulaString">
  21158. Returns formula representation of the data source. It is only applicable
  21159. for data source that is valid cell range.
  21160. @return formula representation of the data source
  21161. @throws {@code UnsupportedOperationException} if the data source is not a
  21162. reference.
  21163. </member>
  21164. <member name="M:NPOI.SS.UserModel.Charts.IChartSeries.SetTitle(System.String)">
  21165. Sets the title of the series as a string literal.
  21166. @param title
  21167. </member>
  21168. <member name="M:NPOI.SS.UserModel.Charts.IChartSeries.SetTitle(NPOI.SS.Util.CellReference)">
  21169. Sets the title of the series as a cell reference.
  21170. @param titleReference
  21171. </member>
  21172. <member name="M:NPOI.SS.UserModel.Charts.IChartSeries.GetTitleString">
  21173. @return title as string literal.
  21174. </member>
  21175. <member name="M:NPOI.SS.UserModel.Charts.IChartSeries.GetTitleCellReference">
  21176. @return title as cell reference.
  21177. </member>
  21178. <member name="M:NPOI.SS.UserModel.Charts.IChartSeries.GetTitleType">
  21179. @return title type.
  21180. </member>
  21181. <member name="T:NPOI.SS.UserModel.Charts.ILineChartData`2">
  21182. <summary>
  21183. Data for a Line Chart
  21184. </summary>
  21185. <typeparam name="Tx"></typeparam>
  21186. <typeparam name="Ty"></typeparam>
  21187. </member>
  21188. <member name="T:NPOI.SS.UserModel.Charts.IChartData">
  21189. <summary>
  21190. A base for all chart data types.
  21191. </summary>
  21192. <remarks>
  21193. @author Roman Kashitsyn
  21194. </remarks>
  21195. </member>
  21196. <member name="M:NPOI.SS.UserModel.Charts.IChartData.FillChart(NPOI.SS.UserModel.IChart,NPOI.SS.UserModel.Charts.IChartAxis[])">
  21197. <summary>
  21198. Fills a chart with data specified by implementation.
  21199. </summary>
  21200. <param name="chart">a chart to fill in</param>
  21201. <param name="axis">chart axis to use</param>
  21202. </member>
  21203. <member name="M:NPOI.SS.UserModel.Charts.ILineChartData`2.GetSeries">
  21204. @return list of all series.
  21205. </member>
  21206. <member name="M:NPOI.SS.UserModel.Charts.ILineChartSeries`2.GetCategoryAxisData">
  21207. @return data source used for category axis data.
  21208. </member>
  21209. <member name="M:NPOI.SS.UserModel.Charts.ILineChartSeries`2.GetValues">
  21210. @return data source used for value axis.
  21211. </member>
  21212. <member name="T:NPOI.SS.UserModel.DataConsolidateFunction">
  21213. Enum mapping the values of STDataConsolidateFunction
  21214. </member>
  21215. <member name="T:NPOI.SS.UserModel.FontUnderline">
  21216. the different types of possible underline formatting
  21217. @author Gisella Bronzetti
  21218. </member>
  21219. <member name="F:NPOI.SS.UserModel.FontUnderline.SINGLE">
  21220. Single-line underlining under each character in the cell.
  21221. The underline is drawn through the descenders of
  21222. characters such as g and p..
  21223. </member>
  21224. <member name="F:NPOI.SS.UserModel.FontUnderline.DOUBLE">
  21225. Double-line underlining under each character in the
  21226. cell. underlines are drawn through the descenders of
  21227. characters such as g and p.
  21228. </member>
  21229. <member name="F:NPOI.SS.UserModel.FontUnderline.SINGLE_ACCOUNTING">
  21230. Single-line accounting underlining under each
  21231. character in the cell. The underline is drawn under the
  21232. descenders of characters such as g and p.
  21233. </member>
  21234. <member name="F:NPOI.SS.UserModel.FontUnderline.DOUBLE_ACCOUNTING">
  21235. Double-line accounting underlining under each
  21236. character in the cell. The underlines are drawn under
  21237. the descenders of characters such as g and p.
  21238. </member>
  21239. <member name="F:NPOI.SS.UserModel.FontUnderline.NONE">
  21240. No underline.
  21241. </member>
  21242. <member name="T:NPOI.SS.UserModel.FractionFormat">
  21243. <p>Format class that handles Excel style fractions, such as "# #/#" and "#/###"</p>
  21244. <p>As of this writing, this is still not 100% accurate, but it does a reasonable job
  21245. of trying to mimic Excel's fraction calculations. It does not currently
  21246. maintain Excel's spacing.</p>
  21247. <p>This class relies on a method lifted nearly verbatim from org.apache.math.fraction.
  21248. If further uses for Commons Math are found, we will consider Adding it as a dependency.
  21249. For now, we have in-lined the one method to keep things simple.</p>
  21250. </member>
  21251. <member name="T:NPOI.SS.Util.FormatBase">
  21252. <summary>
  21253. A substitute class for Format class in Java
  21254. </summary>
  21255. </member>
  21256. <member name="M:NPOI.SS.UserModel.FractionFormat.#ctor(System.String,System.String)">
  21257. Single parameter ctor
  21258. @param denomFormatString The format string for the denominator
  21259. </member>
  21260. <member name="F:NPOI.SS.Format.SimpleFraction.denominator">
  21261. The denominator.
  21262. </member>
  21263. <member name="F:NPOI.SS.Format.SimpleFraction.numerator">
  21264. The numerator.
  21265. </member>
  21266. <member name="M:NPOI.SS.Format.SimpleFraction.BuildFractionExactDenominator(System.Double,System.Int32)">
  21267. Create a fraction given a double value and a denominator.
  21268. @param val double value of fraction
  21269. @param exactDenom the exact denominator
  21270. @return a SimpleFraction with the given values set.
  21271. </member>
  21272. <member name="M:NPOI.SS.Format.SimpleFraction.BuildFractionMaxDenominator(System.Double,System.Int32)">
  21273. Create a fraction given the double value and either the maximum error
  21274. allowed or the maximum number of denominator digits.
  21275. @param value the double value to convert to a fraction.
  21276. @param maxDenominator maximum denominator value allowed.
  21277. @throws RuntimeException if the continued fraction failed to
  21278. converge.
  21279. @throws IllegalArgumentException if value > Integer.MAX_VALUE
  21280. </member>
  21281. <member name="M:NPOI.SS.Format.SimpleFraction.BuildFractionMaxDenominator(System.Double,System.Double,System.Int32,System.Int32)">
  21282. Create a fraction given the double value and either the maximum error
  21283. allowed or the maximum number of denominator digits.
  21284. <p>
  21285. References:
  21286. <ul>
  21287. <li><a href="http://mathworld.wolfram.com/ContinuedFraction.html">
  21288. Continued Fraction</a> equations (11) and (22)-(26)</li>
  21289. </ul>
  21290. </p>
  21291. Based on org.apache.commons.math.fraction.Fraction from Apache Commons-Math.
  21292. YK: The only reason of having this class is to avoid dependency on the Commons-Math jar.
  21293. @param value the double value to convert to a fraction.
  21294. @param epsilon maximum error allowed. The resulting fraction is within
  21295. <code>epsilon</code> of <code>value</code>, in absolute terms.
  21296. @param maxDenominator maximum denominator value allowed.
  21297. @param maxIterations maximum number of convergents
  21298. @throws RuntimeException if the continued fraction failed to
  21299. converge.
  21300. @throws IllegalArgumentException if value > Integer.MAX_VALUE
  21301. </member>
  21302. <member name="M:NPOI.SS.Format.SimpleFraction.#ctor(System.Int32,System.Int32)">
  21303. Create a fraction given a numerator and denominator.
  21304. @param numerator
  21305. @param denominator maxDenominator The maximum allowed value for denominator
  21306. </member>
  21307. <member name="P:NPOI.SS.Format.SimpleFraction.Denominator">
  21308. Access the denominator.
  21309. @return the denominator.
  21310. </member>
  21311. <member name="P:NPOI.SS.Format.SimpleFraction.Numerator">
  21312. Access the numerator.
  21313. @return the numerator.
  21314. </member>
  21315. <member name="T:NPOI.SS.Util.DataMarker">
  21316. <summary>
  21317. Represents data marker used in charts.
  21318. @author Roman Kashitsyn
  21319. </summary>
  21320. </member>
  21321. <member name="M:NPOI.SS.Util.DataMarker.#ctor(NPOI.SS.UserModel.ISheet,NPOI.SS.Util.CellRangeAddress)">
  21322. <summary>
  21323. constructor
  21324. </summary>
  21325. <param name="sheet">the sheet where data located.</param>
  21326. <param name="range">the range within that sheet.</param>
  21327. </member>
  21328. <member name="M:NPOI.SS.Util.DataMarker.FormatAsString">
  21329. <summary>
  21330. Formats data marker using canonical format, for example
  21331. 'SheetName!$A$1:$A$5'.
  21332. </summary>
  21333. <returns>formatted data marker</returns>
  21334. </member>
  21335. <member name="P:NPOI.SS.Util.DataMarker.Sheet">
  21336. <summary>
  21337. get or set the sheet marker points to.
  21338. </summary>
  21339. </member>
  21340. <member name="P:NPOI.SS.Util.DataMarker.Range">
  21341. <summary>
  21342. get or set range of the marker.
  21343. </summary>
  21344. </member>
  21345. <member name="T:NPOI.SS.Util.DateFormatConverter">
  21346. Convert DateFormat patterns into Excel custom number formats.
  21347. For example, to format a date in excel using the "dd MMMM, yyyy" pattern and Japanese
  21348. locale, use the following code:
  21349. <pre><code>
  21350. // returns "[$-0411]dd MMMM, yyyy;@" where the [$-0411] prefix tells Excel to use the Japanese locale
  21351. String excelFormatPattern = DateFormatConverter.convert(Locale.JAPANESE, "dd MMMM, yyyy");
  21352. CellStyle cellStyle = workbook.createCellStyle();
  21353. DataFormat poiFormat = workbook.createDataFormat();
  21354. cellStyle.setDataFormat(poiFormat.getFormat(excelFormatPattern));
  21355. cell.setCellValue(new Date());
  21356. cell.setCellStyle(cellStyle); // formats date as '2012\u5e743\u670817\u65e5'
  21357. </code></pre>
  21358. </member>
  21359. <member name="T:NPOI.SS.Util.ImageUtils">
  21360. @author Yegor Kozlov
  21361. </member>
  21362. <member name="M:NPOI.SS.Util.ImageUtils.GetImageDimension(System.IO.Stream,NPOI.SS.UserModel.PictureType)">
  21363. Return the dimension of this image
  21364. @param is the stream Containing the image data
  21365. @param type type of the picture: {@link NPOI.SS.UserModel.Workbook#PICTURE_TYPE_JPEG},
  21366. {@link NPOI.SS.UserModel.Workbook#PICTURE_TYPE_PNG} or {@link NPOI.SS.UserModel.Workbook#PICTURE_TYPE_DIB}
  21367. @return image dimension in pixels
  21368. </member>
  21369. <member name="M:NPOI.SS.Util.ImageUtils.GetResolution(System.Drawing.Image)">
  21370. The metadata of PNG and JPEG can contain the width of a pixel in millimeters.
  21371. Return the the "effective" dpi calculated as <code>25.4/HorizontalPixelSize</code>
  21372. and <code>25.4/VerticalPixelSize</code>. Where 25.4 is the number of mm in inch.
  21373. @return array of two elements: <code>{horisontalPdi, verticalDpi}</code>.
  21374. {96, 96} is the default.
  21375. </member>
  21376. <member name="M:NPOI.SS.Util.ImageUtils.SetPreferredSize(NPOI.SS.UserModel.IPicture,System.Double,System.Double)">
  21377. Calculate and Set the preferred size (anchor) for this picture.
  21378. @param scaleX the amount by which image width is multiplied relative to the original width.
  21379. @param scaleY the amount by which image height is multiplied relative to the original height.
  21380. @return the new Dimensions of the scaled picture in EMUs
  21381. </member>
  21382. <member name="M:NPOI.SS.Util.ImageUtils.GetDimensionFromAnchor(NPOI.SS.UserModel.IPicture)">
  21383. Calculates the dimensions in EMUs for the anchor of the given picture
  21384. @param picture the picture Containing the anchor
  21385. @return the dimensions in EMUs
  21386. </member>
  21387. <member name="T:NPOI.Util.BlockingInputStream">
  21388. Implementation of a BlockingInputStream to provide data to
  21389. RawDataBlock that expects data in 512 byte chunks. Useful to read
  21390. data from slow (ie, non FileInputStream) sources, for example when
  21391. Reading an OLE2 Document over a network.
  21392. Possible extentions: add a timeout. Curently a call to Read(byte[]) on this
  21393. class is blocking, so use at your own peril if your underlying stream blocks.
  21394. @author Jens Gerhard
  21395. @author aviks - documentation cleanups.
  21396. </member>
  21397. <member name="M:NPOI.Util.BlockingInputStream.Read(System.Byte[])">
  21398. We had to revert to byte per byte Reading to keep
  21399. with slow network connections on one hand, without
  21400. missing the end-of-file.
  21401. This is the only method that does its own thing in this class
  21402. everything else is delegated to aggregated stream.
  21403. THIS IS A BLOCKING BLOCK READ!!!
  21404. </member>
  21405. <member name="M:NPOI.Util.ByteBuffer.Remaining">
  21406. <summary>
  21407. Returns the number of elements between the current position and the limit.
  21408. </summary>
  21409. <returns>The number of elements remaining in this buffer</returns>
  21410. </member>
  21411. <member name="M:NPOI.Util.ByteBuffer.HasRemaining">
  21412. <summary>
  21413. Tells whether there are any elements between the current position and the limit.
  21414. </summary>
  21415. <returns>true if, and only if, there is at least one element remaining in this buffer</returns>
  21416. </member>
  21417. <member name="T:NPOI.Util.ClassID">
  21418. <summary>
  21419. Represents a class ID (16 bytes). Unlike other little-endian
  21420. type the {@link ClassID} is not just 16 bytes stored in the wrong
  21421. order. Instead, it is a double word (4 bytes) followed by two
  21422. words (2 bytes each) followed by 8 bytes.
  21423. @author Rainer Klute
  21424. <a href="mailto:klute@rainer-klute.de">klute@rainer-klute.de</a>
  21425. @version $Id: ClassID.java 489730 2006-12-22 19:18:16Z bayard $
  21426. @since 2002-02-09
  21427. </summary>
  21428. </member>
  21429. <member name="F:NPOI.Util.ClassID.LENGTH">
  21430. The number of bytes occupied by this object in the byte
  21431. stream.
  21432. </member>
  21433. <member name="F:NPOI.Util.ClassID.bytes">
  21434. The bytes making out the class ID in correct order,
  21435. i.e. big-endian.
  21436. </member>
  21437. <member name="M:NPOI.Util.ClassID.#ctor(System.Byte[],System.Int32)">
  21438. <summary>
  21439. Creates a <see cref="T:NPOI.Util.ClassID"/> and Reads its value from a byte array.
  21440. </summary>
  21441. <param name="src">The byte array to Read from.</param>
  21442. <param name="offset">The offset of the first byte to Read.</param>
  21443. </member>
  21444. <member name="M:NPOI.Util.ClassID.#ctor">
  21445. <summary>
  21446. Creates a <see cref="T:NPOI.Util.ClassID"/> and initializes its value with 0x00 bytes.
  21447. </summary>
  21448. </member>
  21449. <member name="M:NPOI.Util.ClassID.#ctor(System.String)">
  21450. <p>Creates a {@link ClassID} from a human-readable representation of the Class ID in standard
  21451. format <code>"{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}"</code>.</p>
  21452. @param externalForm representation of the Class ID represented by this object.
  21453. </member>
  21454. <member name="M:NPOI.Util.ClassID.Read(System.Byte[],System.Int32)">
  21455. <summary>
  21456. Reads the class ID's value from a byte array by turning little-endian into big-endian.
  21457. </summary>
  21458. <param name="src">The byte array to Read from</param>
  21459. <param name="offset">The offset within the </param>
  21460. <returns>A byte array containing the class ID.</returns>
  21461. </member>
  21462. <member name="M:NPOI.Util.ClassID.Write(System.Byte[],System.Int32)">
  21463. <summary>
  21464. Writes the class ID to a byte array in the little-endian format.
  21465. </summary>
  21466. <param name="dst">The byte array to Write to.</param>
  21467. <param name="offset">The offset within the </param>
  21468. </member>
  21469. <member name="M:NPOI.Util.ClassID.Equals(System.Object)">
  21470. <summary>
  21471. Checks whether this ClassID is equal to another
  21472. object.
  21473. </summary>
  21474. <param name="o">the object to compare this PropertySet with</param>
  21475. <returns>true if the objects are equal, else
  21476. false</returns>
  21477. </member>
  21478. <member name="M:NPOI.Util.ClassID.GetHashCode">
  21479. <summary>
  21480. Serves as a hash function for a particular type.
  21481. </summary>
  21482. <returns>
  21483. A hash code for the current <see cref="T:System.Object"/>.
  21484. </returns>
  21485. </member>
  21486. <member name="M:NPOI.Util.ClassID.ToString">
  21487. <summary>
  21488. Returns a human-Readable representation of the Class ID in standard
  21489. format <c>"{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}"</c>.
  21490. </summary>
  21491. <returns>
  21492. A String representation of the Class ID represented by this object..
  21493. </returns>
  21494. </member>
  21495. <member name="P:NPOI.Util.ClassID.Length">
  21496. <summary>
  21497. Gets the length.
  21498. </summary>
  21499. <value>The number of bytes occupied by this object in the byte stream.</value>
  21500. </member>
  21501. <member name="P:NPOI.Util.ClassID.Bytes">
  21502. <summary>
  21503. Gets or sets the bytes making out the class ID. They are returned in correct order, i.e. big-endian.
  21504. </summary>
  21505. <value>the bytes making out the class ID..</value>
  21506. </member>
  21507. <member name="T:NPOI.POIFS.FileSystem.DirectoryNode">
  21508. <summary>
  21509. Simple implementation of DirectoryEntry
  21510. @author Marc Johnson (mjohnson at apache dot org)
  21511. </summary>
  21512. </member>
  21513. <member name="T:NPOI.POIFS.FileSystem.EntryNode">
  21514. <summary>
  21515. Abstract implementation of Entry
  21516. Extending classes should override isDocument() or isDirectory(), as
  21517. appropriate
  21518. Extending classes must override isDeleteOK()
  21519. @author Marc Johnson (mjohnson at apache dot org)
  21520. </summary>
  21521. </member>
  21522. <member name="M:NPOI.POIFS.FileSystem.EntryNode.#ctor(NPOI.POIFS.Properties.Property,NPOI.POIFS.FileSystem.DirectoryNode)">
  21523. <summary>
  21524. Create a DocumentNode. ThIs method Is not public by design; it
  21525. Is intended strictly for the internal use of extending classes
  21526. </summary>
  21527. <param name="property">the Property for this Entry</param>
  21528. <param name="parent">the parent of this entry</param>
  21529. </member>
  21530. <member name="M:NPOI.POIFS.FileSystem.EntryNode.Delete">
  21531. <summary>
  21532. Delete this Entry. ThIs operation should succeed, but there are
  21533. special circumstances when it will not:
  21534. If this Entry Is the root of the Entry tree, it cannot be
  21535. deleted, as there Is no way to Create another one.
  21536. If this Entry Is a directory, it cannot be deleted unless it Is
  21537. empty.
  21538. </summary>
  21539. <returns>
  21540. true if the Entry was successfully deleted, else false
  21541. </returns>
  21542. </member>
  21543. <member name="M:NPOI.POIFS.FileSystem.EntryNode.RenameTo(System.String)">
  21544. <summary>
  21545. Rename this Entry. ThIs operation will fail if:
  21546. There Is a sibling Entry (i.e., an Entry whose parent Is the
  21547. same as this Entry's parent) with the same name.
  21548. ThIs Entry Is the root of the Entry tree. Its name Is dictated
  21549. by the Filesystem and many not be Changed.
  21550. </summary>
  21551. <param name="newName">the new name for this Entry</param>
  21552. <returns>
  21553. true if the operation succeeded, else false
  21554. </returns>
  21555. </member>
  21556. <member name="P:NPOI.POIFS.FileSystem.EntryNode.Property">
  21557. <summary>
  21558. grant access to the property
  21559. </summary>
  21560. <value>the property backing this entry</value>
  21561. </member>
  21562. <member name="P:NPOI.POIFS.FileSystem.EntryNode.IsRoot">
  21563. <summary>
  21564. Is this the root of the tree?
  21565. </summary>
  21566. <value><c>true</c> if this instance is root; otherwise, <c>false</c>.</value>
  21567. </member>
  21568. <member name="P:NPOI.POIFS.FileSystem.EntryNode.IsDeleteOK">
  21569. <summary>
  21570. extensions use this method to verify internal rules regarding
  21571. deletion of the underlying store.
  21572. </summary>
  21573. <value>
  21574. <c>true</c> if it's ok to Delete the underlying store; otherwise, <c>false</c>.
  21575. </value>
  21576. </member>
  21577. <member name="P:NPOI.POIFS.FileSystem.EntryNode.Name">
  21578. <summary>
  21579. Get the name of the Entry
  21580. </summary>
  21581. <value>The name.</value>
  21582. Get the name of the Entry
  21583. @return name
  21584. </member>
  21585. <member name="P:NPOI.POIFS.FileSystem.EntryNode.IsDirectoryEntry">
  21586. <summary>
  21587. Is this a DirectoryEntry?
  21588. </summary>
  21589. <value>
  21590. <c>true</c> if the Entry Is a DirectoryEntry; otherwise, <c>false</c>.
  21591. </value>
  21592. </member>
  21593. <member name="P:NPOI.POIFS.FileSystem.EntryNode.IsDocumentEntry">
  21594. <summary>
  21595. Is this a DocumentEntry?
  21596. </summary>
  21597. <value>
  21598. <c>true</c> if the Entry Is a DocumentEntry; otherwise, <c>false</c>.
  21599. </value>
  21600. </member>
  21601. <member name="P:NPOI.POIFS.FileSystem.EntryNode.Parent">
  21602. <summary>
  21603. Get this Entry's parent (the DocumentEntry that owns this
  21604. Entry). All Entry objects, except the root Entry, has a parent.
  21605. </summary>
  21606. <value>this Entry's parent; null iff this Is the root Entry</value>
  21607. </member>
  21608. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.#ctor(NPOI.POIFS.Properties.DirectoryProperty,NPOI.POIFS.FileSystem.NPOIFSFileSystem,NPOI.POIFS.FileSystem.DirectoryNode)">
  21609. <summary>
  21610. Create a DirectoryNode. This method Is not public by design; it
  21611. Is intended strictly for the internal use of this package
  21612. </summary>
  21613. <param name="property">the DirectoryProperty for this DirectoryEntry</param>
  21614. <param name="nFileSystem">the POIFSFileSystem we belong to</param>
  21615. <param name="parent">the parent of this entry</param>
  21616. </member>
  21617. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.CreatePOIFSDocumentReader(System.String)">
  21618. <summary>
  21619. open a document in the directory's entry's list of entries
  21620. </summary>
  21621. <param name="documentName">the name of the document to be opened</param>
  21622. <returns>a newly opened DocumentStream</returns>
  21623. </member>
  21624. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.CreateDocument(NPOI.POIFS.FileSystem.POIFSDocument)">
  21625. <summary>
  21626. Create a new DocumentEntry; the data will be provided later
  21627. </summary>
  21628. <param name="document">the name of the new documentEntry</param>
  21629. <returns>the new DocumentEntry</returns>
  21630. </member>
  21631. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.ChangeName(System.String,System.String)">
  21632. <summary>
  21633. Change a contained Entry's name
  21634. </summary>
  21635. <param name="oldName">the original name</param>
  21636. <param name="newName">the new name</param>
  21637. <returns>true if the operation succeeded, else false</returns>
  21638. </member>
  21639. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.DeleteEntry(NPOI.POIFS.FileSystem.EntryNode)">
  21640. <summary>
  21641. Deletes the entry.
  21642. </summary>
  21643. <param name="entry">the EntryNode to be Deleted</param>
  21644. <returns>true if the entry was Deleted, else false</returns>
  21645. </member>
  21646. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.GetEntry(System.String)">
  21647. <summary>
  21648. get a specified Entry by name
  21649. </summary>
  21650. <param name="name">the name of the Entry to obtain.</param>
  21651. <returns>
  21652. the specified Entry, if it is directly contained in
  21653. this DirectoryEntry
  21654. </returns>
  21655. </member>
  21656. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.CreateDirectory(System.String)">
  21657. <summary>
  21658. Create a new DirectoryEntry
  21659. </summary>
  21660. <param name="name">the name of the new DirectoryEntry</param>
  21661. <returns>the name of the new DirectoryEntry</returns>
  21662. </member>
  21663. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.Path">
  21664. <summary>
  21665. Gets the path.
  21666. </summary>
  21667. <value>this directory's path representation</value>
  21668. </member>
  21669. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.Entries">
  21670. <summary>
  21671. get an iterator of the Entry instances contained directly in
  21672. this instance (in other words, children only; no grandchildren
  21673. etc.)
  21674. </summary>
  21675. <value>
  21676. The entries.never null, but hasNext() may return false
  21677. immediately (i.e., this DirectoryEntry is empty). All
  21678. objects retrieved by next() are guaranteed to be
  21679. implementations of Entry.
  21680. </value>
  21681. </member>
  21682. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.EntryNames">
  21683. get the names of all the Entries contained directly in this
  21684. instance (in other words, names of children only; no grandchildren
  21685. etc).
  21686. @return the names of all the entries that may be retrieved with
  21687. getEntry(String), which may be empty (if this
  21688. DirectoryEntry is empty)
  21689. </member>
  21690. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.IsEmpty">
  21691. <summary>
  21692. is this DirectoryEntry empty?
  21693. </summary>
  21694. <value>
  21695. <c>true</c> if this instance contains no Entry instances; otherwise, <c>false</c>.
  21696. </value>
  21697. </member>
  21698. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.EntryCount">
  21699. <summary>
  21700. find out how many Entry instances are contained directly within
  21701. this DirectoryEntry
  21702. </summary>
  21703. <value>
  21704. number of immediately (no grandchildren etc.) contained
  21705. Entry instances
  21706. </value>
  21707. </member>
  21708. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.StorageClsid">
  21709. <summary>
  21710. Gets or Sets the storage clsid for the directory entry
  21711. </summary>
  21712. <value>The storage ClassID.</value>
  21713. </member>
  21714. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.IsDirectoryEntry">
  21715. <summary>
  21716. Is this a DirectoryEntry?
  21717. </summary>
  21718. <value>true if the Entry Is a DirectoryEntry, else false</value>
  21719. </member>
  21720. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.IsDeleteOK">
  21721. <summary>
  21722. extensions use this method to verify internal rules regarding
  21723. deletion of the underlying store.
  21724. </summary>
  21725. <value> true if it's ok to Delete the underlying store, else
  21726. false</value>
  21727. </member>
  21728. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.ViewableArray">
  21729. <summary>
  21730. Get an array of objects, some of which may implement POIFSViewable
  21731. </summary>
  21732. <value>an array of Object; may not be null, but may be empty</value>
  21733. </member>
  21734. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.ViewableIterator">
  21735. <summary>
  21736. Get an Iterator of objects, some of which may implement
  21737. POIFSViewable
  21738. </summary>
  21739. <value>an Iterator; may not be null, but may have an empty
  21740. back end store</value>
  21741. </member>
  21742. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.PreferArray">
  21743. <summary>
  21744. Give viewers a hint as to whether to call GetViewableArray or
  21745. GetViewableIterator
  21746. </summary>
  21747. <value><c>true</c> if a viewer should call GetViewableArray; otherwise, <c>false</c>if
  21748. a viewer should call GetViewableIterator</value>
  21749. </member>
  21750. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.ShortDescription">
  21751. <summary>
  21752. Provides a short description of the object, to be used when a
  21753. POIFSViewable object has not provided its contents.
  21754. </summary>
  21755. <value>The short description.</value>
  21756. </member>
  21757. <member name="T:NPOI.POIFS.FileSystem.DocumentDescriptor">
  21758. <summary>
  21759. Class DocumentDescriptor
  21760. @author Marc Johnson (mjohnson at apache dot org)
  21761. </summary>
  21762. </member>
  21763. <member name="M:NPOI.POIFS.FileSystem.DocumentDescriptor.#ctor(NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String)">
  21764. <summary>
  21765. Initializes a new instance of the <see cref="T:NPOI.POIFS.FileSystem.DocumentDescriptor"/> class.
  21766. </summary>
  21767. <param name="path">the Document path</param>
  21768. <param name="name">the Document name</param>
  21769. </member>
  21770. <member name="M:NPOI.POIFS.FileSystem.DocumentDescriptor.Equals(System.Object)">
  21771. <summary>
  21772. equality. Two DocumentDescriptor instances are equal if they
  21773. have equal paths and names
  21774. </summary>
  21775. <param name="o">the object we're checking equality for</param>
  21776. <returns>true if the object is equal to this object</returns>
  21777. </member>
  21778. <member name="M:NPOI.POIFS.FileSystem.DocumentDescriptor.GetHashCode">
  21779. <summary>
  21780. Serves as a hash function for a particular type.
  21781. </summary>
  21782. <returns>
  21783. hashcode
  21784. </returns>
  21785. </member>
  21786. <member name="M:NPOI.POIFS.FileSystem.DocumentDescriptor.ToString">
  21787. <summary>
  21788. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  21789. </summary>
  21790. <returns>
  21791. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  21792. </returns>
  21793. </member>
  21794. <member name="P:NPOI.POIFS.FileSystem.DocumentDescriptor.Path">
  21795. <summary>
  21796. Gets the path.
  21797. </summary>
  21798. <value>The path.</value>
  21799. </member>
  21800. <member name="P:NPOI.POIFS.FileSystem.DocumentDescriptor.Name">
  21801. <summary>
  21802. Gets the name.
  21803. </summary>
  21804. <value>The name.</value>
  21805. </member>
  21806. <member name="T:NPOI.POIFS.FileSystem.DocumentEntry">
  21807. <summary>
  21808. This interface defines methods specific to Document objects
  21809. managed by a Filesystem instance.
  21810. @author Marc Johnson (mjohnson at apache dot org)
  21811. </summary>
  21812. </member>
  21813. <member name="P:NPOI.POIFS.FileSystem.DocumentEntry.Size">
  21814. <summary>
  21815. get the size of the document, in bytes
  21816. </summary>
  21817. <value>size in bytes</value>
  21818. </member>
  21819. <member name="T:NPOI.POIFS.FileSystem.DocumentNode">
  21820. <summary>
  21821. Simple implementation of DocumentEntry
  21822. @author Marc Johnson (mjohnson at apache dot org)
  21823. </summary>
  21824. </member>
  21825. <member name="M:NPOI.POIFS.FileSystem.DocumentNode.#ctor(NPOI.POIFS.Properties.DocumentProperty,NPOI.POIFS.FileSystem.DirectoryNode)">
  21826. create a DocumentNode. This method Is not public by design; it
  21827. Is intended strictly for the internal use of this package
  21828. @param property the DocumentProperty for this DocumentEntry
  21829. @param parent the parent of this entry
  21830. </member>
  21831. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.Document">
  21832. get the POIFSDocument
  21833. @return the internal POIFSDocument
  21834. </member>
  21835. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.Size">
  21836. get the zize of the document, in bytes
  21837. @return size in bytes
  21838. </member>
  21839. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.IsDocumentEntry">
  21840. Is this a DocumentEntry?
  21841. @return true if the Entry Is a DocumentEntry, else false
  21842. </member>
  21843. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.IsDeleteOK">
  21844. extensions use this method to verify internal rules regarding
  21845. deletion of the underlying store.
  21846. @return true if it's ok to delete the underlying store, else
  21847. false
  21848. </member>
  21849. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.ViewableArray">
  21850. Get an array of objects, some of which may implement
  21851. POIFSViewable
  21852. @return an array of Object; may not be null, but may be empty
  21853. </member>
  21854. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.ViewableIterator">
  21855. Get an Iterator of objects, some of which may implement
  21856. POIFSViewable
  21857. @return an Iterator; may not be null, but may have an empty
  21858. back end store
  21859. </member>
  21860. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.PreferArray">
  21861. Give viewers a hint as to whether to call getViewableArray or
  21862. getViewableIterator
  21863. @return true if a viewer should call getViewableArray, false if
  21864. a viewer should call getViewableIterator
  21865. </member>
  21866. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.ShortDescription">
  21867. Provides a short description of the object, to be used when a
  21868. POIFSViewable object has not provided its contents.
  21869. @return short description
  21870. </member>
  21871. <member name="T:NPOI.POIFS.FileSystem.OfficeXmlFileException">
  21872. <summary>
  21873. This exception is thrown when we try to open a file that's actually
  21874. an Office 2007+ XML file, rather than an OLE2 file (which is what
  21875. POIFS works with)
  21876. </summary>
  21877. </member>
  21878. <member name="T:NPOI.POIFS.FileSystem.Ole10Native">
  21879. Represents an Ole10Native record which is wrapped around certain binary
  21880. files being embedded in OLE2 documents.
  21881. @author Rainer Schwarze
  21882. </member>
  21883. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.CreateFromEmbeddedOleObject(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  21884. <summary>
  21885. Creates an instance of this class from an embedded OLE Object. The OLE Object is expected
  21886. to include a stream &quot;{01}Ole10Native&quot; which Contains the actual
  21887. data relevant for this class.
  21888. </summary>
  21889. <param name="poifs">poifs POI Filesystem object</param>
  21890. <returns>Returns an instance of this class</returns>
  21891. </member>
  21892. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.CreateFromEmbeddedOleObject(NPOI.POIFS.FileSystem.DirectoryNode)">
  21893. <summary>
  21894. Creates an instance of this class from an embedded OLE Object. The OLE Object is expected
  21895. to include a stream &quot;{01}Ole10Native&quot; which contains the actual
  21896. data relevant for this class.
  21897. </summary>
  21898. <param name="directory">directory POI Filesystem object</param>
  21899. <returns>Returns an instance of this class</returns>
  21900. </member>
  21901. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.#ctor(System.String,System.String,System.String,System.Byte[])">
  21902. Creates an instance and fills the fields based on ... the fields
  21903. </member>
  21904. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.#ctor(System.Byte[],System.Int32,System.Boolean)">
  21905. Creates an instance and Fills the fields based on the data in the given buffer.
  21906. @param data The buffer Containing the Ole10Native record
  21907. @param offset The start offset of the record in the buffer
  21908. @param plain as of POI 3.11 this parameter is ignored
  21909. @throws Ole10NativeException on invalid or unexcepted data format
  21910. </member>
  21911. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.#ctor(System.Byte[],System.Int32)">
  21912. Creates an instance and Fills the fields based on the data in the given buffer.
  21913. @param data The buffer Containing the Ole10Native record
  21914. @param offset The start offset of the record in the buffer
  21915. @throws Ole10NativeException on invalid or unexcepted data format
  21916. </member>
  21917. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.WriteOut(System.IO.Stream)">
  21918. Have the contents printer out into an OutputStream, used when writing a
  21919. file back out to disk (Normally, atom classes will keep their bytes
  21920. around, but non atom classes will just request the bytes from their
  21921. children, then chuck on their header and return)
  21922. </member>
  21923. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.TotalSize">
  21924. Returns the value of the totalSize field - the total length of the structure
  21925. is totalSize + 4 (value of this field + size of this field).
  21926. @return the totalSize
  21927. </member>
  21928. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Flags1">
  21929. Returns flags1 - currently unknown - usually 0x0002.
  21930. @return the flags1
  21931. </member>
  21932. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Label">
  21933. Returns the label field - usually the name of the file (without directory) but
  21934. probably may be any name specified during packaging/embedding the data.
  21935. @return the label
  21936. </member>
  21937. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.FileName">
  21938. Returns the fileName field - usually the name of the file being embedded
  21939. including the full path.
  21940. @return the fileName
  21941. </member>
  21942. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Flags2">
  21943. Returns flags2 - currently unknown - mostly 0x0000.
  21944. @return the flags2
  21945. </member>
  21946. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Unknown1">
  21947. Returns unknown1 field - currently unknown.
  21948. @return the unknown1
  21949. </member>
  21950. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Command">
  21951. Returns the command field - usually the name of the file being embedded
  21952. including the full path, may be a command specified during embedding the file.
  21953. @return the command
  21954. </member>
  21955. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.DataSize">
  21956. Returns the size of the embedded file. If the size is 0 (zero), no data has been
  21957. embedded. To be sure, that no data has been embedded, check whether
  21958. {@link #getDataBuffer()} returns <code>null</code>.
  21959. @return the dataSize
  21960. </member>
  21961. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.DataBuffer">
  21962. Returns the buffer Containing the embedded file's data, or <code>null</code>
  21963. if no data was embedded. Note that an embedding may provide information about
  21964. the data, but the actual data is not included. (So label, filename etc. are
  21965. available, but this method returns <code>null</code>.)
  21966. @return the dataBuffer
  21967. </member>
  21968. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Flags3">
  21969. Returns the flags3 - currently unknown.
  21970. @return the flags3
  21971. </member>
  21972. <member name="T:NPOI.POIFS.FileSystem.Ole10Native.EncodingMode">
  21973. the field encoding mode - merely a try-and-error guess ...
  21974. </member>
  21975. <member name="F:NPOI.POIFS.FileSystem.Ole10Native.EncodingMode.parsed">
  21976. the data is stored in parsed format - including label, command, etc.
  21977. </member>
  21978. <member name="F:NPOI.POIFS.FileSystem.Ole10Native.EncodingMode.unparsed">
  21979. the data is stored raw after the length field
  21980. </member>
  21981. <member name="F:NPOI.POIFS.FileSystem.Ole10Native.EncodingMode.compact">
  21982. the data is stored raw after the length field and the flags1 field
  21983. </member>
  21984. <member name="T:NPOI.POIFS.FileSystem.POIFSDocumentPath">
  21985. <summary>
  21986. Class POIFSDocumentPath
  21987. @author Marc Johnson (mjohnson at apache dot org)
  21988. </summary>
  21989. </member>
  21990. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.#ctor">
  21991. <summary>
  21992. simple constructor for the path of a document that is in the
  21993. root of the POIFSFileSystem. The constructor that takes an
  21994. array of Strings can also be used to create such a
  21995. POIFSDocumentPath by passing it a null or empty String array
  21996. </summary>
  21997. </member>
  21998. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.#ctor(System.String[])">
  21999. <summary>
  22000. constructor for the path of a document that is not in the root
  22001. of the POIFSFileSystem
  22002. </summary>
  22003. <param name="components">the Strings making up the path to a document.
  22004. The Strings must be ordered as they appear in
  22005. the directory hierarchy of the the document
  22006. -- the first string must be the name of a
  22007. directory in the root of the POIFSFileSystem,
  22008. and every Nth (for N &gt; 1) string thereafter
  22009. must be the name of a directory in the
  22010. directory identified by the (N-1)th string.
  22011. If the components parameter is null or has
  22012. zero length, the POIFSDocumentPath is
  22013. appropriate for a document that is in the
  22014. root of a POIFSFileSystem</param>
  22015. </member>
  22016. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.#ctor(NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String[])">
  22017. <summary>
  22018. constructor that adds additional subdirectories to an existing
  22019. path
  22020. </summary>
  22021. <param name="path">the existing path</param>
  22022. <param name="components">the additional subdirectory names to be added</param>
  22023. </member>
  22024. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.Equals(System.Object)">
  22025. <summary>
  22026. equality. Two POIFSDocumentPath instances are equal if they
  22027. have the same number of component Strings, and if each
  22028. component String is equal to its coresponding component String
  22029. </summary>
  22030. <param name="o">the object we're checking equality for</param>
  22031. <returns>true if the object is equal to this object</returns>
  22032. </member>
  22033. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.GetComponent(System.Int32)">
  22034. <summary>
  22035. get the specified component
  22036. </summary>
  22037. <param name="n">which component (0 ... length() - 1)</param>
  22038. <returns>the nth component;</returns>
  22039. </member>
  22040. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.GetHashCode">
  22041. <summary>
  22042. Serves as a hash function for a particular type.
  22043. </summary>
  22044. <returns>
  22045. A hash code for the current <see cref="T:System.Object"/>.
  22046. </returns>
  22047. </member>
  22048. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.ToString">
  22049. <summary>
  22050. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  22051. </summary>
  22052. <returns>
  22053. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  22054. </returns>
  22055. </member>
  22056. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentPath.Length">
  22057. <summary>
  22058. Gets the length.
  22059. </summary>
  22060. <value>the number of components</value>
  22061. </member>
  22062. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentPath.Parent">
  22063. <summary>
  22064. Returns the path's parent or <c>null</c> if this path
  22065. is the root path.
  22066. </summary>
  22067. <value>path of parent, or null if this path is the root path</value>
  22068. </member>
  22069. <member name="T:NPOI.POIFS.FileSystem.POIFSDocumentReader">
  22070. <summary>
  22071. This class provides methods to read a DocumentEntry managed by a
  22072. Filesystem instance.
  22073. @author Marc Johnson (mjohnson at apache dot org)
  22074. </summary>
  22075. </member>
  22076. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  22077. <summary>
  22078. Create an InputStream from the specified DocumentEntry
  22079. </summary>
  22080. <param name="document">the DocumentEntry to be read</param>
  22081. </member>
  22082. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.#ctor(NPOI.POIFS.FileSystem.POIFSDocument)">
  22083. <summary>
  22084. Create an InputStream from the specified Document
  22085. </summary>
  22086. <param name="document">the Document to be read</param>
  22087. </member>
  22088. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Close">
  22089. <summary>
  22090. Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.
  22091. </summary>
  22092. </member>
  22093. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Read(System.Byte[])">
  22094. <summary>
  22095. Reads some number of bytes from the input stream and stores
  22096. them into the buffer array b. The number of bytes actually read
  22097. is returned as an integer. The definition of this method in
  22098. java.io.InputStream allows this method to block, but it won't.
  22099. If b is null, a NullPointerException is thrown. If the length
  22100. of b is zero, then no bytes are read and 0 is returned;
  22101. otherwise, there is an attempt to read at least one byte. If no
  22102. byte is available because the stream is at end of file, the
  22103. value -1 is returned; otherwise, at least one byte is read and
  22104. stored into b.
  22105. The first byte read is stored into element b[0], the next one
  22106. into b[1], and so on. The number of bytes read is, at most,
  22107. equal to the length of b. Let k be the number of bytes actually
  22108. read; these bytes will be stored in elements b[0] through
  22109. b[k-1], leaving elements b[k] through b[b.length-1] unaffected.
  22110. If the first byte cannot be read for any reason other than end
  22111. of file, then an IOException is thrown. In particular, an
  22112. IOException is thrown if the input stream has been closed.
  22113. The read(b) method for class InputStream has the same effect as:
  22114. </summary>
  22115. <param name="b">the buffer into which the data is read.</param>
  22116. <returns>the total number of bytes read into the buffer, or -1
  22117. if there is no more data because the end of the stream
  22118. has been reached.</returns>
  22119. </member>
  22120. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Read(System.Byte[],System.Int32,System.Int32)">
  22121. <summary>
  22122. Reads up to len bytes of data from the input stream into an
  22123. array of bytes. An attempt is made to read as many as len
  22124. bytes, but a smaller number may be read, possibly zero. The
  22125. number of bytes actually read is returned as an integer.
  22126. The definition of this method in java.io.InputStream allows it
  22127. to block, but it won't.
  22128. If b is null, a NullPointerException is thrown.
  22129. If off is negative, or len is negative, or off+len is greater
  22130. than the length of the array b, then an
  22131. IndexOutOfBoundsException is thrown.
  22132. If len is zero, then no bytes are read and 0 is returned;
  22133. otherwise, there is an attempt to read at least one byte. If no
  22134. byte is available because the stream is at end of file, the
  22135. value -1 is returned; otherwise, at least one byte is read and
  22136. stored into b.
  22137. The first byte read is stored into element b[off], the next one
  22138. into b[off+1], and so on. The number of bytes read is, at most,
  22139. equal to len. Let k be the number of bytes actually read; these
  22140. bytes will be stored in elements b[off] through b[off+k-1],
  22141. leaving elements b[off+k] through b[off+len-1] unaffected.
  22142. In every case, elements b[0] through b[off] and elements
  22143. b[off+len] through b[b.length-1] are unaffected.
  22144. If the first byte cannot be read for any reason other than end
  22145. of file, then an IOException is thrown. In particular, an
  22146. IOException is thrown if the input stream has been closed.
  22147. </summary>
  22148. <param name="b">the buffer into which the data is read.</param>
  22149. <param name="off">the start offset in array b at which the data is
  22150. written.</param>
  22151. <param name="len">the maximum number of bytes to read.</param>
  22152. <returns>the total number of bytes read into the buffer, or -1
  22153. if there is no more data because the end of the stream
  22154. has been reached.</returns>
  22155. </member>
  22156. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.ReadByte">
  22157. <summary>
  22158. Reads the next byte of data from the input stream. The value
  22159. byte is returned as an int in the range 0 to 255. If no byte is
  22160. available because the end of the stream has been reached, the
  22161. value -1 is returned. The definition of this method in
  22162. java.io.InputStream allows this method to block, but it won't.
  22163. </summary>
  22164. <returns>the next byte of data, or -1 if the end of the stream
  22165. is reached.
  22166. </returns>
  22167. </member>
  22168. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Seek(System.Int64,System.IO.SeekOrigin)">
  22169. <summary>
  22170. When overridden in a derived class, sets the position within the current stream.
  22171. </summary>
  22172. <param name="offset">A byte offset relative to the <paramref name="origin"/> parameter.</param>
  22173. <param name="origin">A value of type <see cref="T:System.IO.SeekOrigin"/> indicating the reference point used to obtain the new position.</param>
  22174. <returns>
  22175. The new position within the current stream.
  22176. </returns>
  22177. <exception cref="T:System.IO.IOException">
  22178. An I/O error occurs.
  22179. </exception>
  22180. <exception cref="T:System.NotSupportedException">
  22181. The stream does not support seeking, such as if the stream is constructed from a pipe or console output.
  22182. </exception>
  22183. <exception cref="T:System.ObjectDisposedException">
  22184. Methods were called after the stream was closed.
  22185. </exception>
  22186. </member>
  22187. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Skip(System.Int64)">
  22188. <summary>
  22189. Skips the specified n.
  22190. </summary>
  22191. <param name="n">The n.</param>
  22192. <returns></returns>
  22193. </member>
  22194. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Write(System.Byte[],System.Int32,System.Int32)">
  22195. <summary>
  22196. When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
  22197. </summary>
  22198. <param name="buffer">An array of bytes. This method copies <paramref name="count"/> bytes from <paramref name="buffer"/> to the current stream.</param>
  22199. <param name="offset">The zero-based byte offset in <paramref name="buffer"/> at which to begin copying bytes to the current stream.</param>
  22200. <param name="count">The number of bytes to be written to the current stream.</param>
  22201. <exception cref="T:System.ArgumentException">
  22202. The sum of <paramref name="offset"/> and <paramref name="count"/> is greater than the buffer length.
  22203. </exception>
  22204. <exception cref="T:System.ArgumentNullException">
  22205. <paramref name="buffer"/> is null.
  22206. </exception>
  22207. <exception cref="T:System.ArgumentOutOfRangeException">
  22208. <paramref name="offset"/> or <paramref name="count"/> is negative.
  22209. </exception>
  22210. <exception cref="T:System.IO.IOException">
  22211. An I/O error occurs.
  22212. </exception>
  22213. <exception cref="T:System.NotSupportedException">
  22214. The stream does not support writing.
  22215. </exception>
  22216. <exception cref="T:System.ObjectDisposedException">
  22217. Methods were called after the stream was closed.
  22218. </exception>
  22219. </member>
  22220. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.EOD">
  22221. <summary>
  22222. at the end Of document.
  22223. </summary>
  22224. <returns></returns>
  22225. </member>
  22226. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.Available">
  22227. <summary>
  22228. Returns the number of bytes that can be read (or skipped over)
  22229. from this input stream without blocking by the next caller of a
  22230. method for this input stream. The next caller might be the same
  22231. thread or or another thread.
  22232. </summary>
  22233. <value>the number of bytes that can be read from this input
  22234. stream without blocking.</value>
  22235. </member>
  22236. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.CanRead">
  22237. <summary>
  22238. When overridden in a derived class, gets a value indicating whether the current stream supports reading.
  22239. </summary>
  22240. <value></value>
  22241. <returns>true if the stream supports reading; otherwise, false.
  22242. </returns>
  22243. </member>
  22244. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.CanSeek">
  22245. <summary>
  22246. When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
  22247. </summary>
  22248. <value></value>
  22249. <returns>true if the stream supports seeking; otherwise, false.
  22250. </returns>
  22251. </member>
  22252. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.CanWrite">
  22253. <summary>
  22254. When overridden in a derived class, gets a value indicating whether the current stream supports writing.
  22255. </summary>
  22256. <value></value>
  22257. <returns>true if the stream supports writing; otherwise, false.
  22258. </returns>
  22259. </member>
  22260. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.Length">
  22261. <summary>
  22262. When overridden in a derived class, gets the length in bytes of the stream.
  22263. </summary>
  22264. <value></value>
  22265. <returns>
  22266. A long value representing the length of the stream in bytes.
  22267. </returns>
  22268. <exception cref="T:System.NotSupportedException">
  22269. A class derived from Stream does not support seeking.
  22270. </exception>
  22271. <exception cref="T:System.ObjectDisposedException">
  22272. Methods were called after the stream was closed.
  22273. </exception>
  22274. </member>
  22275. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.Position">
  22276. <summary>
  22277. When overridden in a derived class, gets or sets the position within the current stream.
  22278. </summary>
  22279. <value></value>
  22280. <returns>
  22281. The current position within the stream.
  22282. </returns>
  22283. <exception cref="T:System.IO.IOException">
  22284. An I/O error occurs.
  22285. </exception>
  22286. <exception cref="T:System.NotSupportedException">
  22287. The stream does not support seeking.
  22288. </exception>
  22289. <exception cref="T:System.ObjectDisposedException">
  22290. Methods were called after the stream was closed.
  22291. </exception>
  22292. </member>
  22293. <member name="T:NPOI.POIFS.FileSystem.POIFSDocumentWriter">
  22294. <summary>
  22295. This class provides a wrapper over an OutputStream so that Document
  22296. writers can't accidently go over their size limits
  22297. @author Marc Johnson (mjohnson at apache dot org)
  22298. </summary>
  22299. </member>
  22300. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.#ctor(System.IO.Stream,System.Int32)">
  22301. <summary>
  22302. Create a POIFSDocumentWriter
  22303. </summary>
  22304. <param name="stream">the OutputStream to which the data is actually</param>
  22305. <param name="limit">the maximum number of bytes that can be written</param>
  22306. </member>
  22307. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Close">
  22308. <summary>
  22309. Closes this output stream and releases any system resources
  22310. associated with this stream. The general contract of close is
  22311. that it closes the output stream. A closed stream cannot
  22312. perform output operations and cannot be reopened.
  22313. </summary>
  22314. </member>
  22315. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Flush">
  22316. <summary>
  22317. Flushes this output stream and forces any buffered output bytes
  22318. to be written out.
  22319. </summary>
  22320. </member>
  22321. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Write(System.Byte[])">
  22322. <summary>
  22323. Writes b.length bytes from the specified byte array
  22324. to this output stream.
  22325. </summary>
  22326. <param name="b">the data.</param>
  22327. </member>
  22328. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Write(System.Byte[],System.Int32,System.Int32)">
  22329. <summary>
  22330. Writes len bytes from the specified byte array starting at
  22331. offset off to this output stream. The general contract for
  22332. write(b, off, len) is that some of the bytes in the array b are
  22333. written to the output stream in order; element b[off] is the
  22334. first byte written and b[off+len-1] is the last byte written by
  22335. this operation.
  22336. If b is null, a NullPointerException is thrown.
  22337. If off is negative, or len is negative, or off+len is greater
  22338. than the length of the array b, then an
  22339. IndexOutOfBoundsException is thrown.
  22340. </summary>
  22341. <param name="b">the data.</param>
  22342. <param name="off">the start offset in the data.</param>
  22343. <param name="len">the number of bytes to write.</param>
  22344. </member>
  22345. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.WriteByte(System.Byte)">
  22346. <summary>
  22347. Writes the specified byte to this output stream. The general
  22348. contract for write is that one byte is written to the output
  22349. stream. The byte to be written is the eight low-order bits of
  22350. the argument b. The 24 high-order bits of b are ignored.
  22351. </summary>
  22352. <param name="b">the byte.</param>
  22353. </member>
  22354. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.WriteFiller(System.Int32,System.Byte)">
  22355. <summary>
  22356. write the rest of the document's data (fill in at the end)
  22357. </summary>
  22358. <param name="totalLimit">the actual number of bytes the corresponding
  22359. document must fill</param>
  22360. <param name="fill">the byte to fill remaining space with</param>
  22361. </member>
  22362. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentWriter.CanRead">
  22363. <summary>
  22364. When overridden in a derived class, gets a value indicating whether the current stream supports reading.
  22365. </summary>
  22366. <value></value>
  22367. <returns>true if the stream supports reading; otherwise, false.
  22368. </returns>
  22369. </member>
  22370. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentWriter.CanSeek">
  22371. <summary>
  22372. When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
  22373. </summary>
  22374. <value></value>
  22375. <returns>true if the stream supports seeking; otherwise, false.
  22376. </returns>
  22377. </member>
  22378. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentWriter.CanWrite">
  22379. <summary>
  22380. When overridden in a derived class, gets a value indicating whether the current stream supports writing.
  22381. </summary>
  22382. <value></value>
  22383. <returns>true if the stream supports writing; otherwise, false.
  22384. </returns>
  22385. </member>
  22386. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Length">
  22387. <summary>
  22388. When overridden in a derived class, gets the length in bytes of the stream.
  22389. </summary>
  22390. <value></value>
  22391. <returns>
  22392. A long value representing the length of the stream in bytes.
  22393. </returns>
  22394. <exception cref="T:System.NotSupportedException">
  22395. A class derived from Stream does not support seeking.
  22396. </exception>
  22397. <exception cref="T:System.ObjectDisposedException">
  22398. Methods were called after the stream was closed.
  22399. </exception>
  22400. </member>
  22401. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Position">
  22402. <summary>
  22403. When overridden in a derived class, gets or sets the position within the current stream.
  22404. </summary>
  22405. <value></value>
  22406. <returns>
  22407. The current position within the stream.
  22408. </returns>
  22409. <exception cref="T:System.IO.IOException">
  22410. An I/O error occurs.
  22411. </exception>
  22412. <exception cref="T:System.NotSupportedException">
  22413. The stream does not support seeking.
  22414. </exception>
  22415. <exception cref="T:System.ObjectDisposedException">
  22416. Methods were called after the stream was closed.
  22417. </exception>
  22418. </member>
  22419. <member name="T:NPOI.POIFS.FileSystem.POIFSFileSystem">
  22420. <summary>
  22421. This is the main class of the POIFS system; it manages the entire
  22422. life cycle of the filesystem.
  22423. @author Marc Johnson (mjohnson at apache dot org)
  22424. </summary>
  22425. </member>
  22426. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.CreateNonClosingInputStream(System.IO.Stream)">
  22427. <summary>
  22428. Convenience method for clients that want to avoid the auto-Close behaviour of the constructor.
  22429. </summary>
  22430. <param name="stream">The stream.</param>
  22431. <example>
  22432. A convenience method (
  22433. CreateNonClosingInputStream()) has been provided for this purpose:
  22434. StreamwrappedStream = POIFSFileSystem.CreateNonClosingInputStream(is);
  22435. HSSFWorkbook wb = new HSSFWorkbook(wrappedStream);
  22436. is.reset();
  22437. doSomethingElse(is);
  22438. </example>
  22439. <returns></returns>
  22440. </member>
  22441. <member name="F:NPOI.POIFS.FileSystem.POIFSFileSystem.bigBlockSize">
  22442. What big block size the file uses. Most files
  22443. use 512 bytes, but a few use 4096
  22444. </member>
  22445. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.#ctor">
  22446. <summary>
  22447. Initializes a new instance of the <see cref="T:NPOI.POIFS.FileSystem.POIFSFileSystem"/> class. intended for writing
  22448. </summary>
  22449. </member>
  22450. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.#ctor(System.IO.Stream)">
  22451. <summary>
  22452. Create a POIFSFileSystem from an Stream. Normally the stream is Read until
  22453. EOF. The stream is always Closed. In the unlikely case that the caller has such a stream and
  22454. needs to use it after this constructor completes, a work around is to wrap the
  22455. stream in order to trap the Close() call.
  22456. </summary>
  22457. <param name="stream">the Streamfrom which to Read the data</param>
  22458. </member>
  22459. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.CloseInputStream(System.IO.Stream,System.Boolean)">
  22460. @param stream the stream to be Closed
  22461. @param success <c>false</c> if an exception is currently being thrown in the calling method
  22462. </member>
  22463. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.HasPOIFSHeader(System.IO.Stream)">
  22464. <summary>
  22465. Checks that the supplied Stream(which MUST
  22466. support mark and reset, or be a PushbackInputStream)
  22467. has a POIFS (OLE2) header at the start of it.
  22468. If your Streamdoes not support mark / reset,
  22469. then wrap it in a PushBackInputStream, then be
  22470. sure to always use that, and not the original!
  22471. </summary>
  22472. <param name="inp">An Streamwhich supports either mark/reset, or is a PushbackStream</param>
  22473. <returns>
  22474. <c>true</c> if [has POIFS header] [the specified inp]; otherwise, <c>false</c>.
  22475. </returns>
  22476. </member>
  22477. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.CreateDocument(System.IO.Stream,System.String)">
  22478. <summary>
  22479. Create a new document to be Added to the root directory
  22480. </summary>
  22481. <param name="stream"> the Streamfrom which the document's data will be obtained</param>
  22482. <param name="name">the name of the new POIFSDocument</param>
  22483. <returns>the new DocumentEntry</returns>
  22484. </member>
  22485. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.CreateDocument(System.String,System.Int32,NPOI.POIFS.EventFileSystem.POIFSWriterListener)">
  22486. <summary>
  22487. Create a new DocumentEntry in the root entry; the data will be
  22488. provided later
  22489. </summary>
  22490. <param name="name">the name of the new DocumentEntry</param>
  22491. <param name="size">the size of the new DocumentEntry</param>
  22492. <param name="writer">the Writer of the new DocumentEntry</param>
  22493. <returns>the new DocumentEntry</returns>
  22494. </member>
  22495. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.CreateDirectory(System.String)">
  22496. <summary>
  22497. Create a new DirectoryEntry in the root directory
  22498. </summary>
  22499. <param name="name">the name of the new DirectoryEntry</param>
  22500. <returns>the new DirectoryEntry</returns>
  22501. </member>
  22502. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.CreateDocumentInputStream(System.String)">
  22503. open a document in the root entry's list of entries
  22504. @param documentName the name of the document to be opened
  22505. @return a newly opened DocumentInputStream
  22506. @exception IOException if the document does not exist or the
  22507. name is that of a DirectoryEntry
  22508. </member>
  22509. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.WriteFileSystem(System.IO.Stream)">
  22510. <summary>
  22511. Writes the file system.
  22512. </summary>
  22513. <param name="stream">the OutputStream to which the filesystem will be
  22514. written</param>
  22515. </member>
  22516. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.AddDocument(NPOI.POIFS.FileSystem.POIFSDocument)">
  22517. <summary>
  22518. Add a new POIFSDocument
  22519. </summary>
  22520. <param name="document">the POIFSDocument being Added</param>
  22521. </member>
  22522. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.AddDirectory(NPOI.POIFS.Properties.DirectoryProperty)">
  22523. <summary>
  22524. Add a new DirectoryProperty
  22525. </summary>
  22526. <param name="directory">The directory.</param>
  22527. </member>
  22528. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.Remove(NPOI.POIFS.FileSystem.EntryNode)">
  22529. <summary>
  22530. Removes the specified entry.
  22531. </summary>
  22532. <param name="entry">The entry.</param>
  22533. </member>
  22534. <member name="P:NPOI.POIFS.FileSystem.POIFSFileSystem.Root">
  22535. <summary>
  22536. Get the root entry
  22537. </summary>
  22538. <value>The root.</value>
  22539. </member>
  22540. <member name="P:NPOI.POIFS.FileSystem.POIFSFileSystem.ViewableArray">
  22541. <summary>
  22542. Get an array of objects, some of which may implement
  22543. POIFSViewable
  22544. </summary>
  22545. <value>an array of Object; may not be null, but may be empty</value>
  22546. </member>
  22547. <member name="P:NPOI.POIFS.FileSystem.POIFSFileSystem.ViewableIterator">
  22548. <summary>
  22549. Get an Iterator of objects, some of which may implement
  22550. POIFSViewable
  22551. </summary>
  22552. <value>an Iterator; may not be null, but may have an empty
  22553. back end store</value>
  22554. </member>
  22555. <member name="P:NPOI.POIFS.FileSystem.POIFSFileSystem.PreferArray">
  22556. <summary>
  22557. Give viewers a hint as to whether to call GetViewableArray or
  22558. GetViewableIterator
  22559. </summary>
  22560. <value><c>true</c> if a viewer should call GetViewableArray, <c>false</c> if
  22561. a viewer should call GetViewableIterator </value>
  22562. </member>
  22563. <member name="P:NPOI.POIFS.FileSystem.POIFSFileSystem.ShortDescription">
  22564. <summary>
  22565. Provides a short description of the object, to be used when a
  22566. POIFSViewable object has not provided its contents.
  22567. </summary>
  22568. <value>The short description.</value>
  22569. </member>
  22570. <member name="P:NPOI.POIFS.FileSystem.POIFSFileSystem.BigBlockSize">
  22571. <summary>
  22572. Gets The Big Block size, normally 512 bytes, sometimes 4096 bytes
  22573. </summary>
  22574. <value>The size of the big block.</value>
  22575. </member>
  22576. <member name="T:NPOI.POIFS.Properties.Child">
  22577. <summary>
  22578. This interface defines methods for finding and setting sibling
  22579. Property instances
  22580. @author Marc Johnson (mjohnson at apache dot org)
  22581. </summary>
  22582. </member>
  22583. <member name="P:NPOI.POIFS.Properties.Child.PreviousChild">
  22584. <summary>
  22585. Gets or sets the previous child.
  22586. </summary>
  22587. <value>The previous child.</value>
  22588. </member>
  22589. <member name="P:NPOI.POIFS.Properties.Child.NextChild">
  22590. <summary>
  22591. Gets or sets the next child.
  22592. </summary>
  22593. <value>The next child.</value>
  22594. </member>
  22595. <member name="T:NPOI.POIFS.Properties.DirectoryProperty">
  22596. <summary>
  22597. Trivial extension of Property for POIFSDocuments
  22598. @author Marc Johnson (mjohnson at apache dot org)
  22599. </summary>
  22600. </member>
  22601. <member name="T:NPOI.POIFS.Properties.Property">
  22602. <summary>
  22603. This abstract base class is the ancestor of all classes
  22604. implementing POIFS Property behavior.
  22605. @author Marc Johnson (mjohnson at apache dot org)
  22606. </summary>
  22607. </member>
  22608. <member name="M:NPOI.POIFS.Properties.Property.#ctor">
  22609. <summary>
  22610. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.Property"/> class.
  22611. </summary>
  22612. </member>
  22613. <member name="M:NPOI.POIFS.Properties.Property.#ctor(System.Int32,System.Byte[],System.Int32)">
  22614. <summary>
  22615. Constructor from byte data
  22616. </summary>
  22617. <param name="index">index number</param>
  22618. <param name="array">byte data</param>
  22619. <param name="offset">offset into byte data</param>
  22620. </member>
  22621. <member name="M:NPOI.POIFS.Properties.Property.WriteData(System.IO.Stream)">
  22622. <summary>
  22623. Write the raw data to an OutputStream.
  22624. </summary>
  22625. <param name="stream">the OutputStream to which the data Should be
  22626. written.</param>
  22627. </member>
  22628. <member name="M:NPOI.POIFS.Properties.Property.IsSmall(System.Int32)">
  22629. <summary>
  22630. does the length indicate a small document?
  22631. </summary>
  22632. <param name="length">length in bytes</param>
  22633. <returns>
  22634. <c>true</c> if the length Is less than
  22635. _big_block_minimum_bytes; otherwise, <c>false</c>.
  22636. </returns>
  22637. </member>
  22638. <member name="M:NPOI.POIFS.Properties.Property.PreWrite">
  22639. <summary>
  22640. Perform whatever activities need to be performed prior to
  22641. writing
  22642. </summary>
  22643. </member>
  22644. <member name="M:NPOI.POIFS.Properties.Property.IsValidIndex(System.Int32)">
  22645. <summary>
  22646. Determines whether the specified index Is valid
  22647. </summary>
  22648. <param name="index">value to be checked</param>
  22649. <returns>
  22650. <c>true</c> if the index Is valid; otherwise, <c>false</c>.
  22651. </returns>
  22652. </member>
  22653. <member name="P:NPOI.POIFS.Properties.Property.StartBlock">
  22654. <summary>
  22655. Gets or sets the start block for the document referred to by this
  22656. Property.
  22657. </summary>
  22658. <value>the start block index</value>
  22659. </member>
  22660. <member name="P:NPOI.POIFS.Properties.Property.ShouldUseSmallBlocks">
  22661. <summary>
  22662. Based on the currently defined size, Should this property use
  22663. small blocks?
  22664. </summary>
  22665. <returns>true if the size Is less than _big_block_minimum_bytes</returns>
  22666. </member>
  22667. <member name="P:NPOI.POIFS.Properties.Property.Name">
  22668. <summary>
  22669. Gets or sets the name of this property
  22670. </summary>
  22671. <value>property name</value>
  22672. </member>
  22673. <member name="P:NPOI.POIFS.Properties.Property.IsDirectory">
  22674. <summary>
  22675. Gets a value indicating whether this instance is directory.
  22676. </summary>
  22677. <value>
  22678. <c>true</c> if a directory type Property; otherwise, <c>false</c>.
  22679. </value>
  22680. </member>
  22681. <member name="P:NPOI.POIFS.Properties.Property.StorageClsid">
  22682. <summary>
  22683. Gets or sets the storage class ID for this property stream. ThIs Is the Class ID
  22684. of the COM object which can read and write this property stream </summary>
  22685. <value>Storage Class ID</value>
  22686. </member>
  22687. <member name="P:NPOI.POIFS.Properties.Property.PropertyType">
  22688. <summary>
  22689. Set the property type. Makes no attempt to validate the value.
  22690. </summary>
  22691. <value>the property type (root, file, directory)</value>
  22692. </member>
  22693. <member name="P:NPOI.POIFS.Properties.Property.NodeColor">
  22694. <summary>
  22695. Sets the color of the node.
  22696. </summary>
  22697. <value>the node color (red or black)</value>
  22698. </member>
  22699. <member name="P:NPOI.POIFS.Properties.Property.ChildProperty">
  22700. <summary>
  22701. Sets the child property.
  22702. </summary>
  22703. <value>the child property's index in the Property Table</value>
  22704. </member>
  22705. <member name="P:NPOI.POIFS.Properties.Property.ChildIndex">
  22706. <summary>
  22707. Get the child property (its index in the Property Table)
  22708. </summary>
  22709. <value>The index of the child.</value>
  22710. </member>
  22711. <member name="P:NPOI.POIFS.Properties.Property.Size">
  22712. <summary>
  22713. Gets or sets the size of the document associated with this Property
  22714. </summary>
  22715. <value>the size of the document, in bytes</value>
  22716. </member>
  22717. <member name="P:NPOI.POIFS.Properties.Property.Index">
  22718. <summary>
  22719. Gets or sets the index.
  22720. </summary>
  22721. <value>The index.</value>
  22722. Get the index for this Property
  22723. @return the index of this Property within its Property Table
  22724. </member>
  22725. <member name="P:NPOI.POIFS.Properties.Property.NextChildIndex">
  22726. <summary>
  22727. Gets the index of the next child.
  22728. </summary>
  22729. <value>The index of the next child.</value>
  22730. </member>
  22731. <member name="P:NPOI.POIFS.Properties.Property.PreviousChildIndex">
  22732. <summary>
  22733. Gets the index of the previous child.
  22734. </summary>
  22735. <value>The index of the previous child.</value>
  22736. </member>
  22737. <member name="P:NPOI.POIFS.Properties.Property.PreviousChild">
  22738. <summary>
  22739. Gets or sets the previous child.
  22740. </summary>
  22741. <value>the new 'previous' child; may be null, which has
  22742. the effect of saying there Is no 'previous' child</value>
  22743. </member>
  22744. <member name="P:NPOI.POIFS.Properties.Property.NextChild">
  22745. <summary>
  22746. Gets or sets the next Child
  22747. </summary>
  22748. <value> the new 'next' child; may be null, which has the
  22749. effect of saying there Is no 'next' child</value>
  22750. </member>
  22751. <member name="P:NPOI.POIFS.Properties.Property.ViewableArray">
  22752. <summary>
  22753. Get an array of objects, some of which may implement
  22754. POIFSViewable
  22755. </summary>
  22756. <value>an array of Object; may not be null, but may be empty</value>
  22757. </member>
  22758. <member name="P:NPOI.POIFS.Properties.Property.ViewableIterator">
  22759. <summary>
  22760. Get an Iterator of objects, some of which may implement POIFSViewable
  22761. </summary>
  22762. <value> may not be null, but may have an empty
  22763. back end store</value>
  22764. </member>
  22765. <member name="P:NPOI.POIFS.Properties.Property.PreferArray">
  22766. <summary>
  22767. Give viewers a hint as to whether to call GetViewableArray or
  22768. GetViewableIterator
  22769. </summary>
  22770. <value><c>true</c> if a viewer Should call GetViewableArray; otherwise, <c>false</c>
  22771. if a viewer Should call GetViewableIterator
  22772. </value>
  22773. </member>
  22774. <member name="P:NPOI.POIFS.Properties.Property.ShortDescription">
  22775. <summary>
  22776. Provides a short description of the object, to be used when a
  22777. POIFSViewable object has not provided its contents.
  22778. </summary>
  22779. <value>The short description.</value>
  22780. </member>
  22781. <member name="T:NPOI.POIFS.Properties.Parent">
  22782. <summary>
  22783. Behavior for parent (directory) properties
  22784. @author Marc Johnson27591@hotmail.com
  22785. </summary>
  22786. </member>
  22787. <member name="M:NPOI.POIFS.Properties.Parent.AddChild(NPOI.POIFS.Properties.Property)">
  22788. <summary>
  22789. Add a new child to the collection of children
  22790. </summary>
  22791. <param name="property">the new child to be added; must not be null</param>
  22792. </member>
  22793. <member name="P:NPOI.POIFS.Properties.Parent.Children">
  22794. <summary>
  22795. Get an iterator over the children of this Parent
  22796. all elements are instances of Property.
  22797. </summary>
  22798. <returns></returns>
  22799. </member>
  22800. <member name="P:NPOI.POIFS.Properties.Parent.PreviousChild">
  22801. <summary>
  22802. Sets the previous child.
  22803. </summary>
  22804. </member>
  22805. <member name="P:NPOI.POIFS.Properties.Parent.NextChild">
  22806. <summary>
  22807. Sets the next child.
  22808. </summary>
  22809. </member>
  22810. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.#ctor(System.String)">
  22811. <summary>
  22812. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.DirectoryProperty"/> class.
  22813. </summary>
  22814. <param name="name">the name of the directory</param>
  22815. </member>
  22816. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.#ctor(System.Int32,System.Byte[],System.Int32)">
  22817. <summary>
  22818. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.DirectoryProperty"/> class.
  22819. </summary>
  22820. <param name="index">index number</param>
  22821. <param name="array">byte data</param>
  22822. <param name="offset">offset into byte data</param>
  22823. </member>
  22824. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.ChangeName(NPOI.POIFS.Properties.Property,System.String)">
  22825. <summary>
  22826. Change a Property's name
  22827. </summary>
  22828. <param name="property">the Property whose name Is being Changed.</param>
  22829. <param name="newName">the new name for the Property</param>
  22830. <returns>true if the name Change could be made, else false</returns>
  22831. </member>
  22832. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.DeleteChild(NPOI.POIFS.Properties.Property)">
  22833. <summary>
  22834. Delete a Property
  22835. </summary>
  22836. <param name="property">the Property being Deleted</param>
  22837. <returns>true if the Property could be Deleted, else false</returns>
  22838. </member>
  22839. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.PreWrite">
  22840. <summary>
  22841. Perform whatever activities need to be performed prior to
  22842. writing
  22843. </summary>
  22844. </member>
  22845. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.AddChild(NPOI.POIFS.Properties.Property)">
  22846. <summary>
  22847. Add a new child to the collection of children
  22848. </summary>
  22849. <param name="property">the new child to be added; must not be null</param>
  22850. </member>
  22851. <member name="P:NPOI.POIFS.Properties.DirectoryProperty.IsDirectory">
  22852. <summary>
  22853. Gets a value indicating whether this instance is directory.
  22854. </summary>
  22855. <value>
  22856. <c>true</c> if a directory type Property; otherwise, <c>false</c>.
  22857. </value>
  22858. </member>
  22859. <member name="P:NPOI.POIFS.Properties.DirectoryProperty.Children">
  22860. <summary>
  22861. Get an iterator over the children of this Parent; all elements
  22862. are instances of Property.
  22863. </summary>
  22864. <value>Iterator of children; may refer to an empty collection</value>
  22865. </member>
  22866. <member name="T:NPOI.POIFS.Properties.DirectoryProperty.PropertyComparator">
  22867. <summary>
  22868. Directory Property Comparer
  22869. </summary>
  22870. </member>
  22871. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.PropertyComparator.Equals(System.Object)">
  22872. <summary>
  22873. Object equality, implemented as object identity
  22874. </summary>
  22875. <param name="o">Object we're being Compared to</param>
  22876. <returns>true if identical, else false</returns>
  22877. </member>
  22878. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.PropertyComparator.Compare(NPOI.POIFS.Properties.Property,NPOI.POIFS.Properties.Property)">
  22879. <summary>
  22880. Compare method. Assumes both parameters are non-null
  22881. instances of Property. One property is less than another if
  22882. its name is shorter than the other property's name. If the
  22883. names are the same length, the property whose name comes
  22884. before the other property's name, alphabetically, is less
  22885. than the other property.
  22886. </summary>
  22887. <param name="o1">first object to compare, better be a Property</param>
  22888. <param name="o2">second object to compare, better be a Property</param>
  22889. <returns>negative value if o1 smaller than o2,
  22890. zero if o1 equals o2,
  22891. positive value if o1 bigger than o2.</returns>
  22892. </member>
  22893. <member name="T:NPOI.POIFS.Properties.DocumentProperty">
  22894. <summary>
  22895. Trivial extension of Property for POIFSDocuments
  22896. @author Marc Johnson (mjohnson at apache dot org)
  22897. </summary>
  22898. </member>
  22899. <member name="M:NPOI.POIFS.Properties.DocumentProperty.#ctor(System.String,System.Int32)">
  22900. <summary>
  22901. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.DocumentProperty"/> class.
  22902. </summary>
  22903. <param name="name">POIFSDocument name</param>
  22904. <param name="size">POIFSDocument size</param>
  22905. </member>
  22906. <member name="M:NPOI.POIFS.Properties.DocumentProperty.#ctor(System.Int32,System.Byte[],System.Int32)">
  22907. <summary>
  22908. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.DocumentProperty"/> class.
  22909. </summary>
  22910. <param name="index">index number</param>
  22911. <param name="array">byte data</param>
  22912. <param name="offset">offset into byte data</param>
  22913. </member>
  22914. <member name="M:NPOI.POIFS.Properties.DocumentProperty.PreWrite">
  22915. <summary>
  22916. Perform whatever activities need to be performed prior to
  22917. writing
  22918. </summary>
  22919. </member>
  22920. <member name="M:NPOI.POIFS.Properties.DocumentProperty.UpdateSize(System.Int32)">
  22921. Update the size of the property's data
  22922. </member>
  22923. <member name="P:NPOI.POIFS.Properties.DocumentProperty.Document">
  22924. <summary>
  22925. Gets or sets the document.
  22926. </summary>
  22927. <value>the associated POIFSDocument</value>
  22928. </member>
  22929. <member name="P:NPOI.POIFS.Properties.DocumentProperty.IsDirectory">
  22930. <summary>
  22931. Determines whether this instance is directory.
  22932. </summary>
  22933. <returns>
  22934. <c>true</c> if this instance is directory; otherwise, <c>false</c>.
  22935. </returns>
  22936. </member>
  22937. <member name="T:NPOI.POIFS.Properties.PropertyConstants">
  22938. <summary>
  22939. Constants used by Properties namespace
  22940. </summary>
  22941. </member>
  22942. <member name="M:NPOI.POIFS.Properties.PropertyFactory.ConvertToProperties(NPOI.POIFS.Storage.ListManagedBlock[])">
  22943. <summary>
  22944. Convert raw data blocks to an array of Property's
  22945. </summary>
  22946. <param name="blocks">The blocks to be converted</param>
  22947. <returns>the converted List of Property objects. May contain
  22948. nulls, but will not be null</returns>
  22949. </member>
  22950. <member name="M:NPOI.POIFS.Properties.PropertyTable.#ctor(NPOI.POIFS.Storage.HeaderBlock)">
  22951. Default constructor
  22952. </member>
  22953. <member name="M:NPOI.POIFS.Properties.PropertyTable.#ctor(NPOI.POIFS.Storage.HeaderBlock,NPOI.POIFS.Storage.RawDataBlockList)">
  22954. reading constructor (used when we've read in a file and we want
  22955. to extract the property table from it). Populates the
  22956. properties thoroughly
  22957. @param startBlock the first block of the property table
  22958. @param blockList the list of blocks
  22959. @exception IOException if anything goes wrong (which should be
  22960. a result of the input being NFG)
  22961. </member>
  22962. <member name="M:NPOI.POIFS.Properties.PropertyTable.PreWrite">
  22963. Prepare to be written Leon
  22964. </member>
  22965. <member name="M:NPOI.POIFS.Properties.PropertyTable.WriteBlocks(System.IO.Stream)">
  22966. Write the storage to an Stream
  22967. @param stream the Stream to which the stored data should
  22968. be written
  22969. @exception IOException on problems writing to the specified
  22970. stream
  22971. </member>
  22972. <member name="P:NPOI.POIFS.Properties.PropertyTable.CountBlocks">
  22973. Return the number of BigBlock's this instance uses
  22974. @return count of BigBlock instances
  22975. </member>
  22976. <member name="M:NPOI.POIFS.Properties.RootProperty.#ctor(System.Int32,System.Byte[],System.Int32)">
  22977. <summary>
  22978. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.RootProperty"/> class.
  22979. </summary>
  22980. <param name="index">index number</param>
  22981. <param name="array">byte data</param>
  22982. <param name="offset">offset into byte data</param>
  22983. </member>
  22984. <member name="P:NPOI.POIFS.Properties.RootProperty.Size">
  22985. <summary>
  22986. Gets or sets the size of the document associated with this Property
  22987. </summary>
  22988. <value>the size of the document, in bytes</value>
  22989. </member>
  22990. <member name="T:NPOI.POIFS.Storage.BATBlock">
  22991. <summary>
  22992. A block of block allocation table entries. BATBlocks are created
  22993. only through a static factory method: createBATBlocks.
  22994. @author Marc Johnson (mjohnson at apache dot org)
  22995. </summary>
  22996. </member>
  22997. <member name="T:NPOI.POIFS.Storage.BigBlock">
  22998. <summary>
  22999. Abstract base class of all POIFS block storage classes. All
  23000. extensions of BigBlock should write 512 bytes of data when
  23001. requested to write their data.
  23002. This class has package scope, as there is no reason at this time to
  23003. make the class public.
  23004. @author Marc Johnson (mjohnson at apache dot org)
  23005. </summary>
  23006. </member>
  23007. <member name="M:NPOI.POIFS.Storage.BigBlock.WriteData(System.IO.Stream,System.Byte[])">
  23008. <summary>
  23009. Default implementation of write for extending classes that
  23010. contain their data in a simple array of bytes.
  23011. </summary>
  23012. <param name="stream">the OutputStream to which the data should be written.</param>
  23013. <param name="data">the byte array of to be written.</param>
  23014. </member>
  23015. <member name="M:NPOI.POIFS.Storage.BigBlock.WriteBlocks(System.IO.Stream)">
  23016. <summary>
  23017. Write the block's data to an OutputStream
  23018. </summary>
  23019. <param name="stream">the OutputStream to which the stored data should be written</param>
  23020. </member>
  23021. <member name="M:NPOI.POIFS.Storage.BigBlock.WriteData(System.IO.Stream)">
  23022. <summary>
  23023. Write the storage to an OutputStream
  23024. </summary>
  23025. <param name="stream">the OutputStream to which the stored data should be written </param>
  23026. </member>
  23027. <member name="F:NPOI.POIFS.Storage.BATBlock._values">
  23028. For a regular fat block, these are 128 / 1024
  23029. next sector values.
  23030. For a XFat (DIFat) block, these are 127 / 1023
  23031. next sector values, then a chaining value.
  23032. </member>
  23033. <member name="F:NPOI.POIFS.Storage.BATBlock._has_free_sectors">
  23034. Does this BATBlock have any free sectors in it?
  23035. </member>
  23036. <member name="F:NPOI.POIFS.Storage.BATBlock.ourBlockIndex">
  23037. Where in the file are we?
  23038. </member>
  23039. <member name="M:NPOI.POIFS.Storage.BATBlock.#ctor">
  23040. <summary>
  23041. Create a single instance initialized with default values
  23042. </summary>
  23043. </member>
  23044. <member name="M:NPOI.POIFS.Storage.BATBlock.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32[],System.Int32,System.Int32)">
  23045. Create a single instance initialized (perhaps partially) with entries
  23046. @param entries the array of block allocation table entries
  23047. @param start_index the index of the first entry to be written
  23048. to the block
  23049. @param end_index the index, plus one, of the last entry to be
  23050. written to the block (writing is for all index
  23051. k, start_index &lt;= k &lt; end_index)
  23052. </member>
  23053. <member name="M:NPOI.POIFS.Storage.BATBlock.CreateBATBlock(NPOI.POIFS.Common.POIFSBigBlockSize,System.IO.BinaryReader)">
  23054. Create a single BATBlock from the byte buffer, which must hold at least
  23055. one big block of data to be read.
  23056. </member>
  23057. <member name="M:NPOI.POIFS.Storage.BATBlock.CreateEmptyBATBlock(NPOI.POIFS.Common.POIFSBigBlockSize,System.Boolean)">
  23058. **
  23059. </member>
  23060. <member name="M:NPOI.POIFS.Storage.BATBlock.CreateBATBlocks(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32[])">
  23061. <summary>
  23062. Create an array of BATBlocks from an array of int block
  23063. allocation table entries
  23064. </summary>
  23065. <param name="bigBlockSize">the poifs bigBlockSize</param>
  23066. <param name="entries">the array of int entries</param>
  23067. <returns>the newly created array of BATBlocks</returns>
  23068. </member>
  23069. <member name="M:NPOI.POIFS.Storage.BATBlock.CreateXBATBlocks(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32[],System.Int32)">
  23070. <summary>
  23071. Create an array of XBATBlocks from an array of int block
  23072. allocation table entries
  23073. </summary>
  23074. <param name="bigBlockSize"></param>
  23075. <param name="entries">the array of int entries</param>
  23076. <param name="startBlock">the start block of the array of XBAT blocks</param>
  23077. <returns>the newly created array of BATBlocks</returns>
  23078. </member>
  23079. <member name="M:NPOI.POIFS.Storage.BATBlock.CalculateStorageRequirements(System.Int32)">
  23080. <summary>
  23081. Calculate how many BATBlocks are needed to hold a specified
  23082. number of BAT entries.
  23083. </summary>
  23084. <param name="entryCount">the number of entries</param>
  23085. <returns>the number of BATBlocks needed</returns>
  23086. </member>
  23087. <member name="M:NPOI.POIFS.Storage.BATBlock.CalculateXBATStorageRequirements(System.Int32)">
  23088. <summary>
  23089. Calculate how many XBATBlocks are needed to hold a specified
  23090. number of BAT entries.
  23091. </summary>
  23092. <param name="entryCount">the number of entries</param>
  23093. <returns>the number of XBATBlocks needed</returns>
  23094. </member>
  23095. <member name="M:NPOI.POIFS.Storage.BATBlock.CalculateMaximumSize(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32)">
  23096. Calculates the maximum size of a file which is addressable given the
  23097. number of FAT (BAT) sectors specified. (We don't care if those BAT
  23098. blocks come from the 109 in the header, or from header + XBATS, it
  23099. won't affect the calculation)
  23100. The actual file size will be between [size of fatCount-1 blocks] and
  23101. [size of fatCount blocks].
  23102. For 512 byte block sizes, this means we may over-estimate by up to 65kb.
  23103. For 4096 byte block sizes, this means we may over-estimate by up to 4mb
  23104. </member>
  23105. <member name="M:NPOI.POIFS.Storage.BATBlock.#ctor(System.Int32[],System.Int32,System.Int32)">
  23106. <summary>
  23107. Create a single instance initialized (perhaps partially) with entries
  23108. </summary>
  23109. <param name="entries">the array of block allocation table entries</param>
  23110. <param name="start_index">the index of the first entry to be written
  23111. to the block</param>
  23112. <param name="end_index">the index, plus one, of the last entry to be
  23113. written to the block (writing is for all index
  23114. k, start_index less than k less than end_index)
  23115. </param>
  23116. </member>
  23117. <member name="M:NPOI.POIFS.Storage.BATBlock.WriteData(System.IO.Stream)">
  23118. <summary>
  23119. Write the block's data to an Stream
  23120. </summary>
  23121. <param name="stream">the Stream to which the stored data should
  23122. be written</param>
  23123. </member>
  23124. <member name="P:NPOI.POIFS.Storage.BATBlock.EntriesPerBlock">
  23125. <summary>
  23126. Gets the entries per block.
  23127. </summary>
  23128. <value>The number of entries per block</value>
  23129. </member>
  23130. <member name="P:NPOI.POIFS.Storage.BATBlock.EntriesPerXBATBlock">
  23131. <summary>
  23132. Gets the entries per XBAT block.
  23133. </summary>
  23134. <value>number of entries per XBAT block</value>
  23135. </member>
  23136. <member name="P:NPOI.POIFS.Storage.BATBlock.XBATChainOffset">
  23137. <summary>
  23138. Gets the XBAT chain offset.
  23139. </summary>
  23140. <value>offset of chain index of XBAT block</value>
  23141. </member>
  23142. <member name="P:NPOI.POIFS.Storage.BATBlock.HasFreeSectors">
  23143. Does this BATBlock have any free sectors in it, or
  23144. is it full?
  23145. </member>
  23146. <member name="P:NPOI.POIFS.Storage.BATBlock.OurBlockIndex">
  23147. Retrieve where in the file we live
  23148. </member>
  23149. <member name="T:NPOI.POIFS.Storage.BlockAllocationTableReader">
  23150. <summary>
  23151. This class manages and creates the Block Allocation Table, which is
  23152. basically a set of linked lists of block indices.
  23153. Each block of the filesystem has an index. The first block, the
  23154. header, is skipped; the first block after the header is index 0,
  23155. the next is index 1, and so on.
  23156. A block's index is also its index into the Block Allocation
  23157. Table. The entry that it finds in the Block Allocation Table is the
  23158. index of the next block in the linked list of blocks making up a
  23159. file, or it is set to -2: end of list.
  23160. @author Marc Johnson (mjohnson at apache dot org)
  23161. </summary>
  23162. </member>
  23163. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32,System.Int32[],System.Int32,System.Int32,NPOI.POIFS.Storage.BlockList)">
  23164. <summary>
  23165. create a BlockAllocationTableReader for an existing filesystem. Side
  23166. effect: when this method finishes, the BAT blocks will have
  23167. been Removed from the raw block list, and any blocks labeled as
  23168. 'unused' in the block allocation table will also have been
  23169. Removed from the raw block list. </summary>
  23170. <param name="bigBlockSizse">the poifs bigBlockSize</param>
  23171. <param name="block_count">the number of BAT blocks making up the block allocation table</param>
  23172. <param name="block_array">the array of BAT block indices from the
  23173. filesystem's header</param>
  23174. <param name="xbat_count">the number of XBAT blocks</param>
  23175. <param name="xbat_index">the index of the first XBAT block</param>
  23176. <param name="raw_block_list">the list of RawDataBlocks</param>
  23177. </member>
  23178. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.ListManagedBlock[],NPOI.POIFS.Storage.BlockList)">
  23179. <summary>
  23180. create a BlockAllocationTableReader from an array of raw data blocks
  23181. </summary>
  23182. <param name="bigBlockSize"></param>
  23183. <param name="blocks">the raw data</param>
  23184. <param name="raw_block_list">the list holding the managed blocks</param>
  23185. </member>
  23186. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize)">
  23187. <summary>
  23188. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.BlockAllocationTableReader"/> class.
  23189. </summary>
  23190. </member>
  23191. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.FetchBlocks(System.Int32,System.Int32,NPOI.POIFS.Storage.BlockList)">
  23192. <summary>
  23193. walk the entries from a specified point and return the
  23194. associated blocks. The associated blocks are Removed from the block list
  23195. </summary>
  23196. <param name="startBlock">the first block in the chain</param>
  23197. <param name="headerPropertiesStartBlock"></param>
  23198. <param name="blockList">the raw data block list</param>
  23199. <returns>array of ListManagedBlocks, in their correct order</returns>
  23200. </member>
  23201. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.IsUsed(System.Int32)">
  23202. <summary>
  23203. determine whether the block specified by index is used or not
  23204. </summary>
  23205. <param name="index">determine whether the block specified by index is used or not</param>
  23206. <returns>
  23207. <c>true</c> if the specified block is used; otherwise, <c>false</c>.
  23208. </returns>
  23209. </member>
  23210. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.GetNextBlockIndex(System.Int32)">
  23211. <summary>
  23212. return the next block index
  23213. </summary>
  23214. <param name="index">The index of the current block</param>
  23215. <returns>index of the next block (may be
  23216. POIFSConstants.END_OF_CHAIN, indicating end of chain
  23217. (duh))</returns>
  23218. </member>
  23219. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.SetEntries(NPOI.POIFS.Storage.ListManagedBlock[],NPOI.POIFS.Storage.BlockList)">
  23220. <summary>
  23221. Convert an array of blocks into a Set of integer indices
  23222. </summary>
  23223. <param name="blocks">the array of blocks containing the indices</param>
  23224. <param name="raw_blocks">the list of blocks being managed. Unused
  23225. blocks will be eliminated from the list</param>
  23226. </member>
  23227. <member name="T:NPOI.POIFS.Storage.BlockAllocationTableWriter">
  23228. <summary>
  23229. This class manages and creates the Block Allocation Table, which is
  23230. basically a set of linked lists of block indices.
  23231. Each block of the filesystem has an index. The first block, the
  23232. header, is skipped; the first block after the header is index 0,
  23233. the next is index 1, and so on.
  23234. A block's index is also its index into the Block Allocation
  23235. Table. The entry that it finds in the Block Allocation Table is the
  23236. index of the next block in the linked list of blocks making up a
  23237. file, or it is set to -2: end of list.
  23238. *
  23239. @author Marc Johnson (mjohnson at apache dot org)
  23240. </summary>
  23241. </member>
  23242. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize)">
  23243. <summary>
  23244. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.BlockAllocationTableWriter"/> class.
  23245. </summary>
  23246. </member>
  23247. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.CreateBlocks">
  23248. <summary>
  23249. Create the BATBlocks we need
  23250. </summary>
  23251. <returns>start block index of BAT blocks</returns>
  23252. </member>
  23253. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.AllocateSpace(System.Int32)">
  23254. <summary>
  23255. Allocate space for a block of indices
  23256. </summary>
  23257. <param name="blockCount">the number of blocks to allocate space for</param>
  23258. <returns>the starting index of the blocks</returns>
  23259. </member>
  23260. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.SimpleCreateBlocks">
  23261. <summary>
  23262. create the BATBlocks
  23263. </summary>
  23264. </member>
  23265. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.WriteBlocks(System.IO.Stream)">
  23266. <summary>
  23267. Write the storage to an OutputStream
  23268. </summary>
  23269. <param name="stream">the OutputStream to which the stored data should be written</param>
  23270. </member>
  23271. <member name="P:NPOI.POIFS.Storage.BlockAllocationTableWriter.StartBlock">
  23272. <summary>
  23273. Sets the start block for this instance
  23274. </summary>
  23275. <value>
  23276. index into the array of BigBlock instances making up the the filesystem
  23277. </value>
  23278. </member>
  23279. <member name="P:NPOI.POIFS.Storage.BlockAllocationTableWriter.CountBlocks">
  23280. <summary>
  23281. Gets the number of BigBlock's this instance uses
  23282. </summary>
  23283. <value>count of BigBlock instances</value>
  23284. </member>
  23285. <member name="T:NPOI.POIFS.Storage.BlockList">
  23286. <summary>
  23287. Interface for lists of blocks that are mapped by block allocation
  23288. tables
  23289. @author Marc Johnson (mjohnson at apache dot org)
  23290. </summary>
  23291. </member>
  23292. <member name="M:NPOI.POIFS.Storage.BlockList.Zap(System.Int32)">
  23293. <summary>
  23294. remove the specified block from the list
  23295. </summary>
  23296. <param name="index">the index of the specified block; if the index is
  23297. out of range, that's ok</param>
  23298. </member>
  23299. <member name="M:NPOI.POIFS.Storage.BlockList.Remove(System.Int32)">
  23300. <summary>
  23301. Remove and return the specified block from the list
  23302. </summary>
  23303. <param name="index">the index of the specified block</param>
  23304. <returns>the specified block</returns>
  23305. </member>
  23306. <member name="M:NPOI.POIFS.Storage.BlockList.FetchBlocks(System.Int32,System.Int32)">
  23307. <summary>
  23308. get the blocks making up a particular stream in the list. The
  23309. blocks are removed from the list.
  23310. </summary>
  23311. <param name="startBlock">the index of the first block in the stream</param>
  23312. <param name="headerPropertiesStartBlock"></param>
  23313. <returns>the stream as an array of correctly ordered blocks</returns>
  23314. </member>
  23315. <member name="P:NPOI.POIFS.Storage.BlockList.BAT">
  23316. <summary>
  23317. set the associated BlockAllocationTable
  23318. </summary>
  23319. <value>the associated BlockAllocationTable</value>
  23320. </member>
  23321. <member name="M:NPOI.POIFS.Storage.BlockListImpl.#ctor">
  23322. <summary>
  23323. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.BlockListImpl"/> class.
  23324. </summary>
  23325. </member>
  23326. <member name="M:NPOI.POIFS.Storage.BlockListImpl.SetBlocks(NPOI.POIFS.Storage.ListManagedBlock[])">
  23327. <summary>
  23328. provide blocks to manage
  23329. </summary>
  23330. <param name="blocks">blocks to be managed</param>
  23331. </member>
  23332. <member name="M:NPOI.POIFS.Storage.BlockListImpl.Zap(System.Int32)">
  23333. <summary>
  23334. remove the specified block from the list
  23335. </summary>
  23336. <param name="index">the index of the specified block; if the index is
  23337. out of range, that's ok</param>
  23338. </member>
  23339. <member name="M:NPOI.POIFS.Storage.BlockListImpl.Remove(System.Int32)">
  23340. <summary>
  23341. Remove and return the specified block from the list
  23342. </summary>
  23343. <param name="index">the index of the specified block</param>
  23344. <returns>the specified block</returns>
  23345. </member>
  23346. <member name="M:NPOI.POIFS.Storage.BlockListImpl.FetchBlocks(System.Int32,System.Int32)">
  23347. <summary>
  23348. get the blocks making up a particular stream in the list. The
  23349. blocks are removed from the list.
  23350. </summary>
  23351. <param name="startBlock">the index of the first block in the stream</param>
  23352. <param name="headerPropertiesStartBlock"></param>
  23353. <returns>
  23354. the stream as an array of correctly ordered blocks
  23355. </returns>
  23356. </member>
  23357. <member name="P:NPOI.POIFS.Storage.BlockListImpl.BAT">
  23358. <summary>
  23359. set the associated BlockAllocationTable
  23360. </summary>
  23361. <value>the associated BlockAllocationTable</value>
  23362. </member>
  23363. <member name="T:NPOI.POIFS.Storage.DataInputBlock">
  23364. Wraps a <c>byte</c> array and provides simple data input access.
  23365. Internally, this class maintains a buffer read index, so that for the most part, primitive
  23366. data can be read in a data-input-stream-like manner.<p/>
  23367. Note - the calling class should call the {@link #available()} method to detect end-of-buffer
  23368. and Move to the next data block when the current is exhausted.
  23369. For optimisation reasons, no error handling is performed in this class. Thus, mistakes in
  23370. calling code ran may raise ugly exceptions here, like {@link ArrayIndexOutOfBoundsException},
  23371. etc .<p/>
  23372. The multi-byte primitive input methods ({@link #readUshortLE()}, {@link #readIntLE()} and
  23373. {@link #readLongLE()}) have corresponding 'spanning Read' methods which (when required) perform
  23374. a read across the block boundary. These spanning read methods take the previous
  23375. {@link DataInputBlock} as a parameter.
  23376. Reads of larger amounts of data (into <c>byte</c> array buffers) must be managed by the caller
  23377. since these could conceivably involve more than two blocks.
  23378. @author Josh Micich
  23379. </member>
  23380. <member name="F:NPOI.POIFS.Storage.DataInputBlock._buf">
  23381. Possibly any size (usually 512K or 64K). Assumed to be at least 8 bytes for all blocks
  23382. before the end of the stream. The last block in the stream can be any size except zero.
  23383. </member>
  23384. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadUshortLE">
  23385. Reads a <c>short</c> which was encoded in <em>little endian</em> format.
  23386. </member>
  23387. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadUshortLE(NPOI.POIFS.Storage.DataInputBlock)">
  23388. Reads a <c>short</c> which spans the end of <c>prevBlock</c> and the start of this block.
  23389. </member>
  23390. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadIntLE">
  23391. Reads an <c>int</c> which was encoded in <em>little endian</em> format.
  23392. </member>
  23393. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadIntLE(NPOI.POIFS.Storage.DataInputBlock,System.Int32)">
  23394. Reads an <c>int</c> which spans the end of <c>prevBlock</c> and the start of this block.
  23395. </member>
  23396. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadLongLE">
  23397. Reads a <c>long</c> which was encoded in <em>little endian</em> format.
  23398. </member>
  23399. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadLongLE(NPOI.POIFS.Storage.DataInputBlock,System.Int32)">
  23400. Reads a <c>long</c> which spans the end of <c>prevBlock</c> and the start of this block.
  23401. </member>
  23402. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadSpanning(NPOI.POIFS.Storage.DataInputBlock,System.Int32,System.Byte[])">
  23403. Reads a small amount of data from across the boundary between two blocks.
  23404. The {@link #_readIndex} of this (the second) block is updated accordingly.
  23405. Note- this method (and other code) assumes that the second {@link DataInputBlock}
  23406. always is big enough to complete the read without being exhausted.
  23407. </member>
  23408. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadFully(System.Byte[],System.Int32,System.Int32)">
  23409. Reads <c>len</c> bytes from this block into the supplied buffer.
  23410. </member>
  23411. <member name="M:NPOI.POIFS.Storage.DocumentBlock.#ctor(NPOI.POIFS.Storage.RawDataBlock)">
  23412. <summary>
  23413. create a document block from a raw data block
  23414. </summary>
  23415. <param name="block">The block.</param>
  23416. </member>
  23417. <member name="M:NPOI.POIFS.Storage.DocumentBlock.#ctor(System.IO.Stream,NPOI.POIFS.Common.POIFSBigBlockSize)">
  23418. <summary>
  23419. Create a single instance initialized with data.
  23420. </summary>
  23421. <param name="stream">the InputStream delivering the data.</param>
  23422. <param name="bigBlockSize">the poifs bigBlockSize</param>
  23423. </member>
  23424. <member name="M:NPOI.POIFS.Storage.DocumentBlock.Convert(NPOI.POIFS.Common.POIFSBigBlockSize,System.Byte[],System.Int32)">
  23425. <summary>
  23426. convert a single long array into an array of DocumentBlock
  23427. instances
  23428. </summary>
  23429. <param name="bigBlockSize">the poifs bigBlockSize</param>
  23430. <param name="array">the byte array to be converted</param>
  23431. <param name="size">the intended size of the array (which may be smaller)</param>
  23432. <returns>an array of DocumentBlock instances, filled from the
  23433. input array</returns>
  23434. </member>
  23435. <member name="M:NPOI.POIFS.Storage.DocumentBlock.Read(NPOI.POIFS.Storage.DocumentBlock[],System.Byte[],System.Int32)">
  23436. <summary>
  23437. Read data from an array of DocumentBlocks
  23438. </summary>
  23439. <param name="blocks">the blocks to Read from</param>
  23440. <param name="buffer">the buffer to Write the data into</param>
  23441. <param name="offset">the offset into the array of blocks to Read from</param>
  23442. </member>
  23443. <member name="M:NPOI.POIFS.Storage.DocumentBlock.WriteData(System.IO.Stream)">
  23444. <summary>
  23445. Write the storage to an OutputStream
  23446. </summary>
  23447. <param name="stream">the OutputStream to which the stored data should
  23448. be written</param>
  23449. </member>
  23450. <member name="P:NPOI.POIFS.Storage.DocumentBlock.Size">
  23451. <summary>
  23452. Get the number of bytes Read for this block.
  23453. </summary>
  23454. <value>bytes Read into the block</value>
  23455. </member>
  23456. <member name="P:NPOI.POIFS.Storage.DocumentBlock.PartiallyRead">
  23457. <summary>
  23458. Was this a partially Read block?
  23459. </summary>
  23460. <value><c>true</c> if the block was only partially filled with data</value>
  23461. </member>
  23462. <member name="P:NPOI.POIFS.Storage.DocumentBlock.FillByte">
  23463. <summary>
  23464. Gets the fill byte used
  23465. </summary>
  23466. <value>The fill byte.</value>
  23467. </member>
  23468. <member name="T:NPOI.POIFS.Storage.HeaderBlockReader">
  23469. <summary>
  23470. The block containing the archive header
  23471. @author Marc Johnson (mjohnson at apache dot org)
  23472. </summary>
  23473. </member>
  23474. <member name="F:NPOI.POIFS.Storage.HeaderBlockReader.bigBlockSize">
  23475. What big block Size the file uses. Most files
  23476. use 512 bytes, but a few use 4096
  23477. </member>
  23478. <member name="F:NPOI.POIFS.Storage.HeaderBlockReader._sbat_count">
  23479. Number of small block allocation table blocks (int)
  23480. (Number of MiniFAT Sectors in Microsoft parlance)
  23481. </member>
  23482. <member name="M:NPOI.POIFS.Storage.HeaderBlockReader.#ctor(System.IO.Stream)">
  23483. <summary>
  23484. create a new HeaderBlockReader from an Stream
  23485. </summary>
  23486. <param name="stream">the source Stream</param>
  23487. </member>
  23488. <member name="M:NPOI.POIFS.Storage.HeaderBlockReader.AlertShortRead(System.Int32,System.Int32)">
  23489. <summary>
  23490. Alerts the short read.
  23491. </summary>
  23492. <param name="read">The read.</param>
  23493. <param name="expectedReadSize">expected size to read</param>
  23494. </member>
  23495. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.PropertyStart">
  23496. <summary>
  23497. Get start of Property Table
  23498. </summary>
  23499. <value>the index of the first block of the Property Table</value>
  23500. </member>
  23501. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.SBATStart">
  23502. <summary>
  23503. Gets start of small block allocation table
  23504. </summary>
  23505. <value>The SBAT start.</value>
  23506. </member>
  23507. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.BATCount">
  23508. <summary>
  23509. Gets number of BAT blocks
  23510. </summary>
  23511. <value>The BAT count.</value>
  23512. </member>
  23513. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.BATArray">
  23514. <summary>
  23515. Gets the BAT array.
  23516. </summary>
  23517. <value>The BAT array.</value>
  23518. </member>
  23519. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.XBATCount">
  23520. <summary>
  23521. Gets the XBAT count.
  23522. </summary>
  23523. <value>The XBAT count.</value>
  23524. @return XBAT count
  23525. </member>
  23526. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.XBATIndex">
  23527. <summary>
  23528. Gets the index of the XBAT.
  23529. </summary>
  23530. <value>The index of the XBAT.</value>
  23531. </member>
  23532. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.BigBlockSize">
  23533. <summary>
  23534. Gets The Big Block Size, normally 512 bytes, sometimes 4096 bytes
  23535. </summary>
  23536. <value>The size of the big block.</value>
  23537. @return
  23538. </member>
  23539. <member name="T:NPOI.POIFS.Storage.HeaderBlockWriter">
  23540. <summary>
  23541. The block containing the archive header
  23542. @author Marc Johnson (mjohnson at apache dot org)
  23543. </summary>
  23544. </member>
  23545. <member name="M:NPOI.POIFS.Storage.HeaderBlockWriter.SetBATBlocks(System.Int32,System.Int32)">
  23546. <summary>
  23547. Set BAT block parameters. Assumes that all BAT blocks are
  23548. contiguous. Will construct XBAT blocks if necessary and return
  23549. the array of newly constructed XBAT blocks.
  23550. </summary>
  23551. <param name="blockCount">count of BAT blocks</param>
  23552. <param name="startBlock">index of first BAT block</param>
  23553. <returns>array of XBAT blocks; may be zero Length, will not be
  23554. null</returns>
  23555. </member>
  23556. <member name="M:NPOI.POIFS.Storage.HeaderBlockWriter.CalculateXBATStorageRequirements(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32)">
  23557. <summary>
  23558. For a given number of BAT blocks, calculate how many XBAT
  23559. blocks will be needed
  23560. </summary>
  23561. <param name="bigBlockSize"></param>
  23562. <param name="blockCount">number of BAT blocks</param>
  23563. <returns>number of XBAT blocks needed</returns>
  23564. </member>
  23565. <member name="M:NPOI.POIFS.Storage.HeaderBlockWriter.WriteBlocks(System.IO.Stream)">
  23566. <summary>
  23567. Write the block's data to an Stream
  23568. </summary>
  23569. <param name="stream">the Stream to which the stored data should
  23570. be written
  23571. </param>
  23572. </member>
  23573. <member name="P:NPOI.POIFS.Storage.HeaderBlockWriter.PropertyStart">
  23574. <summary>
  23575. Set start of Property Table
  23576. </summary>
  23577. <value>the index of the first block of the Property
  23578. Table</value>
  23579. </member>
  23580. <member name="P:NPOI.POIFS.Storage.HeaderBlockWriter.SBAStart">
  23581. <summary>
  23582. Set start of small block allocation table
  23583. </summary>
  23584. <value>the index of the first big block of the small
  23585. block allocation table</value>
  23586. </member>
  23587. <member name="P:NPOI.POIFS.Storage.HeaderBlockWriter.SBATBlockCount">
  23588. <summary>
  23589. Set count of SBAT blocks
  23590. </summary>
  23591. <value>the number of SBAT blocks</value>
  23592. </member>
  23593. <member name="T:NPOI.POIFS.Storage.ListManagedBlock">
  23594. <summary>
  23595. An interface for blocks managed by a list that works with a
  23596. BlockAllocationTable to keep block sequences straight
  23597. @author Marc Johnson (mjohnson at apache dot org
  23598. </summary>
  23599. </member>
  23600. <member name="P:NPOI.POIFS.Storage.ListManagedBlock.Data">
  23601. <summary>
  23602. Get the data from the block
  23603. </summary>
  23604. <value>the block's data as a byte array</value>
  23605. </member>
  23606. <member name="T:NPOI.POIFS.Storage.PropertyBlock">
  23607. <summary>
  23608. A block of Property instances
  23609. @author Marc Johnson (mjohnson at apache dot org)
  23610. </summary>
  23611. </member>
  23612. <member name="M:NPOI.POIFS.Storage.PropertyBlock.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Properties.Property[],System.Int32)">
  23613. <summary>
  23614. Create a single instance initialized with default values
  23615. </summary>
  23616. <param name="bigBlockSize"></param>
  23617. <param name="properties">the properties to be inserted</param>
  23618. <param name="offset">the offset into the properties array</param>
  23619. </member>
  23620. <member name="M:NPOI.POIFS.Storage.PropertyBlock.CreatePropertyBlockArray(NPOI.POIFS.Common.POIFSBigBlockSize,System.Collections.Generic.List{NPOI.POIFS.Properties.Property})">
  23621. <summary>
  23622. Create an array of PropertyBlocks from an array of Property
  23623. instances, creating empty Property instances to make up any
  23624. shortfall
  23625. </summary>
  23626. <param name="bigBlockSize"></param>
  23627. <param name="properties">the Property instances to be converted into PropertyBlocks, in a java List</param>
  23628. <returns>the array of newly created PropertyBlock instances</returns>
  23629. </member>
  23630. <member name="M:NPOI.POIFS.Storage.PropertyBlock.WriteData(System.IO.Stream)">
  23631. <summary>
  23632. Write the block's data to an OutputStream
  23633. </summary>
  23634. <param name="stream">the OutputStream to which the stored data should be written</param>
  23635. </member>
  23636. <member name="T:NPOI.POIFS.Storage.RawDataBlock">
  23637. <summary>
  23638. A big block created from an InputStream, holding the raw data
  23639. @author Marc Johnson (mjohnson at apache dot org
  23640. </summary>
  23641. </member>
  23642. <member name="M:NPOI.POIFS.Storage.RawDataBlock.#ctor(System.IO.Stream)">
  23643. <summary>
  23644. Constructor RawDataBlock
  23645. </summary>
  23646. <param name="stream">the Stream from which the data will be read</param>
  23647. </member>
  23648. <member name="M:NPOI.POIFS.Storage.RawDataBlock.#ctor(System.IO.Stream,System.Int32)">
  23649. <summary>
  23650. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.RawDataBlock"/> class.
  23651. </summary>
  23652. <param name="stream">the Stream from which the data will be read</param>
  23653. <param name="blockSize">the size of the POIFS blocks, normally 512 bytes {@link POIFSConstants#BIG_BLOCK_SIZE}</param>
  23654. </member>
  23655. <member name="P:NPOI.POIFS.Storage.RawDataBlock.EOF">
  23656. <summary>
  23657. When we read the data, did we hit end of file?
  23658. </summary>
  23659. <value><c>true</c> if the EoF was hit during this block, or; otherwise, <c>false</c>if not. If you have a dodgy short last block, then
  23660. it's possible to both have data, and also hit EoF...</value>
  23661. </member>
  23662. <member name="P:NPOI.POIFS.Storage.RawDataBlock.HasData">
  23663. <summary>
  23664. Did we actually find any data to read? It's possible,
  23665. in the event of a short last block, to both have hit
  23666. the EoF, but also to have data
  23667. </summary>
  23668. <value><c>true</c> if this instance has data; otherwise, <c>false</c>.</value>
  23669. </member>
  23670. <member name="P:NPOI.POIFS.Storage.RawDataBlock.Data">
  23671. <summary>
  23672. Get the data from the block
  23673. </summary>
  23674. <value>the block's data as a byte array</value>
  23675. </member>
  23676. <member name="T:NPOI.POIFS.Storage.RawDataBlockList">
  23677. <summary>
  23678. A list of RawDataBlocks instances, and methods to manage the list
  23679. @author Marc Johnson (mjohnson at apache dot org
  23680. </summary>
  23681. </member>
  23682. <member name="M:NPOI.POIFS.Storage.RawDataBlockList.#ctor(System.IO.Stream,NPOI.POIFS.Common.POIFSBigBlockSize)">
  23683. <summary>
  23684. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.RawDataBlockList"/> class.
  23685. </summary>
  23686. <param name="stream">the InputStream from which the data will be read</param>
  23687. <param name="bigBlockSize">The big block size, either 512 bytes or 4096 bytes</param>
  23688. </member>
  23689. <member name="T:NPOI.POIFS.Storage.SmallBlockTableReader">
  23690. <summary>
  23691. This class implements reading the small document block list from an
  23692. existing file
  23693. @author Marc Johnson (mjohnson at apache dot org)
  23694. </summary>
  23695. </member>
  23696. <member name="M:NPOI.POIFS.Storage.SmallBlockTableReader.GetSmallDocumentBlocks(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.RawDataBlockList,NPOI.POIFS.Properties.RootProperty,System.Int32)">
  23697. <summary>
  23698. fetch the small document block list from an existing file
  23699. </summary>
  23700. <param name="bigBlockSize">the poifs bigBlockSize</param>
  23701. <param name="blockList">the raw data from which the small block table will be extracted</param>
  23702. <param name="root">the root property (which contains the start block and small block table size)</param>
  23703. <param name="sbatStart">the start block of the SBAT</param>
  23704. <returns>the small document block list</returns>
  23705. </member>
  23706. <member name="T:NPOI.POIFS.Storage.SmallBlockTableWriter">
  23707. <summary>
  23708. This class implements reading the small document block list from an
  23709. existing file
  23710. @author Marc Johnson (mjohnson at apache dot org)
  23711. </summary>
  23712. </member>
  23713. <member name="M:NPOI.POIFS.Storage.SmallBlockTableWriter.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,System.Collections.IList,NPOI.POIFS.Properties.RootProperty)">
  23714. <summary>
  23715. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.SmallBlockTableWriter"/> class.
  23716. </summary>
  23717. <param name="bigBlockSize">the poifs bigBlockSize</param>
  23718. <param name="documents">a IList of POIFSDocument instances</param>
  23719. <param name="root">the Filesystem's root property</param>
  23720. </member>
  23721. <member name="M:NPOI.POIFS.Storage.SmallBlockTableWriter.WriteBlocks(System.IO.Stream)">
  23722. <summary>
  23723. Write the storage to an OutputStream
  23724. </summary>
  23725. <param name="stream">the OutputStream to which the stored data should be written</param>
  23726. </member>
  23727. <member name="P:NPOI.POIFS.Storage.SmallBlockTableWriter.SBATBlockCount">
  23728. <summary>
  23729. Get the number of SBAT blocks
  23730. </summary>
  23731. <value>number of SBAT big blocks</value>
  23732. </member>
  23733. <member name="P:NPOI.POIFS.Storage.SmallBlockTableWriter.SBAT">
  23734. <summary>
  23735. Gets the SBAT.
  23736. </summary>
  23737. <value>the Small Block Allocation Table</value>
  23738. </member>
  23739. <member name="P:NPOI.POIFS.Storage.SmallBlockTableWriter.CountBlocks">
  23740. <summary>
  23741. Return the number of BigBlock's this instance uses
  23742. </summary>
  23743. <value>count of BigBlock instances</value>
  23744. </member>
  23745. <member name="P:NPOI.POIFS.Storage.SmallBlockTableWriter.StartBlock">
  23746. <summary>
  23747. Sets the start block.
  23748. </summary>
  23749. <value>The start block.</value>
  23750. </member>
  23751. <member name="T:NPOI.POIFS.Storage.SmallDocumentBlock">
  23752. <summary>
  23753. Storage for documents that are too small to use regular
  23754. DocumentBlocks for their data
  23755. @author Marc Johnson (mjohnson at apache dot org)
  23756. </summary>
  23757. </member>
  23758. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Convert(NPOI.POIFS.Common.POIFSBigBlockSize,System.Byte[],System.Int32)">
  23759. <summary>
  23760. convert a single long array into an array of SmallDocumentBlock
  23761. instances
  23762. </summary>
  23763. <param name="bigBlockSize">the poifs bigBlockSize</param>
  23764. <param name="array">the byte array to be converted</param>
  23765. <param name="size">the intended size of the array (which may be smaller)</param>
  23766. <returns>an array of SmallDocumentBlock instances, filled from
  23767. the array</returns>
  23768. </member>
  23769. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Fill(NPOI.POIFS.Common.POIFSBigBlockSize,System.Collections.IList)">
  23770. <summary>
  23771. fill out a List of SmallDocumentBlocks so that it fully occupies
  23772. a Set of big blocks
  23773. </summary>
  23774. <param name="bigBlockSize"></param>
  23775. <param name="blocks">the List to be filled out.</param>
  23776. <returns>number of big blocks the list encompasses</returns>
  23777. </member>
  23778. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Convert(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.BlockWritable[],System.Int32)">
  23779. <summary>
  23780. Factory for creating SmallDocumentBlocks from DocumentBlocks
  23781. </summary>
  23782. <param name="bigBlocksSize"></param>
  23783. <param name="store">the original DocumentBlocks</param>
  23784. <param name="size">the total document size</param>
  23785. <returns>an array of new SmallDocumentBlocks instances</returns>
  23786. </member>
  23787. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Extract(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.ListManagedBlock[])">
  23788. <summary>
  23789. create a list of SmallDocumentBlock's from raw data
  23790. </summary>
  23791. <param name="bigBlockSize"></param>
  23792. <param name="blocks">the raw data containing the SmallDocumentBlock</param>
  23793. <returns>a List of SmallDocumentBlock's extracted from the input</returns>
  23794. </member>
  23795. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Read(NPOI.POIFS.Storage.BlockWritable[],System.Byte[],System.Int32)">
  23796. <summary>
  23797. Read data from an array of SmallDocumentBlocks
  23798. </summary>
  23799. <param name="blocks">the blocks to Read from.</param>
  23800. <param name="buffer">the buffer to Write the data into.</param>
  23801. <param name="offset">the offset into the array of blocks to Read from</param>
  23802. </member>
  23803. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.CalcSize(System.Int32)">
  23804. <summary>
  23805. Calculate the storage size of a Set of SmallDocumentBlocks
  23806. </summary>
  23807. <param name="size"> number of SmallDocumentBlocks</param>
  23808. <returns>total size</returns>
  23809. </member>
  23810. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.MakeEmptySmallDocumentBlock(NPOI.POIFS.Common.POIFSBigBlockSize)">
  23811. <summary>
  23812. Makes the empty small document block.
  23813. </summary>
  23814. <returns></returns>
  23815. </member>
  23816. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.ConvertToBlockCount(System.Int32)">
  23817. <summary>
  23818. Converts to block count.
  23819. </summary>
  23820. <param name="size">The size.</param>
  23821. <returns></returns>
  23822. </member>
  23823. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.WriteBlocks(System.IO.Stream)">
  23824. <summary>
  23825. Write the storage to an OutputStream
  23826. </summary>
  23827. <param name="stream">the OutputStream to which the stored data should
  23828. be written</param>
  23829. </member>
  23830. <member name="P:NPOI.POIFS.Storage.SmallDocumentBlock.Data">
  23831. <summary>
  23832. Get the data from the block
  23833. </summary>
  23834. <value>the block's data as a byte array</value>
  23835. </member>
  23836. <member name="T:NPOI.POIFS.Storage.SmallDocumentBlockList">
  23837. <summary>
  23838. A list of SmallDocumentBlocks instances, and methods to manage the list
  23839. @author Marc Johnson (mjohnson at apache dot org)
  23840. </summary>
  23841. </member>
  23842. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlockList.#ctor(System.Collections.Generic.List{NPOI.POIFS.Storage.SmallDocumentBlock})">
  23843. <summary>
  23844. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.SmallDocumentBlockList"/> class.
  23845. </summary>
  23846. <param name="blocks">a list of SmallDocumentBlock instances</param>
  23847. </member>
  23848. <member name="T:NPOI.HSSF.Util.HSSFCellUtil">
  23849. <summary>
  23850. Various utility functions that make working with a cells and rows easier. The various
  23851. methods that deal with style's allow you to Create your HSSFCellStyles as you need them.
  23852. When you apply a style change to a cell, the code will attempt to see if a style already
  23853. exists that meets your needs. If not, then it will Create a new style. This is to prevent
  23854. creating too many styles. there is an upper limit in Excel on the number of styles that
  23855. can be supported.
  23856. @author Eric Pugh epugh@upstate.com
  23857. </summary>
  23858. </member>
  23859. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.GetRow(System.Int32,NPOI.HSSF.UserModel.HSSFSheet)">
  23860. <summary>
  23861. Get a row from the spreadsheet, and Create it if it doesn't exist.
  23862. </summary>
  23863. <param name="rowCounter">The 0 based row number</param>
  23864. <param name="sheet">The sheet that the row is part of.</param>
  23865. <returns>The row indicated by the rowCounter</returns>
  23866. </member>
  23867. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.GetCell(NPOI.SS.UserModel.IRow,System.Int32)">
  23868. <summary>
  23869. Get a specific cell from a row. If the cell doesn't exist,
  23870. </summary>
  23871. <param name="row">The row that the cell is part of</param>
  23872. <param name="column">The column index that the cell is in.</param>
  23873. <returns>The cell indicated by the column.</returns>
  23874. </member>
  23875. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.CreateCell(NPOI.SS.UserModel.IRow,System.Int32,System.String,NPOI.HSSF.UserModel.HSSFCellStyle)">
  23876. <summary>
  23877. Creates a cell, gives it a value, and applies a style if provided
  23878. </summary>
  23879. <param name="row">the row to Create the cell in</param>
  23880. <param name="column">the column index to Create the cell in</param>
  23881. <param name="value">The value of the cell</param>
  23882. <param name="style">If the style is not null, then Set</param>
  23883. <returns>A new HSSFCell</returns>
  23884. </member>
  23885. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.CreateCell(NPOI.SS.UserModel.IRow,System.Int32,System.String)">
  23886. <summary>
  23887. Create a cell, and give it a value.
  23888. </summary>
  23889. <param name="row">the row to Create the cell in</param>
  23890. <param name="column">the column index to Create the cell in</param>
  23891. <param name="value">The value of the cell</param>
  23892. <returns>A new HSSFCell.</returns>
  23893. </member>
  23894. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.RemapCellStyle(NPOI.HSSF.UserModel.HSSFCellStyle,System.Collections.Generic.Dictionary{System.Int16,System.Int16})">
  23895. <summary>
  23896. Translate color palette entries from the source to the destination sheet
  23897. </summary>
  23898. </member>
  23899. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.SetAlignment(NPOI.SS.UserModel.ICell,NPOI.HSSF.UserModel.HSSFWorkbook,System.Int16)">
  23900. <summary>
  23901. Take a cell, and align it.
  23902. </summary>
  23903. <param name="cell">the cell to Set the alignment for</param>
  23904. <param name="workbook">The workbook that is being worked with.</param>
  23905. <param name="align">the column alignment to use.</param>
  23906. </member>
  23907. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.SetFont(NPOI.SS.UserModel.ICell,NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFFont)">
  23908. <summary>
  23909. Take a cell, and apply a font to it
  23910. </summary>
  23911. <param name="cell">the cell to Set the alignment for</param>
  23912. <param name="workbook">The workbook that is being worked with.</param>
  23913. <param name="font">The HSSFFont that you want to Set...</param>
  23914. </member>
  23915. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.SetCellStyleProperty(NPOI.SS.UserModel.ICell,NPOI.HSSF.UserModel.HSSFWorkbook,System.String,System.Object)">
  23916. This method attempt to find an already existing HSSFCellStyle that matches
  23917. what you want the style to be. If it does not find the style, then it
  23918. Creates a new one. If it does Create a new one, then it applies the
  23919. propertyName and propertyValue to the style. This is necessary because
  23920. Excel has an upper limit on the number of Styles that it supports.
  23921. @param workbook The workbook that is being worked with.
  23922. @param propertyName The name of the property that is to be
  23923. changed.
  23924. @param propertyValue The value of the property that is to be
  23925. changed.
  23926. @param cell The cell that needs it's style changes
  23927. @exception NestableException Thrown if an error happens.
  23928. </member>
  23929. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.GetFormatProperties(NPOI.SS.UserModel.ICellStyle)">
  23930. <summary>
  23931. Returns a map containing the format properties of the given cell style.
  23932. </summary>
  23933. <param name="style">cell style</param>
  23934. <returns>map of format properties (String -&gt; Object)</returns>
  23935. </member>
  23936. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.SetFormatProperties(NPOI.SS.UserModel.ICellStyle,NPOI.HSSF.UserModel.HSSFWorkbook,System.Collections.Hashtable)">
  23937. <summary>
  23938. Sets the format properties of the given style based on the given map.
  23939. </summary>
  23940. <param name="style">The cell style</param>
  23941. <param name="workbook">The parent workbook.</param>
  23942. <param name="properties">The map of format properties (String -&gt; Object).</param>
  23943. </member>
  23944. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.GetShort(System.Collections.Hashtable,System.String)">
  23945. <summary>
  23946. Utility method that returns the named short value form the given map.
  23947. Returns zero if the property does not exist, or is not a {@link Short}.
  23948. </summary>
  23949. <param name="properties">The map of named properties (String -&gt; Object)</param>
  23950. <param name="name">The property name.</param>
  23951. <returns>property value, or zero</returns>
  23952. </member>
  23953. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.GetBoolean(System.Collections.Hashtable,System.String)">
  23954. <summary>
  23955. Utility method that returns the named boolean value form the given map.
  23956. Returns false if the property does not exist, or is not a {@link Boolean}.
  23957. </summary>
  23958. <param name="properties">map of properties (String -&gt; Object)</param>
  23959. <param name="name">The property name.</param>
  23960. <returns>property value, or false</returns>
  23961. </member>
  23962. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.PutShort(System.Collections.Hashtable,System.String,System.Int16)">
  23963. <summary>
  23964. Utility method that Puts the named short value to the given map.
  23965. </summary>
  23966. <param name="properties">The map of properties (String -&gt; Object).</param>
  23967. <param name="name">The property name.</param>
  23968. <param name="value">The property value.</param>
  23969. </member>
  23970. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.PutBoolean(System.Collections.Hashtable,System.String,System.Boolean)">
  23971. <summary>
  23972. Utility method that Puts the named boolean value to the given map.
  23973. </summary>
  23974. <param name="properties">map of properties (String -&gt; Object)</param>
  23975. <param name="name">property name</param>
  23976. <param name="value">property value</param>
  23977. </member>
  23978. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.TranslateUnicodeValues(NPOI.SS.UserModel.ICell)">
  23979. <summary>
  23980. Looks for text in the cell that should be unicode, like alpha; and provides the
  23981. unicode version of it.
  23982. </summary>
  23983. <param name="cell">The cell to check for unicode values</param>
  23984. <returns>transalted to unicode</returns>
  23985. </member>
  23986. <member name="T:NPOI.HSSF.Util.HSSFRegionUtil">
  23987. <summary>
  23988. Various utility functions that make working with a region of cells easier.
  23989. @author Eric Pugh epugh@upstate.com
  23990. </summary>
  23991. </member>
  23992. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBorderLeft(NPOI.SS.UserModel.BorderStyle,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  23993. <summary>
  23994. Sets the left border for a region of cells by manipulating the cell style
  23995. of the individual cells on the left
  23996. </summary>
  23997. <param name="border">The new border</param>
  23998. <param name="region">The region that should have the border</param>
  23999. <param name="sheet">The sheet that the region is on.</param>
  24000. <param name="workbook">The workbook that the region is on.</param>
  24001. </member>
  24002. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetLeftBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  24003. <summary>
  24004. Sets the leftBorderColor attribute of the HSSFRegionUtil object
  24005. </summary>
  24006. <param name="color">The color of the border</param>
  24007. <param name="region">The region that should have the border</param>
  24008. <param name="sheet">The sheet that the region is on.</param>
  24009. <param name="workbook">The workbook that the region is on.</param>
  24010. </member>
  24011. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBorderRight(NPOI.SS.UserModel.BorderStyle,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  24012. <summary>
  24013. Sets the borderRight attribute of the HSSFRegionUtil object
  24014. </summary>
  24015. <param name="border">The new border</param>
  24016. <param name="region">The region that should have the border</param>
  24017. <param name="sheet">The sheet that the region is on.</param>
  24018. <param name="workbook">The workbook that the region is on.</param>
  24019. </member>
  24020. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetRightBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  24021. <summary>
  24022. Sets the rightBorderColor attribute of the HSSFRegionUtil object
  24023. </summary>
  24024. <param name="color">The color of the border</param>
  24025. <param name="region">The region that should have the border</param>
  24026. <param name="sheet">The workbook that the region is on.</param>
  24027. <param name="workbook">The sheet that the region is on.</param>
  24028. </member>
  24029. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBorderBottom(NPOI.SS.UserModel.BorderStyle,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  24030. <summary>
  24031. Sets the borderBottom attribute of the HSSFRegionUtil object
  24032. </summary>
  24033. <param name="border">The new border</param>
  24034. <param name="region">The region that should have the border</param>
  24035. <param name="sheet">The sheet that the region is on.</param>
  24036. <param name="workbook">The workbook that the region is on.</param>
  24037. </member>
  24038. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBottomBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  24039. <summary>
  24040. Sets the bottomBorderColor attribute of the HSSFRegionUtil object
  24041. </summary>
  24042. <param name="color">The color of the border</param>
  24043. <param name="region">The region that should have the border</param>
  24044. <param name="sheet">The sheet that the region is on.</param>
  24045. <param name="workbook">The workbook that the region is on.</param>
  24046. </member>
  24047. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBorderTop(NPOI.SS.UserModel.BorderStyle,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  24048. <summary>
  24049. Sets the borderBottom attribute of the HSSFRegionUtil object
  24050. </summary>
  24051. <param name="border">The new border</param>
  24052. <param name="region">The region that should have the border</param>
  24053. <param name="sheet">The sheet that the region is on.</param>
  24054. <param name="workbook">The workbook that the region is on.</param>
  24055. </member>
  24056. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetTopBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  24057. <summary>
  24058. Sets the topBorderColor attribute of the HSSFRegionUtil object
  24059. </summary>
  24060. <param name="color">The color of the border</param>
  24061. <param name="region">The region that should have the border</param>
  24062. <param name="sheet">The sheet that the region is on.</param>
  24063. <param name="workbook">The workbook that the region is on.</param>
  24064. </member>
  24065. <member name="T:NPOI.HSSF.Util.HSSFRegionUtil.CellPropertySetter">
  24066. <summary>
  24067. For setting the same property on many cells to the same value
  24068. </summary>
  24069. </member>
  24070. <member name="T:NPOI.HSSF.UserModel.EscherGraphics">
  24071. Translates Graphics calls into escher calls. The translation Is lossy so
  24072. many features are not supported and some just aren't implemented yet. If
  24073. in doubt test the specific calls you wish to make. Graphics calls are
  24074. always performed into an EscherGroup so one will need to be Created.
  24075. <b>Important:</b>
  24076. <blockquote>
  24077. One important concept worth considering Is that of font size. One of the
  24078. difficulties in Converting Graphics calls into escher Drawing calls Is that
  24079. Excel does not have the concept of absolute pixel positions. It measures
  24080. it's cell widths in 'Chars' and the cell heights in points.
  24081. Unfortunately it's not defined exactly what a type of Char it's
  24082. measuring. Presumably this Is due to the fact that the Excel will be
  24083. using different fonts on different platforms or even within the same
  24084. platform.
  24085. Because of this constraint we've had to calculate the
  24086. verticalPointsPerPixel. This the amount the font should be scaled by when
  24087. you Issue commands such as DrawString(). A good way to calculate this
  24088. Is to use the follow formula:
  24089. <pre>
  24090. multipler = GroupHeightInPoints / heightOfGroup
  24091. </pre>
  24092. The height of the Group Is calculated fairly simply by calculating the
  24093. difference between the y coordinates of the bounding box of the shape. The
  24094. height of the Group can be calculated by using a convenience called
  24095. <c>HSSFClientAnchor.GetAnchorHeightInPoints()</c>.
  24096. </blockquote>
  24097. @author Glen Stampoultzis (glens at apache.org)
  24098. </member>
  24099. <member name="M:NPOI.HSSF.UserModel.EscherGraphics.#ctor(NPOI.HSSF.UserModel.HSSFShapeGroup,NPOI.HSSF.UserModel.HSSFWorkbook,System.Drawing.Color,System.Single)">
  24100. Construct an escher graphics object.
  24101. @param escherGroup The escher Group to Write the graphics calls into.
  24102. @param workbook The workbook we are using.
  24103. @param forecolor The foreground color to use as default.
  24104. @param verticalPointsPerPixel The font multiplier. (See class description for information on how this works.).
  24105. </member>
  24106. <member name="M:NPOI.HSSF.UserModel.EscherGraphics.#ctor(NPOI.HSSF.UserModel.HSSFShapeGroup,NPOI.HSSF.UserModel.HSSFWorkbook,System.Drawing.Color,System.Drawing.Font,System.Single)">
  24107. Constructs an escher graphics object.
  24108. @param escherGroup The escher Group to Write the graphics calls into.
  24109. @param workbook The workbook we are using.
  24110. @param foreground The foreground color to use as default.
  24111. @param verticalPointsPerPixel The font multiplier. (See class description for information on how this works.).
  24112. @param font The font to use.
  24113. </member>
  24114. <member name="M:NPOI.HSSF.UserModel.EscherGraphics.FillPolygon(System.Int32[],System.Int32[],System.Int32)">
  24115. Fills a (closed) polygon, as defined by a pair of arrays, which
  24116. hold the <i>x</i> and <i>y</i> coordinates.
  24117. This Draws the polygon, with <c>nPoint</c> line segments.
  24118. The first <c>nPoint - 1</c> line segments are
  24119. Drawn between sequential points
  24120. (<c>xPoints[i],yPoints[i],xPoints[i+1],yPoints[i+1]</c>).
  24121. The line segment Is a closing one, from the last point to
  24122. the first (assuming they are different).
  24123. The area inside of the polygon Is defined by using an
  24124. even-odd Fill rule (also known as the alternating rule), and
  24125. the area inside of it Is Filled.
  24126. @param xPoints array of the <c>x</c> coordinates.
  24127. @param yPoints array of the <c>y</c> coordinates.
  24128. @param nPoints the total number of points in the polygon.
  24129. @see java.awt.Graphics#DrawPolygon(int[], int[], int)
  24130. </member>
  24131. <member name="T:NPOI.HSSF.UserModel.EvaluationCycleDetector">
  24132. Instances of this class keep track of multiple dependent cell evaluations due
  24133. to recursive calls to <c>HSSFFormulaEvaluator.internalEvaluate()</c>.
  24134. The main purpose of this class Is to detect an attempt to evaluate a cell
  24135. that Is alReady being evaluated. In other words, it detects circular
  24136. references in spReadsheet formulas.
  24137. @author Josh Micich
  24138. </member>
  24139. <member name="M:NPOI.HSSF.UserModel.EvaluationCycleDetector.StartEvaluate(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32,System.Int32)">
  24140. Notifies this evaluation tracker that evaluation of the specified cell Is
  24141. about to start.<br/>
  24142. In the case of a <c>true</c> return code, the caller should
  24143. continue evaluation of the specified cell, and also be sure to call
  24144. <c>endEvaluate()</c> when complete.<br/>
  24145. In the case of a <c>false</c> return code, the caller should
  24146. return an evaluation result of
  24147. <c>ErrorEval.CIRCULAR_REF_ERROR</c>, and not call <c>endEvaluate()</c>.
  24148. <br/>
  24149. @return <c>true</c> if the specified cell has not been visited yet in the current
  24150. evaluation. <c>false</c> if the specified cell Is alReady being evaluated.
  24151. </member>
  24152. <member name="M:NPOI.HSSF.UserModel.EvaluationCycleDetector.EndEvaluate(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32,System.Int32)">
  24153. Notifies this evaluation tracker that the evaluation of the specified
  24154. cell Is complete. <p/>
  24155. Every successful call to <c>startEvaluate</c> must be followed by a
  24156. call to <c>endEvaluate</c> (recommended in a finally block) to enable
  24157. proper tracking of which cells are being evaluated at any point in time.<p/>
  24158. Assuming a well behaved client, parameters to this method would not be
  24159. required. However, they have been included to assert correct behaviour,
  24160. and form more meaningful error messages.
  24161. </member>
  24162. <member name="T:NPOI.HSSF.UserModel.EvaluationCycleDetector.CellEvaluationFrame">
  24163. Stores the parameters that identify the evaluation of one cell.<br/>
  24164. </member>
  24165. <member name="M:NPOI.HSSF.UserModel.EvaluationCycleDetector.CellEvaluationFrame.FormatAsString">
  24166. @return human Readable string for debug purposes
  24167. </member>
  24168. <member name="T:NPOI.HSSF.UserModel.EvaluationCycleDetectorManager">
  24169. This class makes an <c>EvaluationCycleDetector</c> instance available to
  24170. each thRead via a <c>ThReadLocal</c> in order to avoid Adding a parameter
  24171. to a few protected methods within <c>HSSFFormulaEvaluator</c>.
  24172. @author Josh Micich
  24173. </member>
  24174. <member name="M:NPOI.HSSF.UserModel.EvaluationCycleDetectorManager.GetTracker">
  24175. @return
  24176. </member>
  24177. <member name="T:NPOI.HSSF.UserModel.FontDetails">
  24178. <summary>
  24179. Stores width and height details about a font.
  24180. @author Glen Stampoultzis (glens at apache.org)
  24181. </summary>
  24182. </member>
  24183. <member name="M:NPOI.HSSF.UserModel.FontDetails.#ctor(System.String,System.Int32)">
  24184. <summary>
  24185. Construct the font details with the given name and height.
  24186. </summary>
  24187. <param name="fontName">The font name.</param>
  24188. <param name="height">The height of the font.</param>
  24189. </member>
  24190. <member name="M:NPOI.HSSF.UserModel.FontDetails.GetFontName">
  24191. <summary>
  24192. Gets the name of the font.
  24193. </summary>
  24194. <returns></returns>
  24195. </member>
  24196. <member name="M:NPOI.HSSF.UserModel.FontDetails.GetHeight">
  24197. <summary>
  24198. Gets the height.
  24199. </summary>
  24200. <returns></returns>
  24201. </member>
  24202. <member name="M:NPOI.HSSF.UserModel.FontDetails.AddChar(System.Char,System.Int32)">
  24203. <summary>
  24204. Adds the char.
  24205. </summary>
  24206. <param name="c">The c.</param>
  24207. <param name="width">The width.</param>
  24208. </member>
  24209. <member name="M:NPOI.HSSF.UserModel.FontDetails.GetCharWidth(System.Char)">
  24210. <summary>
  24211. Retrieves the width of the specified Char. If the metrics for
  24212. a particular Char are not available it defaults to returning the
  24213. width for the 'W' Char.
  24214. </summary>
  24215. <param name="c">The character.</param>
  24216. <returns></returns>
  24217. </member>
  24218. <member name="M:NPOI.HSSF.UserModel.FontDetails.AddChars(System.Char[],System.Int32[])">
  24219. <summary>
  24220. Adds the chars.
  24221. </summary>
  24222. <param name="Chars">The chars.</param>
  24223. <param name="widths">The widths.</param>
  24224. </member>
  24225. <member name="M:NPOI.HSSF.UserModel.FontDetails.BuildFontHeightProperty(System.String)">
  24226. <summary>
  24227. Builds the font height property.
  24228. </summary>
  24229. <param name="fontName">Name of the font.</param>
  24230. <returns></returns>
  24231. </member>
  24232. <member name="M:NPOI.HSSF.UserModel.FontDetails.BuildFontWidthsProperty(System.String)">
  24233. <summary>
  24234. Builds the font widths property.
  24235. </summary>
  24236. <param name="fontName">Name of the font.</param>
  24237. <returns></returns>
  24238. </member>
  24239. <member name="M:NPOI.HSSF.UserModel.FontDetails.BuildFontCharsProperty(System.String)">
  24240. <summary>
  24241. Builds the font chars property.
  24242. </summary>
  24243. <param name="fontName">Name of the font.</param>
  24244. <returns></returns>
  24245. </member>
  24246. <member name="M:NPOI.HSSF.UserModel.FontDetails.Create(System.String,NPOI.Util.Collections.Properties)">
  24247. <summary>
  24248. Create an instance of
  24249. <c>FontDetails</c>
  24250. by loading them from the
  24251. provided property object.
  24252. </summary>
  24253. <param name="fontName">the font name.</param>
  24254. <param name="fontMetricsProps">the property object holding the details of this
  24255. particular font.</param>
  24256. <returns>a new FontDetails instance.</returns>
  24257. </member>
  24258. <member name="M:NPOI.HSSF.UserModel.FontDetails.GetStringWidth(System.String)">
  24259. <summary>
  24260. Gets the width of all Chars in a string.
  24261. </summary>
  24262. <param name="str">The string to measure.</param>
  24263. <returns>The width of the string for a 10 point font.</returns>
  24264. </member>
  24265. <member name="M:NPOI.HSSF.UserModel.FontDetails.Split(System.String,System.String,System.Int32)">
  24266. <summary>
  24267. Split the given string into an array of strings using the given
  24268. delimiter.
  24269. </summary>
  24270. <param name="text">The text.</param>
  24271. <param name="separator">The separator.</param>
  24272. <param name="max">The max.</param>
  24273. <returns></returns>
  24274. </member>
  24275. <member name="T:NPOI.HSSF.UserModel.HeaderFooter">
  24276. <summary>
  24277. Common class for HSSFHeader and HSSFFooter
  24278. </summary>
  24279. </member>
  24280. <member name="T:NPOI.SS.UserModel.IHeaderFooter">
  24281. <summary>
  24282. Common interface for NPOI.SS.UserModel.Header and NPOI.SS.UserModel.Footer
  24283. </summary>
  24284. </member>
  24285. <member name="P:NPOI.SS.UserModel.IHeaderFooter.Left">
  24286. <summary>
  24287. Gets or sets the left side of the header or footer.
  24288. </summary>
  24289. <value>The string representing the left side.</value>
  24290. </member>
  24291. <member name="P:NPOI.SS.UserModel.IHeaderFooter.Center">
  24292. <summary>
  24293. Gets or sets the center of the header or footer.
  24294. </summary>
  24295. <value>The string representing the center.</value>
  24296. </member>
  24297. <member name="P:NPOI.SS.UserModel.IHeaderFooter.Right">
  24298. <summary>
  24299. Gets or sets the right side of the header or footer.
  24300. </summary>
  24301. <value>The string representing the right side.</value>
  24302. </member>
  24303. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.UpdateHeaderFooterText(System.String[])">
  24304. <summary>
  24305. Creates the complete footer string based on the left, center, and middle
  24306. strings.
  24307. </summary>
  24308. <param name="parts">The parts.</param>
  24309. </member>
  24310. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.SetHeaderFooterText(System.String)">
  24311. <summary>
  24312. Sets the header footer text.
  24313. </summary>
  24314. <param name="text">the new header footer text (contains mark-up tags). Possibly
  24315. empty string never </param>
  24316. </member>
  24317. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.FontSize(System.Int16)">
  24318. <summary>
  24319. Returns the string that represents the change in font size.
  24320. </summary>
  24321. <param name="size">the new font size.</param>
  24322. <returns>The special string to represent a new font size</returns>
  24323. </member>
  24324. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.Font(System.String,System.String)">
  24325. <summary>
  24326. Returns the string that represents the change in font.
  24327. </summary>
  24328. <param name="font">the new font.</param>
  24329. <param name="style">the fonts style, one of regular, italic, bold, italic bold or bold italic.</param>
  24330. <returns>The special string to represent a new font size</returns>
  24331. </member>
  24332. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.StripFields(System.String)">
  24333. <summary>
  24334. Removes any fields (eg macros, page markers etc)
  24335. from the string.
  24336. Normally used to make some text suitable for showing
  24337. to humans, and the resultant text should not normally
  24338. be saved back into the document!
  24339. </summary>
  24340. <param name="text">The text.</param>
  24341. <returns></returns>
  24342. </member>
  24343. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.RawText">
  24344. @return the internal text representation (combining center, left and right parts).
  24345. Possibly empty string if no header or footer is set. Never <c>null</c>.
  24346. </member>
  24347. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Left">
  24348. <summary>
  24349. Get the left side of the header or footer.
  24350. </summary>
  24351. <value>The string representing the left side.</value>
  24352. </member>
  24353. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Center">
  24354. <summary>
  24355. Get the center of the header or footer.
  24356. </summary>
  24357. <value>The string representing the center.</value>
  24358. </member>
  24359. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Right">
  24360. <summary>
  24361. Get the right side of the header or footer.
  24362. </summary>
  24363. <value>The string representing the right side..</value>
  24364. </member>
  24365. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Page">
  24366. <summary>
  24367. Returns the string representing the current page number
  24368. </summary>
  24369. <value>The special string for page number.</value>
  24370. </member>
  24371. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.NumPages">
  24372. <summary>
  24373. Returns the string representing the number of pages.
  24374. </summary>
  24375. <value>The special string for the number of pages.</value>
  24376. </member>
  24377. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Date">
  24378. <summary>
  24379. Returns the string representing the current date
  24380. </summary>
  24381. <value>The special string for the date</value>
  24382. </member>
  24383. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Time">
  24384. <summary>
  24385. Gets the time.
  24386. </summary>
  24387. <value>The time.</value>
  24388. Returns the string representing the current time
  24389. @return The special string for the time
  24390. </member>
  24391. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.File">
  24392. <summary>
  24393. Returns the string representing the current file name
  24394. </summary>
  24395. <value>The special string for the file name.</value>
  24396. </member>
  24397. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Tab">
  24398. <summary>
  24399. Returns the string representing the current tab (sheet) name
  24400. </summary>
  24401. <value>The special string for tab name.</value>
  24402. </member>
  24403. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.StartBold">
  24404. <summary>
  24405. Returns the string representing the start bold
  24406. </summary>
  24407. <returns>The special string for start bold</returns>
  24408. </member>
  24409. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.EndBold">
  24410. <summary>
  24411. Returns the string representing the end bold
  24412. </summary>
  24413. <value>The special string for end bold.</value>
  24414. </member>
  24415. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.StartUnderline">
  24416. <summary>
  24417. Returns the string representing the start underline
  24418. </summary>
  24419. <value>The special string for start underline.</value>
  24420. </member>
  24421. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.EndUnderline">
  24422. <summary>
  24423. Returns the string representing the end underline
  24424. </summary>
  24425. <value>The special string for end underline.</value>
  24426. </member>
  24427. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.StartDoubleUnderline">
  24428. <summary>
  24429. Returns the string representing the start double underline
  24430. </summary>
  24431. <value>The special string for start double underline.</value>
  24432. </member>
  24433. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.EndDoubleUnderline">
  24434. <summary>
  24435. Returns the string representing the end double underline
  24436. </summary>
  24437. <value>The special string for end double underline.</value>
  24438. </member>
  24439. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.AreFieldsStripped">
  24440. <summary>
  24441. Are fields currently being Stripped from
  24442. the text that this {@link HeaderStories} returns?
  24443. Default is false, but can be changed
  24444. </summary>
  24445. <value><c>true</c> if [are fields stripped]; otherwise, <c>false</c>.</value>
  24446. </member>
  24447. <member name="T:NPOI.HSSF.UserModel.HeaderFooter.Field">
  24448. <summary>
  24449. Represents a special field in a header or footer,
  24450. eg the page number
  24451. </summary>
  24452. </member>
  24453. <member name="F:NPOI.HSSF.UserModel.HeaderFooter.Field.sequence">
  24454. The character sequence that marks this field
  24455. </member>
  24456. <member name="T:NPOI.HSSF.UserModel.HeaderFooter.PairField">
  24457. <summary>
  24458. A special field that normally comes in a pair, eg
  24459. turn on underline / turn off underline
  24460. </summary>
  24461. </member>
  24462. <member name="F:NPOI.HSSF.UserModel.HeaderFooter.Fields.instance">
  24463. <summary>
  24464. Instance to this class.
  24465. </summary>
  24466. </member>
  24467. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.Fields.#cctor">
  24468. <summary>
  24469. Explicit static constructor to tell C# compiler not to mark type as beforefieldinit.
  24470. </summary>
  24471. </member>
  24472. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.Fields.#ctor">
  24473. <summary>
  24474. Initialize AllFields.
  24475. </summary>
  24476. </member>
  24477. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Fields.Instance">
  24478. <summary>
  24479. Accessing the initialized instance.
  24480. </summary>
  24481. </member>
  24482. <member name="T:NPOI.HSSF.UserModel.HSSFAnchor">
  24483. <summary>
  24484. An anchor Is what specifics the position of a shape within a client object
  24485. or within another containing shape.
  24486. @author Glen Stampoultzis (glens at apache.org)
  24487. </summary>
  24488. </member>
  24489. <member name="M:NPOI.HSSF.UserModel.HSSFAnchor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  24490. <summary>
  24491. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFAnchor"/> class.
  24492. </summary>
  24493. <param name="dx1">The DX1.</param>
  24494. <param name="dy1">The dy1.</param>
  24495. <param name="dx2">The DX2.</param>
  24496. <param name="dy2">The dy2.</param>
  24497. </member>
  24498. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.Dx1">
  24499. <summary>
  24500. Gets or sets the DX1.
  24501. </summary>
  24502. <value>The DX1.</value>
  24503. </member>
  24504. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.Dy1">
  24505. <summary>
  24506. Gets or sets the dy1.
  24507. </summary>
  24508. <value>The dy1.</value>
  24509. </member>
  24510. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.Dy2">
  24511. <summary>
  24512. Gets or sets the dy2.
  24513. </summary>
  24514. <value>The dy2.</value>
  24515. </member>
  24516. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.Dx2">
  24517. <summary>
  24518. Gets or sets the DX2.
  24519. </summary>
  24520. <value>The DX2.</value>
  24521. </member>
  24522. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.IsHorizontallyFlipped">
  24523. <summary>
  24524. Gets a value indicating whether this instance is horizontally flipped.
  24525. </summary>
  24526. <value>
  24527. <c>true</c> if this instance is horizontally flipped; otherwise, <c>false</c>.
  24528. </value>
  24529. </member>
  24530. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.IsVerticallyFlipped">
  24531. <summary>
  24532. Gets a value indicating whether this instance is vertically flipped.
  24533. </summary>
  24534. <value>
  24535. <c>true</c> if this instance is vertically flipped; otherwise, <c>false</c>.
  24536. </value>
  24537. </member>
  24538. <member name="T:NPOI.SS.UserModel.IAutoFilter">
  24539. Represents autofiltering for the specified worksheet.
  24540. <p>
  24541. Filtering data is a quick and easy way to find and work with a subset of data in a range of cells or table.
  24542. For example, you can filter to see only the values that you specify, filter to see the top or bottom values,
  24543. or filter to quickly see duplicate values.
  24544. </p>
  24545. TODO YK: For now (Aug 2010) POI only supports Setting a basic autofilter on a range of cells.
  24546. In future, when we support more auto-filter functions like custom criteria, sort, etc. we will add
  24547. corresponding methods to this interface.
  24548. </member>
  24549. <member name="T:NPOI.HSSF.UserModel.HSSFBorderFormatting">
  24550. High level representation for Border Formatting component
  24551. of Conditional Formatting Settings
  24552. @author Dmitriy Kumshayev
  24553. </member>
  24554. <member name="T:NPOI.SS.UserModel.IBorderFormatting">
  24555. @author Dmitriy Kumshayev
  24556. @author Yegor Kozlov
  24557. </member>
  24558. <member name="T:NPOI.HSSF.UserModel.HSSFCell">
  24559. <summary>
  24560. High level representation of a cell in a row of a spReadsheet.
  24561. Cells can be numeric, formula-based or string-based (text). The cell type
  24562. specifies this. String cells cannot conatin numbers and numeric cells cannot
  24563. contain strings (at least according to our model). Client apps should do the
  24564. conversions themselves. Formula cells have the formula string, as well as
  24565. the formula result, which can be numeric or string.
  24566. Cells should have their number (0 based) before being Added to a row. Only
  24567. cells that have values should be Added.
  24568. </summary>
  24569. <remarks>
  24570. @author Andrew C. Oliver (acoliver at apache dot org)
  24571. @author Dan Sherman (dsherman at Isisph.com)
  24572. @author Brian Sanders (kestrel at burdell dot org) Active Cell support
  24573. @author Yegor Kozlov cell comments support
  24574. </remarks>
  24575. </member>
  24576. <member name="T:NPOI.SS.UserModel.ICell">
  24577. High level representation of a cell in a row of a spreadsheet.
  24578. <p>
  24579. Cells can be numeric, formula-based or string-based (text). The cell type
  24580. specifies this. String cells cannot conatin numbers and numeric cells cannot
  24581. contain strings (at least according to our model). Client apps should do the
  24582. conversions themselves. Formula cells have the formula string, as well as
  24583. the formula result, which can be numeric or string.
  24584. </p>
  24585. <p>
  24586. Cells should have their number (0 based) before being Added to a row.
  24587. </p>
  24588. </member>
  24589. <member name="M:NPOI.SS.UserModel.ICell.SetCellType(NPOI.SS.UserModel.CellType)">
  24590. <summary>
  24591. Set the cells type (numeric, formula or string)
  24592. </summary>
  24593. <param name="cellType"></param>
  24594. </member>
  24595. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(System.Double)">
  24596. <summary>
  24597. Set a numeric value for the cell
  24598. </summary>
  24599. <param name="value">the numeric value to set this cell to. For formulas we'll set the
  24600. precalculated value, for numerics we'll set its value. For other types we will change
  24601. the cell to a numeric cell and set its value.
  24602. </param>
  24603. </member>
  24604. <member name="M:NPOI.SS.UserModel.ICell.SetCellErrorValue(System.Byte)">
  24605. <summary>
  24606. Set a error value for the cell
  24607. </summary>
  24608. <param name="value">the error value to set this cell to. For formulas we'll set the
  24609. precalculated value , for errors we'll set its value. For other types we will change
  24610. the cell to an error cell and set its value.
  24611. </param>
  24612. </member>
  24613. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(System.DateTime)">
  24614. <summary>
  24615. Converts the supplied date to its equivalent Excel numeric value and Sets that into the cell.
  24616. </summary>
  24617. <param name="value">the numeric value to set this cell to. For formulas we'll set the
  24618. precalculated value, for numerics we'll set its value. For other types we will change
  24619. the cell to a numerics cell and set its value.
  24620. </param>
  24621. </member>
  24622. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(NPOI.SS.UserModel.IRichTextString)">
  24623. <summary>
  24624. Set a rich string value for the cell.
  24625. </summary>
  24626. <param name="value">value to set the cell to. For formulas we'll set the formula
  24627. string, for String cells we'll set its value. For other types we will
  24628. change the cell to a string cell and set its value.
  24629. If value is null then we will change the cell to a Blank cell.
  24630. </param>
  24631. </member>
  24632. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(System.String)">
  24633. <summary>
  24634. Set a string value for the cell.
  24635. </summary>
  24636. <param name="value">value to set the cell to. For formulas we'll set the formula
  24637. string, for String cells we'll set its value. For other types we will
  24638. change the cell to a string cell and set its value.
  24639. If value is null then we will change the cell to a blank cell.
  24640. </param>
  24641. </member>
  24642. <member name="M:NPOI.SS.UserModel.ICell.CopyCellTo(System.Int32)">
  24643. <summary>
  24644. Copy the cell to the target index. If the target cell exists, a new cell will be inserted before the existing cell.
  24645. </summary>
  24646. <param name="targetIndex">target index</param>
  24647. <returns>the new copied cell object</returns>
  24648. </member>
  24649. <member name="M:NPOI.SS.UserModel.ICell.SetCellFormula(System.String)">
  24650. <summary>
  24651. Sets formula for this cell.
  24652. </summary>
  24653. <param name="formula">the formula to Set, e.g. <code>"SUM(C4:E4)"</code>.</param>
  24654. </member>
  24655. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(System.Boolean)">
  24656. <summary>
  24657. Set a bool value for the cell
  24658. </summary>
  24659. <param name="value"></param>
  24660. </member>
  24661. <member name="M:NPOI.SS.UserModel.ICell.SetAsActiveCell">
  24662. <summary>
  24663. Sets this cell as the active cell for the worksheet
  24664. </summary>
  24665. </member>
  24666. <member name="M:NPOI.SS.UserModel.ICell.RemoveCellComment">
  24667. <summary>
  24668. Removes the comment for this cell, if there is one.
  24669. </summary>
  24670. </member>
  24671. <member name="M:NPOI.SS.UserModel.ICell.RemoveHyperlink">
  24672. <summary>
  24673. Removes the hyperlink for this cell, if there is one.
  24674. </summary>
  24675. </member>
  24676. <member name="P:NPOI.SS.UserModel.ICell.ColumnIndex">
  24677. <summary>
  24678. zero-based column index of a column in a sheet.
  24679. </summary>
  24680. </member>
  24681. <member name="P:NPOI.SS.UserModel.ICell.RowIndex">
  24682. <summary>
  24683. zero-based row index of a row in the sheet that contains this cell
  24684. </summary>
  24685. </member>
  24686. <member name="P:NPOI.SS.UserModel.ICell.Sheet">
  24687. <summary>
  24688. the sheet this cell belongs to
  24689. </summary>
  24690. </member>
  24691. <member name="P:NPOI.SS.UserModel.ICell.Row">
  24692. <summary>
  24693. the row this cell belongs to
  24694. </summary>
  24695. </member>
  24696. <member name="P:NPOI.SS.UserModel.ICell.CellType">
  24697. <summary>
  24698. Set the cells type (numeric, formula or string)
  24699. </summary>
  24700. <p>If the cell currently contains a value, the value will
  24701. be converted to match the new type, if possible. Formatting
  24702. is generally lost in the process however.</p>
  24703. <p>If what you want to do is get a String value for your
  24704. numeric cell, <i>stop!</i>. This is not the way to do it.
  24705. Instead, for fetching the string value of a numeric or boolean
  24706. or date cell, use {@link DataFormatter} instead.</p>
  24707. </member>
  24708. <member name="P:NPOI.SS.UserModel.ICell.CachedFormulaResultType">
  24709. <summary>
  24710. Only valid for formula cells
  24711. </summary>
  24712. </member>
  24713. <member name="P:NPOI.SS.UserModel.ICell.CellFormula">
  24714. <summary>
  24715. Return a formula for the cell
  24716. </summary>
  24717. <exception cref="T:System.InvalidOperationException">if the cell type returned by GetCellType() is not CELL_TYPE_FORMULA </exception>
  24718. </member>
  24719. <member name="P:NPOI.SS.UserModel.ICell.NumericCellValue">
  24720. <summary>
  24721. Get the value of the cell as a number.
  24722. </summary>
  24723. <exception cref="T:System.InvalidOperationException">if the cell type returned by GetCellType() is CELL_TYPE_STRING</exception>
  24724. <exception cref="T:System.FormatException">if the cell value isn't a parsable double</exception>
  24725. </member>
  24726. <member name="P:NPOI.SS.UserModel.ICell.DateCellValue">
  24727. <summary>
  24728. Get the value of the cell as a date.
  24729. </summary>
  24730. <exception cref="T:System.InvalidOperationException">if the cell type returned by GetCellType() is CELL_TYPE_STRING</exception>
  24731. <exception cref="T:System.FormatException">if the cell value isn't a parsable double</exception>
  24732. </member>
  24733. <member name="P:NPOI.SS.UserModel.ICell.RichStringCellValue">
  24734. <summary>
  24735. Get the value of the cell RichTextString
  24736. </summary>
  24737. </member>
  24738. <member name="P:NPOI.SS.UserModel.ICell.ErrorCellValue">
  24739. <summary>
  24740. Get the value of the cell as an error code.
  24741. </summary>
  24742. </member>
  24743. <member name="P:NPOI.SS.UserModel.ICell.StringCellValue">
  24744. <summary>
  24745. Get the value of the cell as a string
  24746. </summary>
  24747. </member>
  24748. <member name="P:NPOI.SS.UserModel.ICell.BooleanCellValue">
  24749. <summary>
  24750. Get the value of the cell as a bool.
  24751. </summary>
  24752. </member>
  24753. <member name="P:NPOI.SS.UserModel.ICell.CellStyle">
  24754. <summary>
  24755. Return the cell's style.
  24756. </summary>
  24757. </member>
  24758. <member name="P:NPOI.SS.UserModel.ICell.CellComment">
  24759. <summary>
  24760. comment associated with this cell
  24761. </summary>
  24762. </member>
  24763. <member name="P:NPOI.SS.UserModel.ICell.Hyperlink">
  24764. <summary>
  24765. hyperlink associated with this cell
  24766. </summary>
  24767. </member>
  24768. <member name="P:NPOI.SS.UserModel.ICell.ArrayFormulaRange">
  24769. <summary>
  24770. Only valid for array formula cells
  24771. </summary>
  24772. <returns>range of the array formula group that the cell belongs to.</returns>
  24773. </member>
  24774. <member name="P:NPOI.SS.UserModel.ICell.IsPartOfArrayFormulaGroup">
  24775. <summary>
  24776. if this cell is part of group of cells having a common array formula.
  24777. </summary>
  24778. </member>
  24779. <member name="M:NPOI.HSSF.UserModel.HSSFCell.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32,System.Int16)">
  24780. <summary>
  24781. Creates new Cell - Should only be called by HSSFRow. This Creates a cell
  24782. from scratch.
  24783. When the cell is initially Created it is Set to CellType.Blank. Cell types
  24784. can be Changed/overwritten by calling SetCellValue with the appropriate
  24785. type as a parameter although conversions from one type to another may be
  24786. prohibited.
  24787. </summary>
  24788. <param name="book">Workbook record of the workbook containing this cell</param>
  24789. <param name="sheet">Sheet record of the sheet containing this cell</param>
  24790. <param name="row">the row of this cell</param>
  24791. <param name="col">the column for this cell</param>
  24792. </member>
  24793. <member name="M:NPOI.HSSF.UserModel.HSSFCell.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32,System.Int16,NPOI.SS.UserModel.CellType)">
  24794. <summary>
  24795. Creates new Cell - Should only be called by HSSFRow. This Creates a cell
  24796. from scratch.
  24797. </summary>
  24798. <param name="book">Workbook record of the workbook containing this cell</param>
  24799. <param name="sheet">Sheet record of the sheet containing this cell</param>
  24800. <param name="row">the row of this cell</param>
  24801. <param name="col">the column for this cell</param>
  24802. <param name="type">CellType.Numeric, CellType.String, CellType.Formula, CellType.Blank,
  24803. CellType.Boolean, CellType.Error</param>
  24804. </member>
  24805. <member name="M:NPOI.HSSF.UserModel.HSSFCell.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.Record.CellValueRecordInterface)">
  24806. <summary>
  24807. Creates an Cell from a CellValueRecordInterface. HSSFSheet uses this when
  24808. reading in cells from an existing sheet.
  24809. </summary>
  24810. <param name="book">Workbook record of the workbook containing this cell</param>
  24811. <param name="sheet">Sheet record of the sheet containing this cell</param>
  24812. <param name="cval">the Cell Value Record we wish to represent</param>
  24813. </member>
  24814. <member name="M:NPOI.HSSF.UserModel.HSSFCell.#ctor">
  24815. private constructor to prevent blank construction
  24816. </member>
  24817. <member name="M:NPOI.HSSF.UserModel.HSSFCell.DetermineType(NPOI.HSSF.Record.CellValueRecordInterface)">
  24818. used internally -- given a cell value record, figure out its type
  24819. </member>
  24820. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellType(NPOI.SS.UserModel.CellType)">
  24821. <summary>
  24822. Set the cells type (numeric, formula or string)
  24823. </summary>
  24824. <param name="cellType">Type of the cell.</param>
  24825. </member>
  24826. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellType(NPOI.SS.UserModel.CellType,System.Boolean,System.Int32,System.Int32,System.Int16)">
  24827. <summary>
  24828. Sets the cell type. The SetValue flag indicates whether to bother about
  24829. trying to preserve the current value in the new record if one is Created.
  24830. The SetCellValue method will call this method with false in SetValue
  24831. since it will overWrite the cell value later
  24832. </summary>
  24833. <param name="cellType">Type of the cell.</param>
  24834. <param name="setValue">if set to <c>true</c> [set value].</param>
  24835. <param name="row">The row.</param>
  24836. <param name="col">The col.</param>
  24837. <param name="styleIndex">Index of the style.</param>
  24838. </member>
  24839. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(System.Double)">
  24840. <summary>
  24841. Set a numeric value for the cell
  24842. </summary>
  24843. <param name="value">the numeric value to Set this cell to. For formulas we'll Set the
  24844. precalculated value, for numerics we'll Set its value. For other types we
  24845. will Change the cell to a numeric cell and Set its value.</param>
  24846. </member>
  24847. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(System.DateTime)">
  24848. <summary>
  24849. Set a date value for the cell. Excel treats dates as numeric so you will need to format the cell as
  24850. a date.
  24851. </summary>
  24852. <param name="value">the date value to Set this cell to. For formulas we'll Set the
  24853. precalculated value, for numerics we'll Set its value. For other types we
  24854. will Change the cell to a numeric cell and Set its value.</param>
  24855. </member>
  24856. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(System.String)">
  24857. <summary>
  24858. Set a string value for the cell. Please note that if you are using
  24859. full 16 bit Unicode you should call SetEncoding() first.
  24860. </summary>
  24861. <param name="value">value to Set the cell to. For formulas we'll Set the formula
  24862. string, for String cells we'll Set its value. For other types we will
  24863. Change the cell to a string cell and Set its value.
  24864. If value is null then we will Change the cell to a Blank cell.</param>
  24865. </member>
  24866. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellErrorValue(System.Byte)">
  24867. set a error value for the cell
  24868. @param errorCode the error value to set this cell to. For formulas we'll set the
  24869. precalculated value , for errors we'll set
  24870. its value. For other types we will change the cell to an error
  24871. cell and set its value.
  24872. </member>
  24873. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(NPOI.SS.UserModel.IRichTextString)">
  24874. <summary>
  24875. Set a string value for the cell. Please note that if you are using
  24876. full 16 bit Unicode you should call SetEncoding() first.
  24877. </summary>
  24878. <param name="value">value to Set the cell to. For formulas we'll Set the formula
  24879. string, for String cells we'll Set its value. For other types we will
  24880. Change the cell to a string cell and Set its value.
  24881. If value is null then we will Change the cell to a Blank cell.</param>
  24882. </member>
  24883. <member name="M:NPOI.HSSF.UserModel.HSSFCell.NotifyFormulaChanging">
  24884. Should be called any time that a formula could potentially be deleted.
  24885. Does nothing if this cell currently does not hold a formula
  24886. </member>
  24887. <member name="M:NPOI.HSSF.UserModel.HSSFCell.GetCellTypeName(NPOI.SS.UserModel.CellType)">
  24888. <summary>
  24889. Used to help format error messages
  24890. </summary>
  24891. <param name="cellTypeCode">The cell type code.</param>
  24892. <returns></returns>
  24893. </member>
  24894. <member name="M:NPOI.HSSF.UserModel.HSSFCell.TypeMismatch(NPOI.SS.UserModel.CellType,NPOI.SS.UserModel.CellType,System.Boolean)">
  24895. <summary>
  24896. Types the mismatch.
  24897. </summary>
  24898. <param name="expectedTypeCode">The expected type code.</param>
  24899. <param name="actualTypeCode">The actual type code.</param>
  24900. <param name="isFormulaCell">if set to <c>true</c> [is formula cell].</param>
  24901. <returns></returns>
  24902. </member>
  24903. <member name="M:NPOI.HSSF.UserModel.HSSFCell.CheckFormulaCachedValueType(NPOI.SS.UserModel.CellType,NPOI.HSSF.Record.FormulaRecord)">
  24904. <summary>
  24905. Checks the type of the formula cached value.
  24906. </summary>
  24907. <param name="expectedTypeCode">The expected type code.</param>
  24908. <param name="fr">The fr.</param>
  24909. </member>
  24910. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(System.Boolean)">
  24911. <summary>
  24912. Set a bool value for the cell
  24913. </summary>
  24914. <param name="value">the bool value to Set this cell to. For formulas we'll Set the
  24915. precalculated value, for bools we'll Set its value. For other types we
  24916. will Change the cell to a bool cell and Set its value.</param>
  24917. </member>
  24918. <member name="M:NPOI.HSSF.UserModel.HSSFCell.ConvertCellValueToBoolean">
  24919. <summary>
  24920. Chooses a new bool value for the cell when its type is changing.
  24921. Usually the caller is calling SetCellType() with the intention of calling
  24922. SetCellValue(bool) straight afterwards. This method only exists to give
  24923. the cell a somewhat reasonable value until the SetCellValue() call (if at all).
  24924. TODO - perhaps a method like SetCellTypeAndValue(int, Object) should be introduced to avoid this
  24925. </summary>
  24926. <returns></returns>
  24927. </member>
  24928. <member name="M:NPOI.HSSF.UserModel.HSSFCell.ApplyUserCellStyle(NPOI.HSSF.UserModel.HSSFCellStyle)">
  24929. Applying a user-defined style (UDS) is special. Excel does not directly reference user-defined styles, but
  24930. instead create a 'proxy' ExtendedFormatRecord referencing the UDS as parent.
  24931. The proceudre to apply a UDS is as follows:
  24932. 1. search for a ExtendedFormatRecord with parentIndex == style.getIndex()
  24933. and xfType == ExtendedFormatRecord.XF_CELL.
  24934. 2. if not found then create a new ExtendedFormatRecord and copy all attributes from the user-defined style
  24935. and set the parentIndex to be style.getIndex()
  24936. 3. return the index of the ExtendedFormatRecord, this will be assigned to the parent cell record
  24937. @param style the user style to apply
  24938. @return the index of a ExtendedFormatRecord record that will be referenced by the cell
  24939. </member>
  24940. <member name="M:NPOI.HSSF.UserModel.HSSFCell.CheckBounds(System.Int32)">
  24941. <summary>
  24942. Checks the bounds.
  24943. </summary>
  24944. <param name="cellIndex">The cell num.</param>
  24945. <exception cref="T:System.Exception">if the bounds are exceeded.</exception>
  24946. </member>
  24947. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetAsActiveCell">
  24948. <summary>
  24949. Sets this cell as the active cell for the worksheet
  24950. </summary>
  24951. </member>
  24952. <member name="M:NPOI.HSSF.UserModel.HSSFCell.ToString">
  24953. <summary>
  24954. Returns a string representation of the cell
  24955. This method returns a simple representation,
  24956. anthing more complex should be in user code, with
  24957. knowledge of the semantics of the sheet being Processed.
  24958. Formula cells return the formula string,
  24959. rather than the formula result.
  24960. Dates are Displayed in dd-MMM-yyyy format
  24961. Errors are Displayed as #ERR&lt;errIdx&gt;
  24962. </summary>
  24963. </member>
  24964. <member name="M:NPOI.HSSF.UserModel.HSSFCell.RemoveCellComment">
  24965. <summary>
  24966. Removes the comment for this cell, if
  24967. there is one.
  24968. </summary>
  24969. <remarks>WARNING - some versions of excel will loose
  24970. all comments after performing this action!</remarks>
  24971. </member>
  24972. <member name="M:NPOI.HSSF.UserModel.HSSFCell.UpdateCellNum(System.Int32)">
  24973. Updates the cell record's idea of what
  24974. column it belongs in (0 based)
  24975. @param num the new cell number
  24976. </member>
  24977. <member name="M:NPOI.HSSF.UserModel.HSSFCell.RemoveHyperlink">
  24978. <summary>
  24979. Removes the hyperlink for this cell, if there is one.
  24980. </summary>
  24981. </member>
  24982. <member name="M:NPOI.HSSF.UserModel.HSSFCell.NotifyArrayFormulaChanging(System.String)">
  24983. <summary>
  24984. The purpose of this method is to validate the cell state prior to modification
  24985. </summary>
  24986. <param name="msg"></param>
  24987. </member>
  24988. <member name="M:NPOI.HSSF.UserModel.HSSFCell.NotifyArrayFormulaChanging">
  24989. <summary>
  24990. Called when this cell is modified.
  24991. The purpose of this method is to validate the cell state prior to modification.
  24992. </summary>
  24993. </member>
  24994. <member name="P:NPOI.HSSF.UserModel.HSSFCell.BoundWorkbook">
  24995. <summary>
  24996. the Workbook that this Cell is bound to
  24997. </summary>
  24998. </member>
  24999. <member name="P:NPOI.HSSF.UserModel.HSSFCell.Row">
  25000. <summary>
  25001. the HSSFRow this cell belongs to
  25002. </summary>
  25003. </member>
  25004. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellType">
  25005. <summary>
  25006. Get the cells type (numeric, formula or string)
  25007. </summary>
  25008. <value>The type of the cell.</value>
  25009. </member>
  25010. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellFormula">
  25011. <summary>
  25012. Gets or sets the cell formula.
  25013. </summary>
  25014. <value>The cell formula.</value>
  25015. </member>
  25016. <member name="P:NPOI.HSSF.UserModel.HSSFCell.NumericCellValue">
  25017. <summary>
  25018. Get the value of the cell as a number. For strings we throw an exception.
  25019. For blank cells we return a 0.
  25020. </summary>
  25021. <value>The numeric cell value.</value>
  25022. </member>
  25023. <member name="P:NPOI.HSSF.UserModel.HSSFCell.DateCellValue">
  25024. <summary>
  25025. Get the value of the cell as a date. For strings we throw an exception.
  25026. For blank cells we return a null.
  25027. </summary>
  25028. <value>The date cell value.</value>
  25029. </member>
  25030. <member name="P:NPOI.HSSF.UserModel.HSSFCell.StringCellValue">
  25031. <summary>
  25032. Get the value of the cell as a string - for numeric cells we throw an exception.
  25033. For blank cells we return an empty string.
  25034. For formulaCells that are not string Formulas, we return empty String
  25035. </summary>
  25036. <value>The string cell value.</value>
  25037. </member>
  25038. <member name="P:NPOI.HSSF.UserModel.HSSFCell.RichStringCellValue">
  25039. <summary>
  25040. Get the value of the cell as a string - for numeric cells we throw an exception.
  25041. For blank cells we return an empty string.
  25042. For formulaCells that are not string Formulas, we return empty String
  25043. </summary>
  25044. <value>The rich string cell value.</value>
  25045. </member>
  25046. <member name="P:NPOI.HSSF.UserModel.HSSFCell.BooleanCellValue">
  25047. <summary>
  25048. Get the value of the cell as a bool. For strings, numbers, and errors, we throw an exception.
  25049. For blank cells we return a false.
  25050. </summary>
  25051. <value><c>true</c> if [boolean cell value]; otherwise, <c>false</c>.</value>
  25052. </member>
  25053. <member name="P:NPOI.HSSF.UserModel.HSSFCell.ErrorCellValue">
  25054. <summary>
  25055. Get the value of the cell as an error code. For strings, numbers, and bools, we throw an exception.
  25056. For blank cells we return a 0.
  25057. </summary>
  25058. <value>The error cell value.</value>
  25059. </member>
  25060. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellStyle">
  25061. <summary>
  25062. Get the style for the cell. This is a reference to a cell style contained in the workbook
  25063. object.
  25064. </summary>
  25065. <value>The cell style.</value>
  25066. </member>
  25067. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellValueRecord">
  25068. <summary>
  25069. Should only be used by HSSFSheet and friends. Returns the low level CellValueRecordInterface record
  25070. </summary>
  25071. <value>the cell via the low level api.</value>
  25072. </member>
  25073. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellComment">
  25074. <summary>
  25075. Returns comment associated with this cell
  25076. </summary>
  25077. <value>The cell comment associated with this cell.</value>
  25078. </member>
  25079. <member name="P:NPOI.HSSF.UserModel.HSSFCell.ColumnIndex">
  25080. <summary>
  25081. Gets the index of the column.
  25082. </summary>
  25083. <value>The index of the column.</value>
  25084. </member>
  25085. <member name="P:NPOI.HSSF.UserModel.HSSFCell.RowIndex">
  25086. <summary>
  25087. Gets the (zero based) index of the row containing this cell
  25088. </summary>
  25089. <value>The index of the row.</value>
  25090. </member>
  25091. <member name="P:NPOI.HSSF.UserModel.HSSFCell.Hyperlink">
  25092. <summary>
  25093. Get or set hyperlink associated with this cell
  25094. If the supplied hyperlink is null on setting, the hyperlink for this cell will be removed.
  25095. </summary>
  25096. <value>The hyperlink associated with this cell or null if not found</value>
  25097. </member>
  25098. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CachedFormulaResultType">
  25099. <summary>
  25100. Only valid for formula cells
  25101. </summary>
  25102. <value>one of (CellType.Numeric,CellType.String, CellType.Boolean, CellType.Error) depending
  25103. on the cached value of the formula</value>
  25104. </member>
  25105. <member name="T:NPOI.HSSF.UserModel.HSSFCellStyle">
  25106. <summary>
  25107. High level representation of the style of a cell in a sheet of a workbook.
  25108. @author Andrew C. Oliver (acoliver at apache dot org)
  25109. @author Jason Height (jheight at chariot dot net dot au)
  25110. </summary>
  25111. </member>
  25112. <member name="M:NPOI.SS.UserModel.ICellStyle.GetDataFormatString">
  25113. Get the format string
  25114. </member>
  25115. <member name="M:NPOI.SS.UserModel.ICellStyle.SetFont(NPOI.SS.UserModel.IFont)">
  25116. set the font for this style
  25117. @param font a font object Created or retreived from the Workbook object
  25118. @see Workbook#CreateFont()
  25119. @see Workbook#GetFontAt(short)
  25120. </member>
  25121. <member name="M:NPOI.SS.UserModel.ICellStyle.CloneStyleFrom(NPOI.SS.UserModel.ICellStyle)">
  25122. Clones all the style information from another
  25123. CellStyle, onto this one. This
  25124. CellStyle will then have all the same
  25125. properties as the source, but the two may
  25126. be edited independently.
  25127. Any stylings on this CellStyle will be lost!
  25128. The source CellStyle could be from another
  25129. Workbook if you like. This allows you to
  25130. copy styles from one Workbook to another.
  25131. However, both of the CellStyles will need
  25132. to be of the same type (HSSFCellStyle or
  25133. XSSFCellStyle)
  25134. </member>
  25135. <member name="P:NPOI.SS.UserModel.ICellStyle.ShrinkToFit">
  25136. <summary>
  25137. the Cell should be auto-sized to shrink to fit if the text is too long
  25138. </summary>
  25139. </member>
  25140. <member name="P:NPOI.SS.UserModel.ICellStyle.Index">
  25141. get the index within the Workbook (sequence within the collection of ExtnededFormat objects)
  25142. @return unique index number of the underlying record this style represents (probably you don't care
  25143. unless you're comparing which one is which)
  25144. </member>
  25145. <member name="P:NPOI.SS.UserModel.ICellStyle.DataFormat">
  25146. get the index of the format
  25147. @see DataFormat
  25148. </member>
  25149. <member name="P:NPOI.SS.UserModel.ICellStyle.FontIndex">
  25150. Gets the index of the font for this style
  25151. @see Workbook#GetFontAt(short)
  25152. </member>
  25153. <member name="P:NPOI.SS.UserModel.ICellStyle.IsHidden">
  25154. get whether the cell's using this style are to be hidden
  25155. @return hidden - whether the cell using this style should be hidden
  25156. </member>
  25157. <member name="P:NPOI.SS.UserModel.ICellStyle.IsLocked">
  25158. get whether the cell's using this style are to be locked
  25159. @return hidden - whether the cell using this style should be locked
  25160. </member>
  25161. <member name="P:NPOI.SS.UserModel.ICellStyle.Alignment">
  25162. get the type of horizontal alignment for the cell
  25163. @return align - the type of alignment
  25164. @see #ALIGN_GENERAL
  25165. @see #ALIGN_LEFT
  25166. @see #ALIGN_CENTER
  25167. @see #ALIGN_RIGHT
  25168. @see #ALIGN_FILL
  25169. @see #ALIGN_JUSTIFY
  25170. @see #ALIGN_CENTER_SELECTION
  25171. </member>
  25172. <member name="P:NPOI.SS.UserModel.ICellStyle.WrapText">
  25173. get whether the text should be wrapped
  25174. @return wrap text or not
  25175. </member>
  25176. <member name="P:NPOI.SS.UserModel.ICellStyle.VerticalAlignment">
  25177. get the type of vertical alignment for the cell
  25178. @return align the type of alignment
  25179. @see #VERTICAL_TOP
  25180. @see #VERTICAL_CENTER
  25181. @see #VERTICAL_BOTTOM
  25182. @see #VERTICAL_JUSTIFY
  25183. </member>
  25184. <member name="P:NPOI.SS.UserModel.ICellStyle.Rotation">
  25185. get the degree of rotation for the text in the cell
  25186. @return rotation degrees (between -90 and 90 degrees)
  25187. </member>
  25188. <member name="P:NPOI.SS.UserModel.ICellStyle.Indention">
  25189. get the number of spaces to indent the text in the cell
  25190. @return indent - number of spaces
  25191. </member>
  25192. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderLeft">
  25193. get the type of border to use for the left border of the cell
  25194. @return border type
  25195. @see #BORDER_NONE
  25196. @see #BORDER_THIN
  25197. @see #BORDER_MEDIUM
  25198. @see #BORDER_DASHED
  25199. @see #BORDER_DOTTED
  25200. @see #BORDER_THICK
  25201. @see #BORDER_DOUBLE
  25202. @see #BORDER_HAIR
  25203. @see #BORDER_MEDIUM_DASHED
  25204. @see #BORDER_DASH_DOT
  25205. @see #BORDER_MEDIUM_DASH_DOT
  25206. @see #BORDER_DASH_DOT_DOT
  25207. @see #BORDER_MEDIUM_DASH_DOT_DOT
  25208. @see #BORDER_SLANTED_DASH_DOT
  25209. </member>
  25210. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderRight">
  25211. get the type of border to use for the right border of the cell
  25212. @return border type
  25213. @see #BORDER_NONE
  25214. @see #BORDER_THIN
  25215. @see #BORDER_MEDIUM
  25216. @see #BORDER_DASHED
  25217. @see #BORDER_DOTTED
  25218. @see #BORDER_THICK
  25219. @see #BORDER_DOUBLE
  25220. @see #BORDER_HAIR
  25221. @see #BORDER_MEDIUM_DASHED
  25222. @see #BORDER_DASH_DOT
  25223. @see #BORDER_MEDIUM_DASH_DOT
  25224. @see #BORDER_DASH_DOT_DOT
  25225. @see #BORDER_MEDIUM_DASH_DOT_DOT
  25226. @see #BORDER_SLANTED_DASH_DOT
  25227. </member>
  25228. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderTop">
  25229. get the type of border to use for the top border of the cell
  25230. @return border type
  25231. @see #BORDER_NONE
  25232. @see #BORDER_THIN
  25233. @see #BORDER_MEDIUM
  25234. @see #BORDER_DASHED
  25235. @see #BORDER_DOTTED
  25236. @see #BORDER_THICK
  25237. @see #BORDER_DOUBLE
  25238. @see #BORDER_HAIR
  25239. @see #BORDER_MEDIUM_DASHED
  25240. @see #BORDER_DASH_DOT
  25241. @see #BORDER_MEDIUM_DASH_DOT
  25242. @see #BORDER_DASH_DOT_DOT
  25243. @see #BORDER_MEDIUM_DASH_DOT_DOT
  25244. @see #BORDER_SLANTED_DASH_DOT
  25245. </member>
  25246. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderBottom">
  25247. get the type of border to use for the bottom border of the cell
  25248. @return border type
  25249. @see #BORDER_NONE
  25250. @see #BORDER_THIN
  25251. @see #BORDER_MEDIUM
  25252. @see #BORDER_DASHED
  25253. @see #BORDER_DOTTED
  25254. @see #BORDER_THICK
  25255. @see #BORDER_DOUBLE
  25256. @see #BORDER_HAIR
  25257. @see #BORDER_MEDIUM_DASHED
  25258. @see #BORDER_DASH_DOT
  25259. @see #BORDER_MEDIUM_DASH_DOT
  25260. @see #BORDER_DASH_DOT_DOT
  25261. @see #BORDER_MEDIUM_DASH_DOT_DOT
  25262. @see #BORDER_SLANTED_DASH_DOT
  25263. </member>
  25264. <member name="P:NPOI.SS.UserModel.ICellStyle.LeftBorderColor">
  25265. get the color to use for the left border
  25266. </member>
  25267. <member name="P:NPOI.SS.UserModel.ICellStyle.RightBorderColor">
  25268. get the color to use for the left border
  25269. @return the index of the color defInition
  25270. </member>
  25271. <member name="P:NPOI.SS.UserModel.ICellStyle.TopBorderColor">
  25272. get the color to use for the top border
  25273. @return hhe index of the color defInition
  25274. </member>
  25275. <member name="P:NPOI.SS.UserModel.ICellStyle.BottomBorderColor">
  25276. get the color to use for the left border
  25277. @return the index of the color defInition
  25278. </member>
  25279. <member name="P:NPOI.SS.UserModel.ICellStyle.FillPattern">
  25280. get the fill pattern (??) - set to 1 to fill with foreground color
  25281. @return fill pattern
  25282. </member>
  25283. <member name="P:NPOI.SS.UserModel.ICellStyle.FillBackgroundColor">
  25284. get the background fill color
  25285. @return fill color
  25286. </member>
  25287. <member name="P:NPOI.SS.UserModel.ICellStyle.FillForegroundColor">
  25288. get the foreground fill color
  25289. @return fill color
  25290. </member>
  25291. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderDiagonalColor">
  25292. <summary>
  25293. Gets or sets the color to use for the diagional border
  25294. </summary>
  25295. <value>The index of the color definition.</value>
  25296. </member>
  25297. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderDiagonalLineStyle">
  25298. <summary>
  25299. Gets or sets the line type to use for the diagional border
  25300. </summary>
  25301. <value>The line type.</value>
  25302. </member>
  25303. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderDiagonal">
  25304. <summary>
  25305. Gets or sets the type of diagional border
  25306. </summary>.
  25307. <value>The border diagional type.</value>
  25308. </member>
  25309. <member name="P:NPOI.SS.UserModel.ICellStyle.FillBackgroundColorColor">
  25310. Gets the color object representing the current
  25311. background fill, resolving indexes using
  25312. the supplied workbook.
  25313. This will work for both indexed and rgb
  25314. defined colors.
  25315. </member>
  25316. <member name="P:NPOI.SS.UserModel.ICellStyle.FillForegroundColorColor">
  25317. Gets the color object representing the current
  25318. foreground fill, resolving indexes using
  25319. the supplied workbook.
  25320. This will work for both indexed and rgb
  25321. defined colors.
  25322. </member>
  25323. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.#ctor(System.Int16,NPOI.HSSF.Record.ExtendedFormatRecord,NPOI.HSSF.UserModel.HSSFWorkbook)">
  25324. <summary>
  25325. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFCellStyle"/> class.
  25326. </summary>
  25327. <param name="index">The index.</param>
  25328. <param name="rec">The record.</param>
  25329. <param name="workbook">The workbook.</param>
  25330. </member>
  25331. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.#ctor(System.Int16,NPOI.HSSF.Record.ExtendedFormatRecord,NPOI.HSSF.Model.InternalWorkbook)">
  25332. <summary>
  25333. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFCellStyle"/> class.
  25334. </summary>
  25335. <param name="index">The index.</param>
  25336. <param name="rec">The record.</param>
  25337. <param name="workbook">The workbook.</param>
  25338. </member>
  25339. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetDataFormatString">
  25340. <summary>
  25341. Get the contents of the format string, by looking up
  25342. the DataFormat against the bound workbook
  25343. </summary>
  25344. <returns></returns>
  25345. </member>
  25346. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetDataFormatString(NPOI.SS.UserModel.IWorkbook)">
  25347. <summary>
  25348. Get the contents of the format string, by looking up the DataFormat against the supplied workbook
  25349. </summary>
  25350. <param name="workbook">The workbook</param>
  25351. <returns>the format string or "General" if not found</returns>
  25352. </member>
  25353. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetDataFormatString(NPOI.HSSF.Model.InternalWorkbook)">
  25354. <summary>
  25355. Get the contents of the format string, by looking up
  25356. the DataFormat against the supplied workbook
  25357. </summary>
  25358. <param name="workbook">The internal workbook.</param>
  25359. <returns></returns>
  25360. </member>
  25361. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.SetFont(NPOI.SS.UserModel.IFont)">
  25362. <summary>
  25363. Set the font for this style
  25364. </summary>
  25365. <param name="font">a font object Created or retreived from the HSSFWorkbook object</param>
  25366. </member>
  25367. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetFont(NPOI.SS.UserModel.IWorkbook)">
  25368. <summary>
  25369. Gets the font for this style
  25370. </summary>
  25371. <param name="parentWorkbook">The parent workbook that this style belongs to.</param>
  25372. <returns></returns>
  25373. </member>
  25374. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.VerifyBelongsToWorkbook(NPOI.HSSF.UserModel.HSSFWorkbook)">
  25375. <summary>
  25376. Verifies that this style belongs to the supplied Workbook.
  25377. Will throw an exception if it belongs to a different one.
  25378. This is normally called when trying to assign a style to a
  25379. cell, to ensure the cell and the style are from the same
  25380. workbook (if they're not, it won't work)
  25381. </summary>
  25382. <param name="wb">The workbook.</param>
  25383. </member>
  25384. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.CheckDefaultBackgroundFills">
  25385. <summary>
  25386. Checks if the background and foreground Fills are Set correctly when one
  25387. or the other is Set to the default color.
  25388. Works like the logic table below:
  25389. BACKGROUND FOREGROUND
  25390. NONE AUTOMATIC
  25391. 0x41 0x40
  25392. NONE RED/ANYTHING
  25393. 0x40 0xSOMETHING
  25394. </summary>
  25395. </member>
  25396. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.CloneStyleFrom(NPOI.SS.UserModel.ICellStyle)">
  25397. Clones all the style information from another
  25398. HSSFCellStyle, onto this one. This
  25399. HSSFCellStyle will then have all the same
  25400. properties as the source, but the two may
  25401. be edited independently.
  25402. Any stylings on this HSSFCellStyle will be lost!
  25403. The source HSSFCellStyle could be from another
  25404. HSSFWorkbook if you like. This allows you to
  25405. copy styles from one HSSFWorkbook to another.
  25406. </member>
  25407. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.CloneStyleFrom(NPOI.HSSF.UserModel.HSSFCellStyle)">
  25408. <summary>
  25409. Clones all the style information from another
  25410. HSSFCellStyle, onto this one. This
  25411. HSSFCellStyle will then have all the same
  25412. properties as the source, but the two may
  25413. be edited independently.
  25414. Any stylings on this HSSFCellStyle will be lost!
  25415. The source HSSFCellStyle could be from another
  25416. HSSFWorkbook if you like. This allows you to
  25417. copy styles from one HSSFWorkbook to another.
  25418. </summary>
  25419. <param name="source">The source.</param>
  25420. </member>
  25421. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetHashCode">
  25422. <summary>
  25423. Serves as a hash function for a particular type.
  25424. </summary>
  25425. <returns>
  25426. A hash code for the current <see cref="T:System.Object"/>.
  25427. </returns>
  25428. </member>
  25429. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.Equals(System.Object)">
  25430. <summary>
  25431. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  25432. </summary>
  25433. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
  25434. <returns>
  25435. true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
  25436. </returns>
  25437. <exception cref="T:System.NullReferenceException">
  25438. The <paramref name="obj"/> parameter is null.
  25439. </exception>
  25440. </member>
  25441. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.Index">
  25442. <summary>
  25443. Get the index within the HSSFWorkbook (sequence within the collection of ExtnededFormat objects)
  25444. </summary>
  25445. <value>Unique index number of the Underlying record this style represents (probably you don't care
  25446. Unless you're comparing which one is which)</value>
  25447. </member>
  25448. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.ParentStyle">
  25449. <summary>
  25450. Gets the parent style.
  25451. </summary>
  25452. <value>the parent style for this cell style.
  25453. In most cases this will be null, but in a few
  25454. cases there'll be a fully defined parent.</value>
  25455. </member>
  25456. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.DataFormat">
  25457. <summary>
  25458. Get the index of the format
  25459. </summary>
  25460. <value>The data format.</value>
  25461. </member>
  25462. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.FontIndex">
  25463. <summary>
  25464. Gets the index of the font for this style.
  25465. </summary>
  25466. <value>The index of the font.</value>
  25467. </member>
  25468. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.IsHidden">
  25469. <summary>
  25470. Get whether the cell's using this style are to be hidden
  25471. </summary>
  25472. <value>whether the cell using this style should be hidden</value>
  25473. </member>
  25474. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.IsLocked">
  25475. <summary>
  25476. Get whether the cell's using this style are to be locked
  25477. </summary>
  25478. <value>whether the cell using this style should be locked</value>
  25479. </member>
  25480. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.Alignment">
  25481. <summary>
  25482. Get the type of horizontal alignment for the cell
  25483. </summary>
  25484. <value> the type of alignment</value>
  25485. </member>
  25486. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.WrapText">
  25487. <summary>
  25488. Gets or sets a value indicating whether the text should be wrapped
  25489. </summary>
  25490. <value><c>true</c> if [wrap text]; otherwise, <c>false</c>.</value>
  25491. </member>
  25492. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.VerticalAlignment">
  25493. <summary>
  25494. Gets or sets the vertical alignment for the cell.
  25495. </summary>
  25496. <value>the type of alignment</value>
  25497. </member>
  25498. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.Rotation">
  25499. <summary>
  25500. Gets or sets the degree of rotation for the text in the cell
  25501. </summary>
  25502. <value>The rotation degrees (between -90 and 90 degrees).</value>
  25503. </member>
  25504. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.Indention">
  25505. <summary>
  25506. Gets or sets the number of spaces to indent the text in the cell
  25507. </summary>
  25508. <value>number of spaces</value>
  25509. </member>
  25510. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderLeft">
  25511. <summary>
  25512. Gets or sets the type of border to use for the left border of the cell
  25513. </summary>
  25514. <value>The border type.</value>
  25515. </member>
  25516. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderRight">
  25517. <summary>
  25518. Gets or sets the type of border to use for the right border of the cell
  25519. </summary>
  25520. <value>The border type.</value>
  25521. </member>
  25522. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderTop">
  25523. <summary>
  25524. Gets or sets the type of border to use for the top border of the cell
  25525. </summary>
  25526. <value>The border type.</value>
  25527. </member>
  25528. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderBottom">
  25529. <summary>
  25530. Gets or sets the type of border to use for the bottom border of the cell
  25531. </summary>
  25532. <value>The border type.</value>
  25533. </member>
  25534. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.LeftBorderColor">
  25535. <summary>
  25536. Gets or sets the color to use for the left border
  25537. </summary>
  25538. <value>The index of the color definition</value>
  25539. </member>
  25540. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.RightBorderColor">
  25541. <summary>
  25542. Gets or sets the color to use for the left border.
  25543. </summary>
  25544. <value>The index of the color definition</value>
  25545. </member>
  25546. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.TopBorderColor">
  25547. <summary>
  25548. Gets or sets the color to use for the top border
  25549. </summary>
  25550. <value>The index of the color definition.</value>
  25551. </member>
  25552. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BottomBorderColor">
  25553. <summary>
  25554. Gets or sets the color to use for the left border
  25555. </summary>
  25556. <value>The index of the color definition.</value>
  25557. </member>
  25558. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderDiagonalColor">
  25559. <summary>
  25560. Gets or sets the color to use for the diagional border
  25561. </summary>
  25562. <value>The index of the color definition.</value>
  25563. </member>
  25564. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderDiagonalLineStyle">
  25565. <summary>
  25566. Gets or sets the line type to use for the diagional border
  25567. </summary>
  25568. <value>The line type.</value>
  25569. </member>
  25570. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderDiagonal">
  25571. <summary>
  25572. Gets or sets the type of diagional border
  25573. </summary>.
  25574. <value>The border diagional type.</value>
  25575. </member>
  25576. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.ShrinkToFit">
  25577. <summary>
  25578. Gets or sets whether the cell is shrink-to-fit
  25579. </summary>
  25580. </member>
  25581. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.ReadingOrder">
  25582. Get or set the reading order, for RTL/LTR ordering of
  25583. the text.
  25584. <p>0 means Context (Default), 1 means Left To Right,
  25585. and 2 means Right to Left</p>
  25586. @return order - the reading order (0,1,2)
  25587. </member>
  25588. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.FillPattern">
  25589. <summary>
  25590. Gets or sets the fill pattern. - Set to 1 to Fill with foreground color
  25591. </summary>
  25592. <value>The fill pattern.</value>
  25593. </member>
  25594. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.FillBackgroundColor">
  25595. <summary>
  25596. Gets or sets the color of the fill background.
  25597. </summary>
  25598. <value>The color of the fill background.</value>
  25599. Set the background Fill color.
  25600. <example>
  25601. cs.SetFillPattern(HSSFCellStyle.FINE_DOTS );
  25602. cs.SetFillBackgroundColor(new HSSFColor.RED().Index);
  25603. optionally a Foreground and background Fill can be applied:
  25604. Note: Ensure Foreground color is Set prior to background
  25605. cs.SetFillPattern(HSSFCellStyle.FINE_DOTS );
  25606. cs.SetFillForegroundColor(new HSSFColor.BLUE().Index);
  25607. cs.SetFillBackgroundColor(new HSSFColor.RED().Index);
  25608. or, for the special case of SOLID_Fill:
  25609. cs.SetFillPattern(HSSFCellStyle.SOLID_FOREGROUND );
  25610. cs.SetFillForegroundColor(new HSSFColor.RED().Index);
  25611. It is necessary to Set the Fill style in order
  25612. for the color to be shown in the cell.
  25613. </example>
  25614. </member>
  25615. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.FillForegroundColor">
  25616. <summary>
  25617. Gets or sets the foreground Fill color
  25618. </summary>
  25619. <value>Fill color.</value>
  25620. @see org.apache.poi.hssf.usermodel.HSSFPalette#GetColor(short)
  25621. </member>
  25622. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.UserStyleName">
  25623. Gets the name of the user defined style.
  25624. Returns null for built in styles, and
  25625. styles where no name has been defined
  25626. </member>
  25627. <member name="M:NPOI.HSSF.UserModel.HSSFChildAnchor.#ctor(NPOI.DDF.EscherChildAnchorRecord)">
  25628. create anchor from existing file
  25629. @param escherChildAnchorRecord
  25630. </member>
  25631. <member name="M:NPOI.HSSF.UserModel.HSSFChildAnchor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  25632. create anchor from scratch
  25633. @param dx1 x coordinate of the left up corner
  25634. @param dy1 y coordinate of the left up corner
  25635. @param dx2 x coordinate of the right down corner
  25636. @param dy2 y coordinate of the right down corner
  25637. </member>
  25638. <member name="M:NPOI.HSSF.UserModel.HSSFChildAnchor.SetAnchor(System.Int32,System.Int32,System.Int32,System.Int32)">
  25639. @param dx1 x coordinate of the left up corner
  25640. @param dy1 y coordinate of the left up corner
  25641. @param dx2 x coordinate of the right down corner
  25642. @param dy2 y coordinate of the right down corner
  25643. </member>
  25644. <member name="T:NPOI.HSSF.UserModel.HSSFClientAnchor">
  25645. <summary>
  25646. A client anchor Is attached to an excel worksheet. It anchors against a
  25647. top-left and buttom-right cell.
  25648. @author Glen Stampoultzis (glens at apache.org)
  25649. </summary>
  25650. </member>
  25651. <member name="T:NPOI.SS.UserModel.IClientAnchor">
  25652. A client anchor is attached to an excel worksheet. It anchors against a
  25653. top-left and bottom-right cell.
  25654. @author Yegor Kozlov
  25655. </member>
  25656. <member name="P:NPOI.SS.UserModel.IClientAnchor.Col1">
  25657. Returns the column (0 based) of the first cell.
  25658. @return 0-based column of the first cell.
  25659. </member>
  25660. <member name="P:NPOI.SS.UserModel.IClientAnchor.Col2">
  25661. Returns the column (0 based) of the second cell.
  25662. @return 0-based column of the second cell.
  25663. </member>
  25664. <member name="P:NPOI.SS.UserModel.IClientAnchor.Row1">
  25665. Returns the row (0 based) of the first cell.
  25666. @return 0-based row of the first cell.
  25667. </member>
  25668. <member name="P:NPOI.SS.UserModel.IClientAnchor.Row2">
  25669. Returns the row (0 based) of the second cell.
  25670. @return 0-based row of the second cell.
  25671. </member>
  25672. <member name="P:NPOI.SS.UserModel.IClientAnchor.Dx1">
  25673. Returns the x coordinate within the first cell
  25674. @return the x coordinate within the first cell
  25675. </member>
  25676. <member name="P:NPOI.SS.UserModel.IClientAnchor.Dy1">
  25677. Returns the y coordinate within the first cell
  25678. @return the y coordinate within the first cell
  25679. </member>
  25680. <member name="P:NPOI.SS.UserModel.IClientAnchor.Dy2">
  25681. Sets the y coordinate within the second cell
  25682. @return the y coordinate within the second cell
  25683. </member>
  25684. <member name="P:NPOI.SS.UserModel.IClientAnchor.Dx2">
  25685. Returns the x coordinate within the second cell
  25686. @return the x coordinate within the second cell
  25687. </member>
  25688. <member name="P:NPOI.SS.UserModel.IClientAnchor.AnchorType">
  25689. s the anchor type
  25690. <p>
  25691. 0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.
  25692. </p>
  25693. @return the anchor type
  25694. @see #MOVE_AND_RESIZE
  25695. @see #MOVE_DONT_RESIZE
  25696. @see #DONT_MOVE_AND_RESIZE
  25697. </member>
  25698. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.#ctor">
  25699. <summary>
  25700. Creates a new client anchor and defaults all the anchor positions to 0.
  25701. </summary>
  25702. </member>
  25703. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  25704. <summary>
  25705. Creates a new client anchor and Sets the top-left and bottom-right
  25706. coordinates of the anchor.
  25707. Note: Microsoft Excel seems to sometimes disallow
  25708. higher y1 than y2 or higher x1 than x2 in the anchor, you might need to
  25709. reverse them and draw shapes vertically or horizontally flipped!
  25710. </summary>
  25711. <param name="dx1">the x coordinate within the first cell.</param>
  25712. <param name="dy1">the y coordinate within the first cell.</param>
  25713. <param name="dx2">the x coordinate within the second cell.</param>
  25714. <param name="dy2">the y coordinate within the second cell.</param>
  25715. <param name="col1">the column (0 based) of the first cell.</param>
  25716. <param name="row1">the row (0 based) of the first cell.</param>
  25717. <param name="col2">the column (0 based) of the second cell.</param>
  25718. <param name="row2">the row (0 based) of the second cell.</param>
  25719. </member>
  25720. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.GetAnchorHeightInPoints(NPOI.SS.UserModel.ISheet)">
  25721. <summary>
  25722. Calculates the height of a client anchor in points.
  25723. </summary>
  25724. <param name="sheet">the sheet the anchor will be attached to</param>
  25725. <returns>the shape height.</returns>
  25726. </member>
  25727. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.GetRowHeightInPoints(NPOI.SS.UserModel.ISheet,System.Int32)">
  25728. <summary>
  25729. Gets the row height in points.
  25730. </summary>
  25731. <param name="sheet">The sheet.</param>
  25732. <param name="rowNum">The row num.</param>
  25733. <returns></returns>
  25734. </member>
  25735. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.SetAnchor(System.Int16,System.Int32,System.Int32,System.Int32,System.Int16,System.Int32,System.Int32,System.Int32)">
  25736. <summary>
  25737. Sets the top-left and bottom-right
  25738. coordinates of the anchor
  25739. Note: Microsoft Excel seems to sometimes disallow
  25740. higher y1 than y2 or higher x1 than x2 in the anchor, you might need to
  25741. reverse them and draw shapes vertically or horizontally flipped!
  25742. </summary>
  25743. <param name="col1">the column (0 based) of the first cell.</param>
  25744. <param name="row1"> the row (0 based) of the first cell.</param>
  25745. <param name="x1">the x coordinate within the first cell.</param>
  25746. <param name="y1">the y coordinate within the first cell.</param>
  25747. <param name="col2">the column (0 based) of the second cell.</param>
  25748. <param name="row2">the row (0 based) of the second cell.</param>
  25749. <param name="x2">the x coordinate within the second cell.</param>
  25750. <param name="y2">the y coordinate within the second cell.</param>
  25751. </member>
  25752. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.CheckRange(System.Int32,System.Int32,System.Int32,System.String)">
  25753. <summary>
  25754. Checks the range.
  25755. </summary>
  25756. <param name="value">The value.</param>
  25757. <param name="minRange">The min range.</param>
  25758. <param name="maxRange">The max range.</param>
  25759. <param name="varName">Name of the variable.</param>
  25760. </member>
  25761. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.Col1">
  25762. <summary>
  25763. Gets or sets the col1.
  25764. </summary>
  25765. <value>The col1.</value>
  25766. </member>
  25767. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.Col2">
  25768. <summary>
  25769. Gets or sets the col2.
  25770. </summary>
  25771. <value>The col2.</value>
  25772. </member>
  25773. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.Row1">
  25774. <summary>
  25775. Gets or sets the row1.
  25776. </summary>
  25777. <value>The row1.</value>
  25778. </member>
  25779. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.Row2">
  25780. <summary>
  25781. Gets or sets the row2.
  25782. </summary>
  25783. <value>The row2.</value>
  25784. </member>
  25785. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.IsHorizontallyFlipped">
  25786. <summary>
  25787. Gets a value indicating whether this instance is horizontally flipped.
  25788. </summary>
  25789. <value>
  25790. <c>true</c> if the anchor goes from right to left; otherwise, <c>false</c>.
  25791. </value>
  25792. </member>
  25793. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.IsVerticallyFlipped">
  25794. <summary>
  25795. Gets a value indicating whether this instance is vertically flipped.
  25796. </summary>
  25797. <value>
  25798. <c>true</c> if the anchor goes from bottom to top.; otherwise, <c>false</c>.
  25799. </value>
  25800. </member>
  25801. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.AnchorType">
  25802. <summary>
  25803. Gets the anchor type
  25804. 0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.
  25805. </summary>
  25806. <value>The type of the anchor.</value>
  25807. </member>
  25808. <member name="T:NPOI.HSSF.UserModel.HSSFComment">
  25809. <summary>
  25810. Represents a cell comment - a sticky note associated with a cell.
  25811. @author Yegor Kozlov
  25812. </summary>
  25813. </member>
  25814. <member name="T:NPOI.HSSF.UserModel.HSSFTextbox">
  25815. <summary>
  25816. A textbox Is a shape that may hold a rich text string.
  25817. @author Glen Stampoultzis (glens at apache.org)
  25818. </summary>
  25819. </member>
  25820. <member name="M:NPOI.HSSF.UserModel.HSSFTextbox.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  25821. <summary>
  25822. Construct a new textbox with the given parent and anchor.
  25823. </summary>
  25824. <param name="parent">The parent.</param>
  25825. <param name="anchor">One of HSSFClientAnchor or HSSFChildAnchor</param>
  25826. </member>
  25827. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.MarginLeft">
  25828. <summary>
  25829. Gets or sets the left margin within the textbox.
  25830. </summary>
  25831. <value>The margin left.</value>
  25832. </member>
  25833. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.MarginRight">
  25834. <summary>
  25835. Gets or sets the right margin within the textbox.
  25836. </summary>
  25837. <value>The margin right.</value>
  25838. </member>
  25839. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.MarginTop">
  25840. <summary>
  25841. Gets or sets the top margin within the textbox
  25842. </summary>
  25843. <value>The top margin.</value>
  25844. </member>
  25845. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.MarginBottom">
  25846. <summary>
  25847. Gets or sets the bottom margin within the textbox.
  25848. </summary>
  25849. <value>The margin bottom.</value>
  25850. </member>
  25851. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.HorizontalAlignment">
  25852. <summary>
  25853. Gets or sets the horizontal alignment.
  25854. </summary>
  25855. <value>The horizontal alignment.</value>
  25856. </member>
  25857. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.VerticalAlignment">
  25858. <summary>
  25859. Gets or sets the vertical alignment.
  25860. </summary>
  25861. <value>The vertical alignment.</value>
  25862. </member>
  25863. <member name="P:NPOI.SS.UserModel.IComment.Visible">
  25864. Sets whether this comment is visible.
  25865. @return <c>true</c> if the comment is visible, <c>false</c> otherwise
  25866. </member>
  25867. <member name="P:NPOI.SS.UserModel.IComment.Row">
  25868. Return the row of the cell that Contains the comment
  25869. @return the 0-based row of the cell that Contains the comment
  25870. </member>
  25871. <member name="P:NPOI.SS.UserModel.IComment.Column">
  25872. Return the column of the cell that Contains the comment
  25873. @return the 0-based column of the cell that Contains the comment
  25874. </member>
  25875. <member name="P:NPOI.SS.UserModel.IComment.Author">
  25876. Name of the original comment author
  25877. @return the name of the original author of the comment
  25878. </member>
  25879. <member name="P:NPOI.SS.UserModel.IComment.String">
  25880. Fetches the rich text string of the comment
  25881. </member>
  25882. <member name="P:NPOI.SS.UserModel.IComment.ClientAnchor">
  25883. Return defines position of this anchor in the sheet.
  25884. @return defines position of this anchor in the sheet
  25885. </member>
  25886. <member name="M:NPOI.HSSF.UserModel.HSSFComment.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  25887. <summary>
  25888. Construct a new comment with the given parent and anchor.
  25889. </summary>
  25890. <param name="parent"></param>
  25891. <param name="anchor">defines position of this anchor in the sheet</param>
  25892. </member>
  25893. <member name="M:NPOI.HSSF.UserModel.HSSFComment.#ctor(NPOI.HSSF.Record.NoteRecord,NPOI.HSSF.Record.TextObjectRecord)">
  25894. <summary>
  25895. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFComment"/> class.
  25896. </summary>
  25897. <param name="note">The note.</param>
  25898. <param name="txo">The txo.</param>
  25899. </member>
  25900. <member name="P:NPOI.HSSF.UserModel.HSSFComment.Visible">
  25901. <summary>
  25902. Gets or sets a value indicating whether this <see cref="T:NPOI.HSSF.UserModel.HSSFComment"/> is visible.
  25903. </summary>
  25904. <value><c>true</c> if visible; otherwise, <c>false</c>.</value>
  25905. Sets whether this comment Is visible.
  25906. @return
  25907. <c>true</c>
  25908. if the comment Is visible,
  25909. <c>false</c>
  25910. otherwise
  25911. </member>
  25912. <member name="P:NPOI.HSSF.UserModel.HSSFComment.Row">
  25913. <summary>
  25914. Gets or sets the row of the cell that Contains the comment
  25915. </summary>
  25916. <value>the 0-based row of the cell that Contains the comment</value>
  25917. </member>
  25918. <member name="P:NPOI.HSSF.UserModel.HSSFComment.Column">
  25919. <summary>
  25920. Gets or sets the column of the cell that Contains the comment
  25921. </summary>
  25922. <value>the 0-based column of the cell that Contains the comment</value>
  25923. </member>
  25924. <member name="P:NPOI.HSSF.UserModel.HSSFComment.Author">
  25925. <summary>
  25926. Gets or sets the name of the original comment author
  25927. </summary>
  25928. <value>the name of the original author of the comment</value>
  25929. </member>
  25930. <member name="P:NPOI.HSSF.UserModel.HSSFComment.NoteRecord">
  25931. <summary>
  25932. Gets the note record.
  25933. </summary>
  25934. <value>the underlying Note record.</value>
  25935. </member>
  25936. <member name="P:NPOI.HSSF.UserModel.HSSFComment.HasPosition">
  25937. Do we know which cell this comment belongs to?
  25938. </member>
  25939. <member name="T:NPOI.HSSF.UserModel.HSSFConditionalFormatting">
  25940. <summary>
  25941. HSSFConditionalFormatting class encapsulates all Settings of Conditional Formatting.
  25942. The class can be used to make a copy HSSFConditionalFormatting Settings
  25943. </summary>
  25944. <example>
  25945. HSSFConditionalFormatting cf = sheet.GetConditionalFormattingAt(index);
  25946. newSheet.AddConditionalFormatting(cf);
  25947. or to modify existing Conditional Formatting Settings (formatting regions and/or rules).
  25948. Use {@link HSSFSheet#GetConditionalFormattingAt(int)} to Get access to an instance of this class.
  25949. To Create a new Conditional Formatting Set use the following approach:
  25950. // Define a Conditional Formatting rule, which triggers formatting
  25951. // when cell's value Is greater or equal than 100.0 and
  25952. // applies patternFormatting defined below.
  25953. HSSFConditionalFormattingRule rule = sheet.CreateConditionalFormattingRule(
  25954. ComparisonOperator.GE,
  25955. "100.0", // 1st formula
  25956. null // 2nd formula Is not used for comparison operator GE
  25957. );
  25958. // Create pattern with red background
  25959. HSSFPatternFormatting patternFmt = rule.cretePatternFormatting();
  25960. patternFormatting.SetFillBackgroundColor(HSSFColor.RED.index);
  25961. // Define a region containing first column
  25962. Region [] regions =
  25963. {
  25964. new Region(1,(short)1,-1,(short)1)
  25965. };
  25966. // Apply Conditional Formatting rule defined above to the regions
  25967. sheet.AddConditionalFormatting(regions, rule);
  25968. </example>
  25969. <remarks>@author Dmitriy Kumshayev</remarks>
  25970. </member>
  25971. <member name="T:NPOI.SS.UserModel.IConditionalFormatting">
  25972. The ConditionalFormatting class encapsulates all Settings of Conditional Formatting.
  25973. The class can be used
  25974. <UL>
  25975. <LI>
  25976. to make a copy ConditionalFormatting Settings.
  25977. </LI>
  25978. For example:
  25979. <PRE>
  25980. ConditionalFormatting cf = sheet.GetConditionalFormattingAt(index);
  25981. newSheet.AddConditionalFormatting(cf);
  25982. </PRE>
  25983. <LI>
  25984. or to modify existing Conditional Formatting Settings (formatting regions and/or rules).
  25985. </LI>
  25986. </UL>
  25987. Use {@link NPOI.HSSF.UserModel.Sheet#getSheetConditionalFormatting()} to Get access to an instance of this class.
  25988. To create a new Conditional Formatting Set use the following approach:
  25989. <PRE>
  25990. // Define a Conditional Formatting rule, which triggers formatting
  25991. // when cell's value is greater or equal than 100.0 and
  25992. // applies patternFormatting defined below.
  25993. ConditionalFormattingRule rule = sheet.CreateConditionalFormattingRule(
  25994. ComparisonOperator.GE,
  25995. "100.0", // 1st formula
  25996. null // 2nd formula is not used for comparison operator GE
  25997. );
  25998. // Create pattern with red background
  25999. PatternFormatting patternFmt = rule.CretePatternFormatting();
  26000. patternFormatting.FillBackgroundColor(IndexedColor.RED.Index);
  26001. // Define a region Containing first column
  26002. Region [] regions =
  26003. {
  26004. new Region(1,(short)1,-1,(short)1)
  26005. };
  26006. // Apply Conditional Formatting rule defined above to the regions
  26007. sheet.AddConditionalFormatting(regions, rule);
  26008. </PRE>
  26009. @author Dmitriy Kumshayev
  26010. @author Yegor Kozlov
  26011. </member>
  26012. <member name="M:NPOI.SS.UserModel.IConditionalFormatting.GetFormattingRanges">
  26013. @return array of <c>CellRangeAddress</c>s. Never <code>null</code>
  26014. </member>
  26015. <member name="M:NPOI.SS.UserModel.IConditionalFormatting.SetRule(System.Int32,NPOI.SS.UserModel.IConditionalFormattingRule)">
  26016. Replaces an existing Conditional Formatting rule at position idx.
  26017. Excel allows to create up to 3 Conditional Formatting rules.
  26018. This method can be useful to modify existing Conditional Formatting rules.
  26019. @param idx position of the rule. Should be between 0 and 2.
  26020. @param cfRule - Conditional Formatting rule
  26021. </member>
  26022. <member name="M:NPOI.SS.UserModel.IConditionalFormatting.AddRule(NPOI.SS.UserModel.IConditionalFormattingRule)">
  26023. Add a Conditional Formatting rule.
  26024. Excel allows to create up to 3 Conditional Formatting rules.
  26025. @param cfRule - Conditional Formatting rule
  26026. </member>
  26027. <member name="M:NPOI.SS.UserModel.IConditionalFormatting.GetRule(System.Int32)">
  26028. @return the Conditional Formatting rule at position idx.
  26029. </member>
  26030. <member name="P:NPOI.SS.UserModel.IConditionalFormatting.NumberOfRules">
  26031. @return number of Conditional Formatting rules.
  26032. </member>
  26033. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.Record.Aggregates.CFRecordsAggregate)">
  26034. <summary>
  26035. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFConditionalFormatting"/> class.
  26036. </summary>
  26037. <param name="workbook">The workbook.</param>
  26038. <param name="cfAggregate">The cf aggregate.</param>
  26039. </member>
  26040. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.GetFormattingRegions">
  26041. <summary>
  26042. Gets the array of Regions
  26043. </summary>
  26044. <returns></returns>
  26045. </member>
  26046. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.GetFormattingRanges">
  26047. <summary>
  26048. Gets array of CellRangeAddresses
  26049. </summary>
  26050. <returns></returns>
  26051. </member>
  26052. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.SetRule(System.Int32,NPOI.HSSF.UserModel.HSSFConditionalFormattingRule)">
  26053. <summary>
  26054. Replaces an existing Conditional Formatting rule at position idx.
  26055. Excel allows to Create up to 3 Conditional Formatting rules.
  26056. This method can be useful to modify existing Conditional Formatting rules.
  26057. </summary>
  26058. <param name="idx">position of the rule. Should be between 0 and 2.</param>
  26059. <param name="cfRule">Conditional Formatting rule</param>
  26060. </member>
  26061. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.AddRule(NPOI.HSSF.UserModel.HSSFConditionalFormattingRule)">
  26062. <summary>
  26063. Add a Conditional Formatting rule.
  26064. Excel allows to Create up to 3 Conditional Formatting rules.
  26065. </summary>
  26066. <param name="cfRule">Conditional Formatting rule</param>
  26067. </member>
  26068. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.GetRule(System.Int32)">
  26069. <summary>
  26070. Gets the Conditional Formatting rule at position idx
  26071. </summary>
  26072. <param name="idx">The index.</param>
  26073. <returns></returns>
  26074. </member>
  26075. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.ToString">
  26076. <summary>
  26077. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  26078. </summary>
  26079. <returns>
  26080. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  26081. </returns>
  26082. </member>
  26083. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormatting.CFRecordsAggregate">
  26084. <summary>
  26085. Gets the CF records aggregate.
  26086. </summary>
  26087. <returns></returns>
  26088. </member>
  26089. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormatting.NumberOfRules">
  26090. <summary>
  26091. Gets the number of Conditional Formatting rules.
  26092. </summary>
  26093. <value>The number of rules.</value>
  26094. </member>
  26095. <member name="T:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule">
  26096. High level representation of Conditional Formatting Rule.
  26097. It allows to specify formula based conditions for the Conditional Formatting
  26098. and the formatting Settings such as font, border and pattern.
  26099. @author Dmitriy Kumshayev
  26100. </member>
  26101. <member name="T:NPOI.SS.UserModel.IConditionalFormattingRule">
  26102. Represents a description of a conditional formatting rule
  26103. @author Dmitriy Kumshayev
  26104. @author Yegor Kozlov
  26105. </member>
  26106. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.CreateBorderFormatting">
  26107. Create a new border formatting structure if it does not exist,
  26108. otherwise just return existing object.
  26109. @return - border formatting object, never returns <code>null</code>.
  26110. </member>
  26111. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.GetBorderFormatting">
  26112. @return - border formatting object if defined, <code>null</code> otherwise
  26113. </member>
  26114. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.CreateFontFormatting">
  26115. Create a new font formatting structure if it does not exist,
  26116. otherwise just return existing object.
  26117. @return - font formatting object, never returns <code>null</code>.
  26118. </member>
  26119. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.GetFontFormatting">
  26120. @return - font formatting object if defined, <code>null</code> otherwise
  26121. </member>
  26122. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.CreatePatternFormatting">
  26123. Create a new pattern formatting structure if it does not exist,
  26124. otherwise just return existing object.
  26125. @return - pattern formatting object, never returns <code>null</code>.
  26126. </member>
  26127. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.GetPatternFormatting">
  26128. @return - pattern formatting object if defined, <code>null</code> otherwise
  26129. </member>
  26130. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.ConditionType">
  26131. Type of conditional formatting rule.
  26132. <p>
  26133. MUST be either {@link #CONDITION_TYPE_CELL_VALUE_IS} or {@link #CONDITION_TYPE_FORMULA}
  26134. </p>
  26135. @return the type of condition
  26136. </member>
  26137. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.ComparisonOperation">
  26138. The comparison function used when the type of conditional formatting is Set to
  26139. {@link #CONDITION_TYPE_CELL_VALUE_IS}
  26140. <p>
  26141. MUST be a constant from {@link ComparisonOperator}
  26142. </p>
  26143. @return the conditional format operator
  26144. </member>
  26145. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.Formula1">
  26146. The formula used to Evaluate the first operand for the conditional formatting rule.
  26147. <p>
  26148. If the condition type is {@link #CONDITION_TYPE_CELL_VALUE_IS},
  26149. this field is the first operand of the comparison.
  26150. If type is {@link #CONDITION_TYPE_FORMULA}, this formula is used
  26151. to determine if the conditional formatting is applied.
  26152. </p>
  26153. <p>
  26154. If comparison type is {@link #CONDITION_TYPE_FORMULA} the formula MUST be a Boolean function
  26155. </p>
  26156. @return the first formula
  26157. </member>
  26158. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.Formula2">
  26159. The formula used to Evaluate the second operand of the comparison when
  26160. comparison type is {@link #CONDITION_TYPE_CELL_VALUE_IS} and operator
  26161. is either {@link ComparisonOperator#BETWEEN} or {@link ComparisonOperator#NOT_BETWEEN}
  26162. @return the second formula
  26163. </member>
  26164. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.GetFontFormatting">
  26165. @return - font formatting object if defined, <c>null</c> otherwise
  26166. </member>
  26167. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreateFontFormatting">
  26168. Create a new font formatting structure if it does not exist,
  26169. otherwise just return existing object.
  26170. @return - font formatting object, never returns <c>null</c>.
  26171. </member>
  26172. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.GetBorderFormatting">
  26173. @return - border formatting object if defined, <c>null</c> otherwise
  26174. </member>
  26175. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreateBorderFormatting">
  26176. Create a new border formatting structure if it does not exist,
  26177. otherwise just return existing object.
  26178. @return - border formatting object, never returns <c>null</c>.
  26179. </member>
  26180. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.GetPatternFormatting">
  26181. @return - pattern formatting object if defined, <c>null</c> otherwise
  26182. </member>
  26183. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreatePatternFormatting">
  26184. Create a new pattern formatting structure if it does not exist,
  26185. otherwise just return existing object.
  26186. @return - pattern formatting object, never returns <c>null</c>.
  26187. </member>
  26188. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.ConditionType">
  26189. @return - the conditiontype for the cfrule
  26190. </member>
  26191. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.ComparisonOperation">
  26192. @return - the comparisionoperatation for the cfrule
  26193. </member>
  26194. <member name="T:NPOI.SS.UserModel.ICreationHelper">
  26195. An object that handles instantiating concrete
  26196. classes of the various instances one needs for
  26197. HSSF and XSSF.
  26198. Works around a major shortcoming in Java, where we
  26199. can't have static methods on interfaces or abstract
  26200. classes.
  26201. This allows you to get the appropriate class for
  26202. a given interface, without you having to worry
  26203. about if you're dealing with HSSF or XSSF, despite
  26204. Java being quite rubbish.
  26205. </member>
  26206. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateRichTextString(System.String)">
  26207. Creates a new RichTextString instance
  26208. @param text The text to Initialise the RichTextString with
  26209. </member>
  26210. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateDataFormat">
  26211. Creates a new DataFormat instance
  26212. </member>
  26213. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateHyperlink(NPOI.SS.UserModel.HyperlinkType)">
  26214. Creates a new Hyperlink, of the given type
  26215. </member>
  26216. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateFormulaEvaluator">
  26217. Creates FormulaEvaluator - an object that Evaluates formula cells.
  26218. @return a FormulaEvaluator instance
  26219. </member>
  26220. <member name="M:NPOI.HSSF.UserModel.HSSFCreationHelper.CreateFormulaEvaluator">
  26221. Creates a HSSFFormulaEvaluator, the object that Evaluates formula cells.
  26222. @return a HSSFFormulaEvaluator instance
  26223. </member>
  26224. <member name="M:NPOI.HSSF.UserModel.HSSFCreationHelper.CreateClientAnchor">
  26225. Creates a HSSFClientAnchor. Use this object to position drawing object in a sheet
  26226. @return a HSSFClientAnchor instance
  26227. @see NPOI.SS.usermodel.Drawing
  26228. </member>
  26229. <member name="M:NPOI.SS.UserModel.IDataFormat.GetFormat(System.String)">
  26230. get the format index that matches the given format string.
  26231. Creates a new format if one is not found. Aliases text to the proper format.
  26232. @param format string matching a built in format
  26233. @return index of format.
  26234. </member>
  26235. <member name="M:NPOI.SS.UserModel.IDataFormat.GetFormat(System.Int16)">
  26236. get the format string that matches the given format index
  26237. @param index of a format
  26238. @return string represented at index of format or null if there is not a format at that index
  26239. </member>
  26240. <member name="F:NPOI.HSSF.UserModel.HSSFDataFormat.FIRST_USER_DEFINED_FORMAT_INDEX">
  26241. The first user-defined format starts at 164.
  26242. </member>
  26243. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.#ctor(NPOI.HSSF.Model.InternalWorkbook)">
  26244. <summary>
  26245. Construncts a new data formatter. It takes a workbook to have
  26246. access to the workbooks format records.
  26247. </summary>
  26248. <param name="workbook">the workbook the formats are tied to.</param>
  26249. </member>
  26250. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.GetBuiltinFormat(System.String)">
  26251. <summary>
  26252. Get the format index that matches the given format string
  26253. Automatically Converts "text" to excel's format string to represent text.
  26254. </summary>
  26255. <param name="format">The format string matching a built in format.</param>
  26256. <returns>index of format or -1 if Undefined.</returns>
  26257. </member>
  26258. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.GetFormat(System.String)">
  26259. <summary>
  26260. Get the format index that matches the given format
  26261. string, creating a new format entry if required.
  26262. Aliases text to the proper format as required.
  26263. </summary>
  26264. <param name="pFormat">The format string matching a built in format.</param>
  26265. <returns>index of format.</returns>
  26266. </member>
  26267. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.GetFormat(System.Int16)">
  26268. <summary>
  26269. Get the format string that matches the given format index
  26270. </summary>
  26271. <param name="index">The index of a format.</param>
  26272. <returns>string represented at index of format or null if there Is not a format at that index</returns>
  26273. </member>
  26274. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.GetBuiltinFormat(System.Int16)">
  26275. <summary>
  26276. Get the format string that matches the given format index
  26277. </summary>
  26278. <param name="index">The index of a built in format.</param>
  26279. <returns>string represented at index of format or null if there Is not a builtin format at that index</returns>
  26280. </member>
  26281. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.EnsureFormatsSize(System.Int32)">
  26282. Ensures that the formats list can hold entries
  26283. up to and including the entry with this index
  26284. </member>
  26285. <member name="P:NPOI.HSSF.UserModel.HSSFDataFormat.NumberOfBuiltinBuiltinFormats">
  26286. <summary>
  26287. Get the number of builtin and reserved builtinFormats
  26288. </summary>
  26289. <returns>number of builtin and reserved builtinFormats</returns>
  26290. </member>
  26291. <member name="T:NPOI.HSSF.UserModel.HSSFEvaluationCell">
  26292. <summary>
  26293. HSSF wrapper for a cell under evaluation
  26294. @author Josh Micich
  26295. </summary>
  26296. </member>
  26297. <member name="T:NPOI.HSSF.UserModel.HSSFEvaluationSheet">
  26298. HSSF wrapper for a sheet under evaluation
  26299. @author Josh Micich
  26300. </member>
  26301. <member name="T:NPOI.HSSF.UserModel.HSSFEvaluationWorkbook">
  26302. Internal POI use only
  26303. @author Josh Micich
  26304. </member>
  26305. <member name="T:NPOI.SS.Formula.IFormulaRenderingWorkbook">
  26306. Abstracts a workbook for the purpose of converting formula To text.<br/>
  26307. For POI internal use only
  26308. @author Josh Micich
  26309. </member>
  26310. <member name="M:NPOI.SS.Formula.IFormulaRenderingWorkbook.GetExternalSheet(System.Int32)">
  26311. @return <c>null</c> if externSheetIndex refers To a sheet inside the current workbook
  26312. </member>
  26313. <member name="M:NPOI.SS.Formula.IFormulaRenderingWorkbook.GetSheetFirstNameByExternSheet(System.Int32)">
  26314. @return the name of the (first) sheet referred to by the given external sheet index
  26315. </member>
  26316. <member name="M:NPOI.SS.Formula.IFormulaRenderingWorkbook.GetSheetLastNameByExternSheet(System.Int32)">
  26317. @return the name of the (last) sheet referred to by the given external sheet index
  26318. </member>
  26319. <member name="T:NPOI.SS.Formula.IFormulaParsingWorkbook">
  26320. Abstracts a workbook for the purpose of formula parsing.<br/>
  26321. For POI internal use only
  26322. @author Josh Micich
  26323. </member>
  26324. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetName(System.String,System.Int32)">
  26325. <summary>
  26326. named range name matching is case insensitive
  26327. </summary>
  26328. <param name="name">The name.</param>
  26329. <param name="sheetIndex">Index of the sheet.</param>
  26330. <returns></returns>
  26331. </member>
  26332. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetNameXPtg(System.String,NPOI.SS.Formula.SheetIdentifier)">
  26333. <summary>
  26334. Gets the name XPTG.
  26335. </summary>
  26336. <param name="name">The name.</param>
  26337. <param name="sheet"></param>
  26338. <returns></returns>
  26339. </member>
  26340. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.Get3DReferencePtg(NPOI.SS.Util.CellReference,NPOI.SS.Formula.SheetIdentifier)">
  26341. <summary>
  26342. Produce the appropriate Ptg for a 3d cell reference
  26343. </summary>
  26344. <param name="cell"></param>
  26345. <param name="sheet"></param>
  26346. <returns></returns>
  26347. </member>
  26348. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.Get3DReferencePtg(NPOI.SS.Util.AreaReference,NPOI.SS.Formula.SheetIdentifier)">
  26349. <summary>
  26350. Produce the appropriate Ptg for a 3d area reference
  26351. </summary>
  26352. <param name="area"></param>
  26353. <param name="sheet"></param>
  26354. <returns></returns>
  26355. </member>
  26356. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetExternalSheetIndex(System.String)">
  26357. <summary>
  26358. Gets the externSheet index for a sheet from this workbook
  26359. </summary>
  26360. <param name="sheetName">Name of the sheet.</param>
  26361. <returns></returns>
  26362. </member>
  26363. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetExternalSheetIndex(System.String,System.String)">
  26364. <summary>
  26365. Gets the externSheet index for a sheet from an external workbook
  26366. </summary>
  26367. <param name="workbookName">Name of the workbook, e.g. "BudGet.xls"</param>
  26368. <param name="sheetName">a name of a sheet in that workbook</param>
  26369. <returns></returns>
  26370. </member>
  26371. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetSpreadsheetVersion">
  26372. <summary>
  26373. Returns an enum holding spReadhseet properties specific to an Excel version (
  26374. max column and row numbers, max arguments to a function, etc.)
  26375. </summary>
  26376. <returns></returns>
  26377. </member>
  26378. <member name="T:NPOI.SS.Formula.IEvaluationName">
  26379. Abstracts a name record for formula evaluation.<br/>
  26380. For POI internal use only
  26381. @author Josh Micich
  26382. </member>
  26383. <member name="T:NPOI.HSSF.UserModel.HSSFFont">
  26384. <summary>
  26385. Represents a Font used in a workbook.
  26386. @version 1.0-pre
  26387. @author Andrew C. Oliver
  26388. </summary>
  26389. </member>
  26390. <member name="P:NPOI.SS.UserModel.IFont.FontName">
  26391. get the name for the font (i.e. Arial)
  26392. @return String representing the name of the font to use
  26393. </member>
  26394. <member name="P:NPOI.SS.UserModel.IFont.FontHeight">
  26395. get the font height in unit's of 1/20th of a point. Maybe you might want to
  26396. use the GetFontHeightInPoints which matches to the familiar 10, 12, 14 etc..
  26397. @return short - height in 1/20ths of a point
  26398. @see #GetFontHeightInPoints()
  26399. </member>
  26400. <member name="P:NPOI.SS.UserModel.IFont.FontHeightInPoints">
  26401. get the font height
  26402. @return short - height in the familiar unit of measure - points
  26403. @see #GetFontHeight()
  26404. </member>
  26405. <member name="P:NPOI.SS.UserModel.IFont.IsItalic">
  26406. get whether to use italics or not
  26407. @return italics or not
  26408. </member>
  26409. <member name="P:NPOI.SS.UserModel.IFont.IsStrikeout">
  26410. get whether to use a strikeout horizontal line through the text or not
  26411. @return strikeout or not
  26412. </member>
  26413. <member name="P:NPOI.SS.UserModel.IFont.Color">
  26414. get the color for the font
  26415. @return color to use
  26416. @see #COLOR_NORMAL
  26417. @see #COLOR_RED
  26418. @see NPOI.HSSF.usermodel.HSSFPalette#GetColor(short)
  26419. </member>
  26420. <member name="P:NPOI.SS.UserModel.IFont.TypeOffset">
  26421. get normal,super or subscript.
  26422. @return offset type to use (none,super,sub)
  26423. </member>
  26424. <member name="P:NPOI.SS.UserModel.IFont.Underline">
  26425. get type of text underlining to use
  26426. @return underlining type
  26427. </member>
  26428. <member name="P:NPOI.SS.UserModel.IFont.Charset">
  26429. get character-set to use.
  26430. @return character-set
  26431. @see #ANSI_CHARSET
  26432. @see #DEFAULT_CHARSET
  26433. @see #SYMBOL_CHARSET
  26434. </member>
  26435. <member name="P:NPOI.SS.UserModel.IFont.Index">
  26436. get the index within the XSSFWorkbook (sequence within the collection of Font objects)
  26437. @return unique index number of the underlying record this Font represents (probably you don't care
  26438. unless you're comparing which one is which)
  26439. </member>
  26440. <member name="M:NPOI.HSSF.UserModel.HSSFFont.#ctor(System.Int16,NPOI.HSSF.Record.FontRecord)">
  26441. <summary>
  26442. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFFont"/> class.
  26443. </summary>
  26444. <param name="index">The index.</param>
  26445. <param name="rec">The record.</param>
  26446. </member>
  26447. <member name="M:NPOI.HSSF.UserModel.HSSFFont.GetHSSFColor(NPOI.HSSF.UserModel.HSSFWorkbook)">
  26448. <summary>
  26449. get the color value for the font
  26450. </summary>
  26451. <param name="wb">HSSFWorkbook</param>
  26452. <returns></returns>
  26453. </member>
  26454. <member name="M:NPOI.HSSF.UserModel.HSSFFont.ToString">
  26455. <summary>
  26456. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  26457. </summary>
  26458. <returns>
  26459. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  26460. </returns>
  26461. </member>
  26462. <member name="M:NPOI.HSSF.UserModel.HSSFFont.GetHashCode">
  26463. <summary>
  26464. Serves as a hash function for a particular type.
  26465. </summary>
  26466. <returns>
  26467. A hash code for the current <see cref="T:System.Object"/>.
  26468. </returns>
  26469. </member>
  26470. <member name="M:NPOI.HSSF.UserModel.HSSFFont.Equals(System.Object)">
  26471. <summary>
  26472. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  26473. </summary>
  26474. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
  26475. <returns>
  26476. true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
  26477. </returns>
  26478. <exception cref="T:System.NullReferenceException">
  26479. The <paramref name="obj"/> parameter is null.
  26480. </exception>
  26481. </member>
  26482. <member name="P:NPOI.HSSF.UserModel.HSSFFont.FontName">
  26483. <summary>
  26484. Get the name for the font (i.e. Arial)
  26485. </summary>
  26486. <value>the name of the font to use</value>
  26487. </member>
  26488. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Index">
  26489. <summary>
  26490. Get the index within the HSSFWorkbook (sequence within the collection of Font objects)
  26491. </summary>
  26492. <value>Unique index number of the Underlying record this Font represents (probably you don't care
  26493. Unless you're comparing which one is which)</value>
  26494. </member>
  26495. <member name="P:NPOI.HSSF.UserModel.HSSFFont.FontHeight">
  26496. <summary>
  26497. Get or sets the font height in Unit's of 1/20th of a point. Maybe you might want to
  26498. use the GetFontHeightInPoints which matches to the familiar 10, 12, 14 etc..
  26499. </summary>
  26500. <value>height in 1/20ths of a point.</value>
  26501. </member>
  26502. <member name="P:NPOI.HSSF.UserModel.HSSFFont.FontHeightInPoints">
  26503. <summary>
  26504. Gets or sets the font height in points.
  26505. </summary>
  26506. <value>height in the familiar Unit of measure - points.</value>
  26507. </member>
  26508. <member name="P:NPOI.HSSF.UserModel.HSSFFont.IsItalic">
  26509. <summary>
  26510. Gets or sets whether to use italics or not
  26511. </summary>
  26512. <value><c>true</c> if this instance is italic; otherwise, <c>false</c>.</value>
  26513. </member>
  26514. <member name="P:NPOI.HSSF.UserModel.HSSFFont.IsStrikeout">
  26515. <summary>
  26516. Get whether to use a strikeout horizontal line through the text or not
  26517. </summary>
  26518. <value>
  26519. strikeout or not
  26520. </value>
  26521. </member>
  26522. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Color">
  26523. <summary>
  26524. Gets or sets the color for the font.
  26525. </summary>
  26526. <value>The color to use.</value>
  26527. </member>
  26528. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Boldweight">
  26529. <summary>
  26530. Gets or sets the boldness to use
  26531. </summary>
  26532. <value>The boldweight.</value>
  26533. </member>
  26534. <member name="P:NPOI.HSSF.UserModel.HSSFFont.IsBold">
  26535. get or set if the font bold style
  26536. </member>
  26537. <member name="P:NPOI.HSSF.UserModel.HSSFFont.TypeOffset">
  26538. <summary>
  26539. Gets or sets normal,base or subscript.
  26540. </summary>
  26541. <value>offset type to use (none,base,sub)</value>
  26542. </member>
  26543. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Underline">
  26544. <summary>
  26545. Gets or sets the type of text Underlining to use
  26546. </summary>
  26547. <value>The Underlining type.</value>
  26548. </member>
  26549. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Charset">
  26550. <summary>
  26551. Gets or sets the char set to use.
  26552. </summary>
  26553. <value>The char set.</value>
  26554. </member>
  26555. <member name="T:NPOI.HSSF.UserModel.HSSFFontFormatting">
  26556. High level representation for Font Formatting component
  26557. of Conditional Formatting Settings
  26558. @author Dmitriy Kumshayev
  26559. </member>
  26560. <member name="T:NPOI.SS.UserModel.IFontFormatting">
  26561. High level representation for Font Formatting component
  26562. of Conditional Formatting Settings
  26563. @author Dmitriy Kumshayev
  26564. @author Yegor Kozlov
  26565. </member>
  26566. <member name="M:NPOI.SS.UserModel.IFontFormatting.SetFontStyle(System.Boolean,System.Boolean)">
  26567. Set font style options.
  26568. @param italic - if true, Set posture style to italic, otherwise to normal
  26569. @param bold if true, Set font weight to bold, otherwise to normal
  26570. </member>
  26571. <member name="M:NPOI.SS.UserModel.IFontFormatting.ResetFontStyle">
  26572. Set font style options to default values (non-italic, non-bold)
  26573. </member>
  26574. <member name="P:NPOI.SS.UserModel.IFontFormatting.EscapementType">
  26575. <summary>
  26576. get or set the type of super or subscript for the font
  26577. </summary>
  26578. </member>
  26579. <member name="P:NPOI.SS.UserModel.IFontFormatting.FontColorIndex">
  26580. <summary>
  26581. get or set font color index
  26582. </summary>
  26583. </member>
  26584. <member name="P:NPOI.SS.UserModel.IFontFormatting.FontHeight">
  26585. <summary>
  26586. get or set the height of the font in 1/20th point units
  26587. </summary>
  26588. </member>
  26589. <member name="P:NPOI.SS.UserModel.IFontFormatting.UnderlineType">
  26590. <summary>
  26591. get or set the type of underlining for the font
  26592. </summary>
  26593. </member>
  26594. <member name="P:NPOI.SS.UserModel.IFontFormatting.IsBold">
  26595. Get whether the font weight is Set to bold or not
  26596. @return bold - whether the font is bold or not
  26597. </member>
  26598. <member name="P:NPOI.SS.UserModel.IFontFormatting.IsItalic">
  26599. @return true if font style was Set to <i>italic</i>
  26600. </member>
  26601. <member name="M:NPOI.HSSF.UserModel.HSSFFontFormatting.GetRawRecord">
  26602. @return
  26603. @see org.apache.poi.hssf.record.cf.FontFormatting#GetRawRecord()
  26604. </member>
  26605. <member name="M:NPOI.HSSF.UserModel.HSSFFontFormatting.SetFontStyle(System.Boolean,System.Boolean)">
  26606. Set font style options.
  26607. @param italic - if true, Set posture style to italic, otherwise to normal
  26608. @param bold- if true, Set font weight to bold, otherwise to normal
  26609. </member>
  26610. <member name="M:NPOI.HSSF.UserModel.HSSFFontFormatting.ResetFontStyle">
  26611. Set font style options to default values (non-italic, non-bold)
  26612. </member>
  26613. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.EscapementType">
  26614. Get the type of base or subscript for the font
  26615. @return base or subscript option
  26616. </member>
  26617. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.FontColorIndex">
  26618. @return font color index
  26619. </member>
  26620. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.FontHeight">
  26621. Gets the height of the font in 1/20th point Units
  26622. @return fontheight (in points/20); or -1 if not modified
  26623. </member>
  26624. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.FontWeight">
  26625. Get the font weight for this font (100-1000dec or 0x64-0x3e8). Default Is
  26626. 0x190 for normal and 0x2bc for bold
  26627. @return bw - a number between 100-1000 for the fonts "boldness"
  26628. </member>
  26629. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.UnderlineType">
  26630. Get the type of Underlining for the font
  26631. @return font Underlining type
  26632. @see #U_NONE
  26633. @see #U_SINGLE
  26634. @see #U_DOUBLE
  26635. @see #U_SINGLE_ACCOUNTING
  26636. @see #U_DOUBLE_ACCOUNTING
  26637. </member>
  26638. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsBold">
  26639. Get whether the font weight Is Set to bold or not
  26640. @return bold - whether the font Is bold or not
  26641. </member>
  26642. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsEscapementTypeModified">
  26643. @return true if escapement type was modified from default
  26644. </member>
  26645. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontCancellationModified">
  26646. @return true if font cancellation was modified from default
  26647. </member>
  26648. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontOutlineModified">
  26649. @return true if font outline type was modified from default
  26650. </member>
  26651. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontShadowModified">
  26652. @return true if font shadow type was modified from default
  26653. </member>
  26654. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontStyleModified">
  26655. @return true if font style was modified from default
  26656. </member>
  26657. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsItalic">
  26658. @return true if font style was Set to <i>italic</i>
  26659. </member>
  26660. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsOutlineOn">
  26661. @return true if font outline Is on
  26662. </member>
  26663. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsShadowOn">
  26664. @return true if font shadow Is on
  26665. </member>
  26666. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsStrikeout">
  26667. @return true if font strikeout Is on
  26668. </member>
  26669. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsUnderlineTypeModified">
  26670. @return true if font Underline type was modified from default
  26671. </member>
  26672. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontWeightModified">
  26673. @return true if font weight was modified from default
  26674. </member>
  26675. <member name="T:NPOI.HSSF.UserModel.HSSFFooter">
  26676. <summary>
  26677. Class to Read and manipulate the footer.
  26678. The footer works by having a left, center, and right side. The total cannot
  26679. be more that 255 bytes long. One uses this class by Getting the HSSFFooter
  26680. from HSSFSheet and then Getting or Setting the left, center, and right side.
  26681. For special things (such as page numbers and date), one can use a the methods
  26682. that return the Chars used to represent these. One can also Change the
  26683. fonts by using similar methods.
  26684. @author Shawn Laubach (slaubach at apache dot org)
  26685. </summary>
  26686. </member>
  26687. <member name="T:NPOI.SS.UserModel.IFooter">
  26688. <summary>
  26689. Common defInition of a HSSF or XSSF page footer.
  26690. For a list of all the different fields that can be
  26691. placed into a footer, such as page number,
  26692. bold, underline etc, see
  26693. </summary>
  26694. </member>
  26695. <member name="M:NPOI.HSSF.UserModel.HSSFFooter.#ctor(NPOI.HSSF.Record.Aggregates.PageSettingsBlock)">
  26696. <summary>
  26697. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFFooter"/> class.
  26698. </summary>
  26699. <param name="psb">Footer record to create the footer with</param>
  26700. </member>
  26701. <member name="P:NPOI.HSSF.UserModel.HSSFFooter.RawText">
  26702. <summary>
  26703. Gets the raw footer.
  26704. </summary>
  26705. <value>The raw footer.</value>
  26706. </member>
  26707. <member name="T:NPOI.HSSF.UserModel.HSSFFormulaEvaluator">
  26708. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26709. </member>
  26710. <member name="T:NPOI.SS.UserModel.IFormulaEvaluator">
  26711. Evaluates formula cells.<p/>
  26712. For performance reasons, this class keeps a cache of all previously calculated intermediate
  26713. cell values. Be sure to call {@link #ClearAllCachedResultValues()} if any workbook cells are Changed between
  26714. calls to Evaluate~ methods on this class.
  26715. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26716. @author Josh Micich
  26717. </member>
  26718. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.ClearAllCachedResultValues">
  26719. Should be called whenever there are Changes to input cells in the Evaluated workbook.
  26720. Failure to call this method after changing cell values will cause incorrect behaviour
  26721. of the Evaluate~ methods of this class
  26722. </member>
  26723. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.NotifySetFormula(NPOI.SS.UserModel.ICell)">
  26724. Should be called to tell the cell value cache that the specified (value or formula) cell
  26725. has Changed.
  26726. Failure to call this method after changing cell values will cause incorrect behaviour
  26727. of the Evaluate~ methods of this class
  26728. </member>
  26729. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.NotifyDeleteCell(NPOI.SS.UserModel.ICell)">
  26730. Should be called to tell the cell value cache that the specified cell has just become a
  26731. formula cell, or the formula text has Changed
  26732. </member>
  26733. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.NotifyUpdateCell(NPOI.SS.UserModel.ICell)">
  26734. Should be called to tell the cell value cache that the specified (value or formula) cell
  26735. has changed.
  26736. Failure to call this method after changing cell values will cause incorrect behaviour
  26737. of the evaluate~ methods of this class
  26738. </member>
  26739. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.Evaluate(NPOI.SS.UserModel.ICell)">
  26740. If cell Contains a formula, the formula is Evaluated and returned,
  26741. else the CellValue simply copies the appropriate cell value from
  26742. the cell and also its cell type. This method should be preferred over
  26743. EvaluateInCell() when the call should not modify the contents of the
  26744. original cell.
  26745. @param cell
  26746. </member>
  26747. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.EvaluateAll">
  26748. Loops over all cells in all sheets of the associated workbook.
  26749. For cells that contain formulas, their formulas are evaluated,
  26750. and the results are saved. These cells remain as formula cells.
  26751. For cells that do not contain formulas, no changes are made.
  26752. This is a helpful wrapper around looping over all cells, and
  26753. calling evaluateFormulaCell on each one.
  26754. </member>
  26755. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.EvaluateFormulaCell(NPOI.SS.UserModel.ICell)">
  26756. If cell Contains formula, it Evaluates the formula,
  26757. and saves the result of the formula. The cell
  26758. remains as a formula cell.
  26759. Else if cell does not contain formula, this method leaves
  26760. the cell unChanged.
  26761. Note that the type of the formula result is returned,
  26762. so you know what kind of value is also stored with
  26763. the formula.
  26764. <pre>
  26765. int EvaluatedCellType = Evaluator.evaluateFormulaCell(cell);
  26766. </pre>
  26767. Be aware that your cell will hold both the formula,
  26768. and the result. If you want the cell Replaced with
  26769. the result of the formula, use {@link #EvaluateInCell(Cell)}
  26770. @param cell The cell to Evaluate
  26771. @return The type of the formula result, i.e. -1 if the cell is not a formula,
  26772. or one of Cell.CELL_TYPE_NUMERIC, Cell.CELL_TYPE_STRING, Cell.CELL_TYPE_BOOLEAN, Cell.CELL_TYPE_ERROR
  26773. Note: the cell's type remains as Cell.CELL_TYPE_FORMULA however.
  26774. </member>
  26775. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.EvaluateInCell(NPOI.SS.UserModel.ICell)">
  26776. If cell Contains formula, it Evaluates the formula, and
  26777. Puts the formula result back into the cell, in place
  26778. of the old formula.
  26779. Else if cell does not contain formula, this method leaves
  26780. the cell unChanged.
  26781. Note that the same instance of Cell is returned to
  26782. allow chained calls like:
  26783. <pre>
  26784. int EvaluatedCellType = Evaluator.evaluateInCell(cell).getCellType();
  26785. </pre>
  26786. Be aware that your cell value will be Changed to hold the
  26787. result of the formula. If you simply want the formula
  26788. value comPuted for you, use {@link #EvaluateFormulaCell(Cell)}
  26789. @param cell
  26790. </member>
  26791. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.SetupReferencedWorkbooks(System.Collections.Generic.Dictionary{System.String,NPOI.SS.UserModel.IFormulaEvaluator})">
  26792. Sets up the Formula Evaluator to be able to reference and resolve
  26793. links to other workbooks, eg [Test.xls]Sheet1!A1.
  26794. For a workbook referenced as [Test.xls]Sheet1!A1, you should
  26795. supply a map containing the key Test.xls (no square brackets),
  26796. and an open FormulaEvaluator onto that Workbook.
  26797. @param otherWorkbooks Map of workbook names (no square brackets) to an evaluator on that workbook
  26798. </member>
  26799. <member name="P:NPOI.SS.UserModel.IFormulaEvaluator.IgnoreMissingWorkbooks">
  26800. Whether to ignore missing references to external workbooks and
  26801. use cached formula results in the main workbook instead.
  26802. <br/>
  26803. In some cases external workbooks referenced by formulas in the main workbook are not available.
  26804. With this method you can control how POI handles such missing references:
  26805. <ul>
  26806. <li>by default ignoreMissingWorkbooks=false and POI throws
  26807. {@link org.apache.poi.ss.formula.CollaboratingWorkbooksEnvironment.WorkbookNotFoundException}
  26808. if an external reference cannot be resolved</li>
  26809. <li>if ignoreMissingWorkbooks=true then POI uses cached formula result
  26810. that already exists in the main workbook</li>
  26811. </ul>
  26812. @param ignore whether to ignore missing references to external workbooks
  26813. </member>
  26814. <member name="P:NPOI.SS.UserModel.IFormulaEvaluator.DebugEvaluationOutputForNextEval">
  26815. * Perform detailed output of formula evaluation for next evaluation only?
  26816. * Is for developer use only (also developers using POI for their XLS files).
  26817. * Log-Level WARN is for basic info, INFO for detailed information. These quite
  26818. * high levels are used because you have to explicitly enable this specific logging.
  26819. * @param value whether to perform detailed output
  26820. </member>
  26821. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.#ctor(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier)">
  26822. @param stabilityClassifier used to optimise caching performance. Pass <code>null</code>
  26823. for the (conservative) assumption that any cell may have its definition changed after
  26824. evaluation begins.
  26825. </member>
  26826. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.#ctor(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier,NPOI.SS.Formula.Udf.UDFFinder)">
  26827. @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
  26828. </member>
  26829. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.Create(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier,NPOI.SS.Formula.Udf.UDFFinder)">
  26830. @param stabilityClassifier used to optimise caching performance. Pass <code>null</code>
  26831. for the (conservative) assumption that any cell may have its definition changed after
  26832. evaluation begins.
  26833. @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
  26834. </member>
  26835. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.SetupEnvironment(System.String[],NPOI.HSSF.UserModel.HSSFFormulaEvaluator[])">
  26836. Coordinates several formula evaluators together so that formulas that involve external
  26837. references can be evaluated.
  26838. @param workbookNames the simple file names used to identify the workbooks in formulas
  26839. with external links (for example "MyData.xls" as used in a formula "[MyData.xls]Sheet1!A1")
  26840. @param evaluators all evaluators for the full set of workbooks required by the formulas.
  26841. </member>
  26842. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.Evaluate(NPOI.SS.UserModel.ICell)">
  26843. If cell Contains a formula, the formula is Evaluated and returned,
  26844. else the CellValue simply copies the appropriate cell value from
  26845. the cell and also its cell type. This method should be preferred over
  26846. EvaluateInCell() when the call should not modify the contents of the
  26847. original cell.
  26848. @param cell
  26849. If cell contains a formula, the formula is evaluated and returned,
  26850. else the CellValue simply copies the appropriate cell value from
  26851. the cell and also its cell type. This method should be preferred over
  26852. evaluateInCell() when the call should not modify the contents of the
  26853. original cell.
  26854. @param cell may be <c>null</c> signifying that the cell is not present (or blank)
  26855. @return <c>null</c> if the supplied cell is <c>null</c> or blank
  26856. </member>
  26857. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.ClearAllCachedResultValues">
  26858. Should be called whenever there are major changes (e.g. moving sheets) to input cells
  26859. in the evaluated workbook. If performance is not critical, a single call to this method
  26860. may be used instead of many specific calls to the notify~ methods.
  26861. Failure to call this method after changing cell values will cause incorrect behaviour
  26862. of the evaluate~ methods of this class
  26863. </member>
  26864. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.NotifyUpdateCell(NPOI.SS.UserModel.ICell)">
  26865. Should be called to tell the cell value cache that the specified (value or formula) cell
  26866. has changed.
  26867. Failure to call this method after changing cell values will cause incorrect behaviour
  26868. of the evaluate~ methods of this class
  26869. </member>
  26870. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.NotifyDeleteCell(NPOI.SS.UserModel.ICell)">
  26871. Should be called to tell the cell value cache that the specified cell has just been
  26872. deleted.
  26873. Failure to call this method after changing cell values will cause incorrect behaviour
  26874. of the evaluate~ methods of this class
  26875. </member>
  26876. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.NotifySetFormula(NPOI.SS.UserModel.ICell)">
  26877. Should be called to tell the cell value cache that the specified (value or formula) cell
  26878. has changed.
  26879. Failure to call this method after changing cell values will cause incorrect behaviour
  26880. of the evaluate~ methods of this class
  26881. </member>
  26882. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateFormulaCell(NPOI.SS.UserModel.ICell)">
  26883. If cell Contains formula, it Evaluates the formula,
  26884. and saves the result of the formula. The cell
  26885. remains as a formula cell.
  26886. Else if cell does not contain formula, this method leaves
  26887. the cell UnChanged.
  26888. Note that the type of the formula result is returned,
  26889. so you know what kind of value is also stored with
  26890. the formula.
  26891. <pre>
  26892. int EvaluatedCellType = evaluator.EvaluateFormulaCell(cell);
  26893. </pre>
  26894. Be aware that your cell will hold both the formula,
  26895. and the result. If you want the cell Replaced with
  26896. the result of the formula, use {@link #EvaluateInCell(HSSFCell)}
  26897. @param cell The cell to Evaluate
  26898. @return The type of the formula result (the cell's type remains as CellType.Formula however)
  26899. </member>
  26900. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateFormulaCellValue(NPOI.SS.UserModel.ICell)">
  26901. Returns a CellValue wrapper around the supplied ValueEval instance.
  26902. @param cell
  26903. </member>
  26904. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateInCell(NPOI.SS.UserModel.ICell)">
  26905. If cell Contains formula, it Evaluates the formula, and
  26906. puts the formula result back into the cell, in place
  26907. of the old formula.
  26908. Else if cell does not contain formula, this method leaves
  26909. the cell UnChanged.
  26910. Note that the same instance of Cell is returned to
  26911. allow chained calls like:
  26912. <pre>
  26913. int EvaluatedCellType = evaluator.EvaluateInCell(cell).CellType;
  26914. </pre>
  26915. Be aware that your cell value will be Changed to hold the
  26916. result of the formula. If you simply want the formula
  26917. value computed for you, use {@link #EvaluateFormulaCell(HSSFCell)}
  26918. @param cell
  26919. </member>
  26920. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateAllFormulaCells(NPOI.HSSF.UserModel.HSSFWorkbook)">
  26921. Loops over all cells in all sheets of the supplied
  26922. workbook.
  26923. For cells that contain formulas, their formulas are
  26924. Evaluated, and the results are saved. These cells
  26925. remain as formula cells.
  26926. For cells that do not contain formulas, no Changes
  26927. are made.
  26928. This is a helpful wrapper around looping over all
  26929. cells, and calling EvaluateFormulaCell on each one.
  26930. </member>
  26931. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateAllFormulaCells(NPOI.SS.UserModel.IWorkbook)">
  26932. Loops over all cells in all sheets of the supplied
  26933. workbook.
  26934. For cells that contain formulas, their formulas are
  26935. evaluated, and the results are saved. These cells
  26936. remain as formula cells.
  26937. For cells that do not contain formulas, no changes
  26938. are made.
  26939. This is a helpful wrapper around looping over all
  26940. cells, and calling evaluateFormulaCell on each one.
  26941. </member>
  26942. <member name="P:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.IgnoreMissingWorkbooks">
  26943. Whether to ignore missing references to external workbooks and
  26944. use cached formula results in the main workbook instead.
  26945. <p>
  26946. In some cases exetrnal workbooks referenced by formulas in the main workbook are not avaiable.
  26947. With this method you can control how POI handles such missing references:
  26948. <ul>
  26949. <li>by default ignoreMissingWorkbooks=false and POI throws {@link org.apache.poi.ss.formula.CollaboratingWorkbooksEnvironment.WorkbookNotFoundException}
  26950. if an external reference cannot be resolved</li>
  26951. <li>if ignoreMissingWorkbooks=true then POI uses cached formula result
  26952. that already exists in the main workbook</li>
  26953. </ul>
  26954. </p>
  26955. @param ignore whether to ignore missing references to external workbooks
  26956. </member>
  26957. <member name="P:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.DebugEvaluationOutputForNextEval">
  26958. {@inheritDoc}
  26959. </member>
  26960. <member name="T:NPOI.HSSF.UserModel.HSSFHeader">
  26961. <summary>
  26962. Class to Read and manipulate the header.
  26963. The header works by having a left, center, and right side. The total cannot
  26964. be more that 255 bytes long. One uses this class by Getting the HSSFHeader
  26965. from HSSFSheet and then Getting or Setting the left, center, and right side.
  26966. For special things (such as page numbers and date), one can use a the methods
  26967. that return the Chars used to represent these. One can also Change the
  26968. fonts by using similar methods.
  26969. @author Shawn Laubach (slaubach at apache dot org)
  26970. </summary>
  26971. </member>
  26972. <member name="T:NPOI.SS.UserModel.IHeader">
  26973. <summary>
  26974. Common defInition of a HSSF or XSSF page header.
  26975. For a list of all the different fields that can be
  26976. placed into a header, such as page number,
  26977. bold, underline etc, see
  26978. </summary>
  26979. </member>
  26980. <member name="M:NPOI.HSSF.UserModel.HSSFHeader.#ctor(NPOI.HSSF.Record.Aggregates.PageSettingsBlock)">
  26981. <summary>
  26982. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFFooter"/> class.
  26983. </summary>
  26984. <param name="psb">Footer record to Create the footer with</param>
  26985. </member>
  26986. <member name="P:NPOI.HSSF.UserModel.HSSFHeader.RawText">
  26987. <summary>
  26988. Gets the raw footer.
  26989. </summary>
  26990. <value>The raw footer.</value>
  26991. </member>
  26992. <member name="T:NPOI.HSSF.UserModel.HSSFHyperlink">
  26993. <summary>
  26994. Represents an Excel hyperlink.
  26995. </summary>
  26996. <remarks>@author Yegor Kozlov (yegor at apache dot org)</remarks>
  26997. </member>
  26998. <member name="T:NPOI.SS.UserModel.IHyperlink">
  26999. <summary>
  27000. Represents an Excel hyperlink.
  27001. </summary>
  27002. </member>
  27003. <member name="P:NPOI.SS.UserModel.IHyperlink.Address">
  27004. <summary>
  27005. Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
  27006. </summary>
  27007. </member>
  27008. <member name="P:NPOI.SS.UserModel.IHyperlink.Label">
  27009. <summary>
  27010. text label for this hyperlink
  27011. </summary>
  27012. </member>
  27013. <member name="P:NPOI.SS.UserModel.IHyperlink.Type">
  27014. <summary>
  27015. the type of this hyperlink
  27016. </summary>
  27017. </member>
  27018. <member name="P:NPOI.SS.UserModel.IHyperlink.FirstRow">
  27019. <summary>
  27020. the row of the first cell that Contains the hyperlink
  27021. </summary>
  27022. </member>
  27023. <member name="P:NPOI.SS.UserModel.IHyperlink.LastRow">
  27024. <summary>
  27025. the row of the last cell that Contains the hyperlink
  27026. </summary>
  27027. </member>
  27028. <member name="P:NPOI.SS.UserModel.IHyperlink.FirstColumn">
  27029. <summary>
  27030. the column of the first cell that Contains the hyperlink
  27031. </summary>
  27032. </member>
  27033. <member name="P:NPOI.SS.UserModel.IHyperlink.LastColumn">
  27034. <summary>
  27035. the column of the last cell that Contains the hyperlink
  27036. </summary>
  27037. </member>
  27038. <member name="F:NPOI.HSSF.UserModel.HSSFHyperlink.record">
  27039. Low-level record object that stores the actual hyperlink data
  27040. </member>
  27041. <member name="F:NPOI.HSSF.UserModel.HSSFHyperlink.link_type">
  27042. If we Create a new hypelrink remember its type
  27043. </member>
  27044. <member name="M:NPOI.HSSF.UserModel.HSSFHyperlink.#ctor(NPOI.SS.UserModel.HyperlinkType)">
  27045. <summary>
  27046. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFHyperlink"/> class.
  27047. </summary>
  27048. <param name="type">The type of hyperlink to Create.</param>
  27049. </member>
  27050. <member name="M:NPOI.HSSF.UserModel.HSSFHyperlink.#ctor(NPOI.HSSF.Record.HyperlinkRecord)">
  27051. <summary>
  27052. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFHyperlink"/> class.
  27053. </summary>
  27054. <param name="record">The record.</param>
  27055. </member>
  27056. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.FirstRow">
  27057. <summary>
  27058. Gets or sets the row of the first cell that Contains the hyperlink
  27059. </summary>
  27060. <value>the 0-based row of the cell that Contains the hyperlink.</value>
  27061. </member>
  27062. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.LastRow">
  27063. <summary>
  27064. Gets or sets the row of the last cell that Contains the hyperlink
  27065. </summary>
  27066. <value>the 0-based row of the last cell that Contains the hyperlink</value>
  27067. </member>
  27068. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.FirstColumn">
  27069. <summary>
  27070. Gets or sets the column of the first cell that Contains the hyperlink
  27071. </summary>
  27072. <value>the 0-based column of the first cell that Contains the hyperlink</value>
  27073. </member>
  27074. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.LastColumn">
  27075. <summary>
  27076. Gets or sets the column of the last cell that Contains the hyperlink
  27077. </summary>
  27078. <value>the 0-based column of the last cell that Contains the hyperlink</value>
  27079. </member>
  27080. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.Address">
  27081. <summary>
  27082. Gets or sets Hypelink Address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
  27083. </summary>
  27084. <value>the Address of this hyperlink</value>
  27085. </member>
  27086. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.TextMark">
  27087. <summary>
  27088. Gets or sets the text mark.
  27089. </summary>
  27090. <value>The text mark.</value>
  27091. </member>
  27092. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.ShortFilename">
  27093. <summary>
  27094. Gets or sets the short filename.
  27095. </summary>
  27096. <value>The short filename.</value>
  27097. </member>
  27098. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.Label">
  27099. <summary>
  27100. Gets or sets the text label for this hyperlink
  27101. </summary>
  27102. <value>text to Display</value>
  27103. </member>
  27104. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.Type">
  27105. <summary>
  27106. Gets the type of this hyperlink
  27107. </summary>
  27108. <value>the type of this hyperlink</value>
  27109. </member>
  27110. <member name="T:NPOI.HSSF.UserModel.HSSFName">
  27111. <summary>
  27112. High Level Represantion of Named Range
  27113. </summary>
  27114. <remarks>@author Libin Roman (Vista Portal LDT. Developer)</remarks>
  27115. </member>
  27116. <member name="T:NPOI.SS.UserModel.IName">
  27117. Represents a defined name for a range of cells.
  27118. A name is a meaningful shorthand that makes it easier to understand the purpose of a
  27119. cell reference, constant or a formula.
  27120. </member>
  27121. <member name="M:NPOI.SS.UserModel.IName.SetFunction(System.Boolean)">
  27122. Indicates that the defined name refers to a user-defined function.
  27123. This attribute is used when there is an add-in or other code project associated with the file.
  27124. @param value <c>true</c> indicates the name refers to a function.
  27125. </member>
  27126. <member name="P:NPOI.SS.UserModel.IName.SheetName">
  27127. Get the sheets name which this named range is referenced to
  27128. @return sheet name, which this named range refered to
  27129. </member>
  27130. <member name="P:NPOI.SS.UserModel.IName.NameName">
  27131. Gets the name of the named range
  27132. @return named range name
  27133. </member>
  27134. <member name="P:NPOI.SS.UserModel.IName.RefersToFormula">
  27135. Returns the formula that the name is defined to refer to.
  27136. @return the reference for this name, <code>null</code> if it has not been set yet. Never empty string
  27137. @see #SetRefersToFormula(String)
  27138. </member>
  27139. <member name="P:NPOI.SS.UserModel.IName.IsFunctionName">
  27140. Checks if this name is a function name
  27141. @return true if this name is a function name
  27142. </member>
  27143. <member name="P:NPOI.SS.UserModel.IName.IsDeleted">
  27144. Checks if this name points to a cell that no longer exists
  27145. @return <c>true</c> if the name refers to a deleted cell, <c>false</c> otherwise
  27146. </member>
  27147. <member name="P:NPOI.SS.UserModel.IName.SheetIndex">
  27148. Returns the sheet index this name applies to.
  27149. @return the sheet index this name applies to, -1 if this name applies to the entire workbook
  27150. </member>
  27151. <member name="P:NPOI.SS.UserModel.IName.Comment">
  27152. Returns the comment the user provided when the name was Created.
  27153. @return the user comment for this named range
  27154. </member>
  27155. <member name="M:NPOI.HSSF.UserModel.HSSFName.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.Record.NameRecord,NPOI.HSSF.Record.NameCommentRecord)">
  27156. <summary>
  27157. Creates new HSSFName - called by HSSFWorkbook to Create a sheet from
  27158. scratch.
  27159. </summary>
  27160. <param name="book">lowlevel Workbook object associated with the sheet.</param>
  27161. <param name="name">the Name Record</param>
  27162. <param name="comment"></param>
  27163. </member>
  27164. <member name="M:NPOI.HSSF.UserModel.HSSFName.SetNameDefinition(NPOI.SS.Formula.PTG.Ptg[])">
  27165. <summary>
  27166. Sets the NameParsedFormula structure that specifies the formula for the defined name.
  27167. </summary>
  27168. <param name="ptgs">the sequence of {@link Ptg}s for the formula.</param>
  27169. </member>
  27170. <member name="M:NPOI.HSSF.UserModel.HSSFName.SetFunction(System.Boolean)">
  27171. Indicates that the defined name refers to a user-defined function.
  27172. This attribute is used when there is an add-in or other code project associated with the file.
  27173. @param value <c>true</c> indicates the name refers to a function.
  27174. </member>
  27175. <member name="M:NPOI.HSSF.UserModel.HSSFName.ToString">
  27176. <summary>
  27177. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  27178. </summary>
  27179. <returns>
  27180. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  27181. </returns>
  27182. </member>
  27183. <member name="P:NPOI.HSSF.UserModel.HSSFName.SheetName">
  27184. <summary>
  27185. Gets or sets the sheets name which this named range is referenced to
  27186. </summary>
  27187. <value>sheet name, which this named range refered to</value>
  27188. </member>
  27189. <member name="P:NPOI.HSSF.UserModel.HSSFName.NameName">
  27190. <summary>
  27191. Gets or sets the name of the named range
  27192. </summary>
  27193. <value>named range name</value>
  27194. </member>
  27195. <member name="P:NPOI.HSSF.UserModel.HSSFName.SheetIndex">
  27196. Returns the sheet index this name applies to.
  27197. @return the sheet index this name applies to, -1 if this name applies to the entire workbook
  27198. </member>
  27199. <member name="P:NPOI.HSSF.UserModel.HSSFName.IsDeleted">
  27200. <summary>
  27201. Tests if this name points to a cell that no longer exists
  27202. </summary>
  27203. <value>
  27204. <c>true</c> if the name refers to a deleted cell; otherwise, <c>false</c>.
  27205. </value>
  27206. </member>
  27207. <member name="P:NPOI.HSSF.UserModel.HSSFName.IsFunctionName">
  27208. <summary>
  27209. Gets a value indicating whether this instance is function name.
  27210. </summary>
  27211. <value>
  27212. <c>true</c> if this instance is function name; otherwise, <c>false</c>.
  27213. </value>
  27214. </member>
  27215. <member name="T:NPOI.HSSF.UserModel.HSSFObjectData">
  27216. Represents binary object (i.e. OLE) data stored in the file. Eg. A GIF, JPEG etc...
  27217. @author Daniel Noll
  27218. </member>
  27219. <member name="T:NPOI.HSSF.UserModel.HSSFPicture">
  27220. <summary>
  27221. Represents a escher picture. Eg. A GIF, JPEG etc...
  27222. @author Glen Stampoultzis
  27223. @author Yegor Kozlov (yegor at apache.org)
  27224. </summary>
  27225. </member>
  27226. <member name="T:NPOI.SS.UserModel.IPicture">
  27227. Repersents a picture in a SpreadsheetML document
  27228. @author Yegor Kozlov
  27229. </member>
  27230. <member name="M:NPOI.SS.UserModel.IPicture.Resize">
  27231. Reset the image to the dimension of the embedded image
  27232. @see #resize(double, double)
  27233. </member>
  27234. <member name="M:NPOI.SS.UserModel.IPicture.Resize(System.Double)">
  27235. Resize the image proportionally.
  27236. </member>
  27237. <member name="M:NPOI.SS.UserModel.IPicture.Resize(System.Double,System.Double)">
  27238. Resize the image.
  27239. <p>
  27240. Please note, that this method works correctly only for workbooks
  27241. with the default font size (Arial 10pt for .xls and Calibri 11pt for .xlsx).
  27242. If the default font is changed the resized image can be streched vertically or horizontally.
  27243. </p>
  27244. <p>
  27245. <code>resize(1.0,1.0)</code> keeps the original size,<br/>
  27246. <code>resize(0.5,0.5)</code> resize to 50% of the original,<br/>
  27247. <code>resize(2.0,2.0)</code> resizes to 200% of the original.<br/>
  27248. <code>resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE})</code> resizes to the dimension of the embedded image.
  27249. </p>
  27250. @param scaleX the amount by which the image width is multiplied relative to the original width.
  27251. @param scaleY the amount by which the image height is multiplied relative to the original height.
  27252. </member>
  27253. <member name="M:NPOI.SS.UserModel.IPicture.GetPreferredSize">
  27254. Calculate the preferred size for this picture.
  27255. @return XSSFClientAnchor with the preferred size for this image
  27256. </member>
  27257. <member name="M:NPOI.SS.UserModel.IPicture.GetPreferredSize(System.Double,System.Double)">
  27258. Calculate the preferred size for this picture.
  27259. @param scaleX the amount by which image width is multiplied relative to the original width.
  27260. @param scaleY the amount by which image height is multiplied relative to the original height.
  27261. @return ClientAnchor with the preferred size for this image
  27262. </member>
  27263. <member name="M:NPOI.SS.UserModel.IPicture.GetImageDimension">
  27264. Return the dimension of the embedded image in pixel
  27265. @return image dimension in pixels
  27266. </member>
  27267. <member name="P:NPOI.SS.UserModel.IPicture.PictureData">
  27268. Return picture data for this picture
  27269. @return picture data for this picture
  27270. </member>
  27271. <member name="P:NPOI.SS.UserModel.IPicture.ClientAnchor">
  27272. @return the anchor that is used by this picture
  27273. </member>
  27274. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  27275. <summary>
  27276. Constructs a picture object.
  27277. </summary>
  27278. <param name="parent">The parent.</param>
  27279. <param name="anchor">The anchor.</param>
  27280. </member>
  27281. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.Resize">
  27282. <summary>
  27283. Reset the image to the dimension of the embedded image
  27284. </summary>
  27285. <remarks>
  27286. Please note, that this method works correctly only for workbooks
  27287. with default font size (Arial 10pt for .xls).
  27288. If the default font is changed the resized image can be streched vertically or horizontally.
  27289. </remarks>
  27290. </member>
  27291. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.Resize(System.Double)">
  27292. <summary>
  27293. Resize the image proportionally.
  27294. </summary>
  27295. <param name="scale">scale</param>
  27296. <seealso cref="M:NPOI.HSSF.UserModel.HSSFPicture.Resize(System.Double,System.Double)"/>
  27297. </member>
  27298. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.Resize(System.Double,System.Double)">
  27299. Resize the image
  27300. <p>
  27301. Please note, that this method works correctly only for workbooks
  27302. with default font size (Arial 10pt for .xls).
  27303. If the default font is changed the resized image can be streched vertically or horizontally.
  27304. </p>
  27305. <p>
  27306. <code>resize(1.0,1.0)</code> keeps the original size,<br/>
  27307. <code>resize(0.5,0.5)</code> resize to 50% of the original,<br/>
  27308. <code>resize(2.0,2.0)</code> resizes to 200% of the original.<br/>
  27309. <code>resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE})</code> resizes to the dimension of the embedded image.
  27310. </p>
  27311. @param scaleX the amount by which the image width is multiplied relative to the original width.
  27312. @param scaleY the amount by which the image height is multiplied relative to the original height.
  27313. </member>
  27314. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetPreferredSize(System.Double)">
  27315. Calculate the preferred size for this picture.
  27316. @param scale the amount by which image dimensions are multiplied relative to the original size.
  27317. @return HSSFClientAnchor with the preferred size for this image
  27318. @since POI 3.0.2
  27319. </member>
  27320. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetPreferredSize(System.Double,System.Double)">
  27321. <summary>
  27322. Calculate the preferred size for this picture.
  27323. </summary>
  27324. <param name="scaleX">the amount by which image width is multiplied relative to the original width.</param>
  27325. <param name="scaleY">the amount by which image height is multiplied relative to the original height.</param>
  27326. <returns>HSSFClientAnchor with the preferred size for this image</returns>
  27327. </member>
  27328. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetPreferredSize">
  27329. <summary>
  27330. Calculate the preferred size for this picture.
  27331. </summary>
  27332. <returns>HSSFClientAnchor with the preferred size for this image</returns>
  27333. </member>
  27334. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetResolution(System.Drawing.Image)">
  27335. <summary>
  27336. The metadata of PNG and JPEG can contain the width of a pixel in millimeters.
  27337. Return the the "effective" dpi calculated as
  27338. <c>25.4/HorizontalPixelSize</c>
  27339. and
  27340. <c>25.4/VerticalPixelSize</c>
  27341. . Where 25.4 is the number of mm in inch.
  27342. </summary>
  27343. <param name="r">The image.</param>
  27344. <returns>the resolution</returns>
  27345. </member>
  27346. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetImageDimension">
  27347. <summary>
  27348. Return the dimension of the embedded image in pixel
  27349. </summary>
  27350. <returns>image dimension</returns>
  27351. </member>
  27352. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.PictureIndex">
  27353. <summary>
  27354. Gets or sets the index of the picture.
  27355. </summary>
  27356. <value>The index of the picture.</value>
  27357. </member>
  27358. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.PictureData">
  27359. Return picture data for this shape
  27360. @return picture data for this shape
  27361. </member>
  27362. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.FileName">
  27363. The color applied to the lines of this shape.
  27364. </member>
  27365. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.ClientAnchor">
  27366. @return the anchor that is used by this picture.
  27367. </member>
  27368. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.Sheet">
  27369. @return the sheet which contains the picture shape
  27370. </member>
  27371. <member name="F:NPOI.HSSF.UserModel.HSSFObjectData._root">
  27372. Reference to the filesystem root, required for retrieving the object data.
  27373. </member>
  27374. <member name="M:NPOI.HSSF.UserModel.HSSFObjectData.GetDirectory">
  27375. Gets the object data. Only call for ones that have
  27376. data though. See {@link #hasDirectoryEntry()}
  27377. @return the object data as an OLE2 directory.
  27378. @ if there was an error Reading the data.
  27379. </member>
  27380. <member name="M:NPOI.HSSF.UserModel.HSSFObjectData.GetObjectData">
  27381. Returns the data portion, for an ObjectData
  27382. that doesn't have an associated POIFS Directory
  27383. Entry
  27384. </member>
  27385. <member name="M:NPOI.HSSF.UserModel.HSSFObjectData.HasDirectoryEntry">
  27386. Does this ObjectData have an associated POIFS
  27387. Directory Entry?
  27388. (Not all do, those that don't have a data portion)
  27389. </member>
  27390. <member name="M:NPOI.HSSF.UserModel.HSSFObjectData.FindObjectRecord">
  27391. Finds the EmbeddedObjectRefSubRecord, or throws an
  27392. Exception if there wasn't one
  27393. </member>
  27394. <member name="P:NPOI.HSSF.UserModel.HSSFObjectData.OLE2ClassName">
  27395. Returns the OLE2 Class Name of the object
  27396. </member>
  27397. <member name="T:NPOI.HSSF.UserModel.HSSFOptimiser">
  27398. <summary>
  27399. Excel can Get cranky if you give it files containing too
  27400. many (especially duplicate) objects, and this class can
  27401. help to avoid those.
  27402. In general, it's much better to make sure you don't
  27403. duplicate the objects in your code, as this is likely
  27404. to be much faster than creating lots and lots of
  27405. excel objects+records, only to optimise them down to
  27406. many fewer at a later stage.
  27407. However, sometimes this is too hard / tricky to do, which
  27408. is where the use of this class comes in.
  27409. </summary>
  27410. </member>
  27411. <member name="M:NPOI.HSSF.UserModel.HSSFOptimiser.OptimiseFonts(NPOI.HSSF.UserModel.HSSFWorkbook)">
  27412. <summary>
  27413. Goes through the Workbook, optimising the fonts by
  27414. removing duplicate ones.
  27415. For now, only works on fonts used in HSSFCellStyle
  27416. and HSSFRichTextString. Any other font uses
  27417. (eg charts, pictures) may well end up broken!
  27418. This can be a slow operation, especially if you have
  27419. lots of cells, cell styles or rich text strings
  27420. </summary>
  27421. <param name="workbook">The workbook in which to optimise the fonts</param>
  27422. </member>
  27423. <member name="M:NPOI.HSSF.UserModel.HSSFOptimiser.OptimiseCellStyles(NPOI.HSSF.UserModel.HSSFWorkbook)">
  27424. <summary>
  27425. Goes through the Wokrbook, optimising the cell styles
  27426. by removing duplicate ones and ones that aren't used.
  27427. For best results, optimise the fonts via a call to
  27428. OptimiseFonts(HSSFWorkbook) first
  27429. </summary>
  27430. <param name="workbook">The workbook in which to optimise the cell styles</param>
  27431. </member>
  27432. <member name="T:NPOI.HSSF.UserModel.HSSFPalette">
  27433. <summary>
  27434. Represents a workbook color palette.
  27435. Internally, the XLS format refers to colors using an offset into the palette
  27436. record. Thus, the first color in the palette has the index 0x8, the second
  27437. has the index 0x9, etc. through 0x40
  27438. @author Brian Sanders (bsanders at risklabs dot com)
  27439. </summary>
  27440. </member>
  27441. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.GetColor(System.Int16)">
  27442. <summary>
  27443. Retrieves the color at a given index
  27444. </summary>
  27445. <param name="index">the palette index, between 0x8 to 0x40 inclusive.</param>
  27446. <returns>the color, or null if the index Is not populated</returns>
  27447. </member>
  27448. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.FindColor(System.Byte,System.Byte,System.Byte)">
  27449. <summary>
  27450. Finds the first occurance of a given color
  27451. </summary>
  27452. <param name="red">the RGB red component, between 0 and 255 inclusive</param>
  27453. <param name="green">the RGB green component, between 0 and 255 inclusive</param>
  27454. <param name="blue">the RGB blue component, between 0 and 255 inclusive</param>
  27455. <returns>the color, or null if the color does not exist in this palette</returns>
  27456. </member>
  27457. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.FindSimilarColor(System.Byte,System.Byte,System.Byte)">
  27458. <summary>
  27459. Finds the closest matching color in the custom palette. The
  27460. method for Finding the distance between the colors Is fairly
  27461. primative.
  27462. </summary>
  27463. <param name="red">The red component of the color to match.</param>
  27464. <param name="green">The green component of the color to match.</param>
  27465. <param name="blue">The blue component of the color to match.</param>
  27466. <returns>The closest color or null if there are no custom
  27467. colors currently defined.</returns>
  27468. </member>
  27469. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.SetColorAtIndex(System.Int16,System.Byte,System.Byte,System.Byte)">
  27470. <summary>
  27471. Sets the color at the given offset
  27472. </summary>
  27473. <param name="index">the palette index, between 0x8 to 0x40 inclusive</param>
  27474. <param name="red">the RGB red component, between 0 and 255 inclusive</param>
  27475. <param name="green">the RGB green component, between 0 and 255 inclusive</param>
  27476. <param name="blue">the RGB blue component, between 0 and 255 inclusive</param>
  27477. </member>
  27478. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.AddColor(System.Byte,System.Byte,System.Byte)">
  27479. <summary>
  27480. Adds a new color into an empty color slot.
  27481. </summary>
  27482. <param name="red">The red component</param>
  27483. <param name="green">The green component</param>
  27484. <param name="blue">The blue component</param>
  27485. <returns>The new custom color.</returns>
  27486. </member>
  27487. <member name="T:NPOI.HSSF.UserModel.HSSFPalette.CustomColor">
  27488. <summary>
  27489. user custom color
  27490. </summary>
  27491. </member>
  27492. <member name="T:NPOI.HSSF.Util.HSSFColor">
  27493. Intends to provide support for the very evil index to triplet Issue and
  27494. will likely replace the color constants interface for HSSF 2.0.
  27495. This class Contains static inner class members for representing colors.
  27496. Each color has an index (for the standard palette in Excel (tm) ),
  27497. native (RGB) triplet and string triplet. The string triplet Is as the
  27498. color would be represented by Gnumeric. Having (string) this here Is a bit of a
  27499. collusion of function between HSSF and the HSSFSerializer but I think its
  27500. a reasonable one in this case.
  27501. @author Andrew C. Oliver (acoliver at apache dot org)
  27502. @author Brian Sanders (bsanders at risklabs dot com) - full default color palette
  27503. </member>
  27504. <member name="M:NPOI.HSSF.Util.HSSFColor.#ctor">
  27505. Creates a new instance of HSSFColor
  27506. </member>
  27507. <member name="M:NPOI.HSSF.Util.HSSFColor.GetIndexHash">
  27508. this function returns all colors in a hastable. Its not implemented as a
  27509. static member/staticly initialized because that would be dirty in a
  27510. server environment as it Is intended. This means you'll eat the time
  27511. it takes to Create it once per request but you will not hold onto it
  27512. if you have none of those requests.
  27513. @return a hashtable containing all colors keyed by <c>int</c> excel-style palette indexes
  27514. </member>
  27515. <member name="M:NPOI.HSSF.Util.HSSFColor.GetMutableIndexHash">
  27516. This function returns all the Colours, stored in a Hashtable that
  27517. can be edited. No caching is performed. If you don't need to edit
  27518. the table, then call {@link #getIndexHash()} which returns a
  27519. statically cached imuatable map of colours.
  27520. </member>
  27521. <member name="M:NPOI.HSSF.Util.HSSFColor.GetTripletHash">
  27522. <summary>
  27523. this function returns all colors in a hastable. Its not implemented as a
  27524. static member/staticly initialized because that would be dirty in a
  27525. server environment as it Is intended. This means you'll eat the time
  27526. it takes to Create it once per request but you will not hold onto it
  27527. if you have none of those requests.
  27528. </summary>
  27529. <returns>a hashtable containing all colors keyed by String gnumeric-like triplets</returns>
  27530. </member>
  27531. <member name="M:NPOI.HSSF.Util.HSSFColor.GetTriplet">
  27532. @return triplet representation like that in Excel
  27533. </member>
  27534. <member name="M:NPOI.HSSF.Util.HSSFColor.GetHexString">
  27535. @return a hex string exactly like a gnumeric triplet
  27536. </member>
  27537. <member name="P:NPOI.HSSF.Util.HSSFColor.Indexed">
  27538. @return index to the standard palette
  27539. </member>
  27540. <member name="T:NPOI.HSSF.Util.HSSFColor.Black">
  27541. Class BLACK
  27542. </member>
  27543. <member name="T:NPOI.HSSF.Util.HSSFColor.Brown">
  27544. Class BROWN
  27545. </member>
  27546. <member name="T:NPOI.HSSF.Util.HSSFColor.OliveGreen">
  27547. Class OLIVE_GREEN
  27548. </member>
  27549. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkGreen">
  27550. Class DARK_GREEN
  27551. </member>
  27552. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkTeal">
  27553. Class DARK_TEAL
  27554. </member>
  27555. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkBlue">
  27556. Class DARK_BLUE
  27557. </member>
  27558. <member name="T:NPOI.HSSF.Util.HSSFColor.Indigo">
  27559. Class INDIGO
  27560. </member>
  27561. <member name="T:NPOI.HSSF.Util.HSSFColor.Grey80Percent">
  27562. Class GREY_80_PERCENT
  27563. </member>
  27564. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkRed">
  27565. Class DARK_RED
  27566. </member>
  27567. <member name="T:NPOI.HSSF.Util.HSSFColor.Orange">
  27568. Class ORANGE
  27569. </member>
  27570. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkYellow">
  27571. Class DARK_YELLOW
  27572. </member>
  27573. <member name="T:NPOI.HSSF.Util.HSSFColor.Green">
  27574. Class GREEN
  27575. </member>
  27576. <member name="T:NPOI.HSSF.Util.HSSFColor.Teal">
  27577. Class TEAL
  27578. </member>
  27579. <member name="T:NPOI.HSSF.Util.HSSFColor.Blue">
  27580. Class BLUE
  27581. </member>
  27582. <member name="T:NPOI.HSSF.Util.HSSFColor.BlueGrey">
  27583. Class BLUE_GREY
  27584. </member>
  27585. <member name="T:NPOI.HSSF.Util.HSSFColor.Grey50Percent">
  27586. Class GREY_50_PERCENT
  27587. </member>
  27588. <member name="T:NPOI.HSSF.Util.HSSFColor.Red">
  27589. Class RED
  27590. </member>
  27591. <member name="T:NPOI.HSSF.Util.HSSFColor.LightOrange">
  27592. Class LIGHT_ORANGE
  27593. </member>
  27594. <member name="T:NPOI.HSSF.Util.HSSFColor.Lime">
  27595. Class LIME
  27596. </member>
  27597. <member name="T:NPOI.HSSF.Util.HSSFColor.SeaGreen">
  27598. Class SEA_GREEN
  27599. </member>
  27600. <member name="T:NPOI.HSSF.Util.HSSFColor.Aqua">
  27601. Class AQUA
  27602. </member>
  27603. <member name="T:NPOI.HSSF.Util.HSSFColor.Grey40Percent">
  27604. Class GREY_40_PERCENT
  27605. </member>
  27606. <member name="T:NPOI.HSSF.Util.HSSFColor.Turquoise">
  27607. Class TURQUOISE
  27608. </member>
  27609. <member name="T:NPOI.HSSF.Util.HSSFColor.SkyBlue">
  27610. Class SKY_BLUE
  27611. </member>
  27612. <member name="T:NPOI.HSSF.Util.HSSFColor.Plum">
  27613. Class PLUM
  27614. </member>
  27615. <member name="T:NPOI.HSSF.Util.HSSFColor.Grey25Percent">
  27616. Class GREY_25_PERCENT
  27617. </member>
  27618. <member name="T:NPOI.HSSF.Util.HSSFColor.Rose">
  27619. Class ROSE
  27620. </member>
  27621. <member name="T:NPOI.HSSF.Util.HSSFColor.Tan">
  27622. Class TAN
  27623. </member>
  27624. <member name="T:NPOI.HSSF.Util.HSSFColor.LightYellow">
  27625. Class LIGHT_YELLOW
  27626. </member>
  27627. <member name="T:NPOI.HSSF.Util.HSSFColor.LightGreen">
  27628. Class LIGHT_GREEN
  27629. </member>
  27630. <member name="T:NPOI.HSSF.Util.HSSFColor.LightTurquoise">
  27631. Class LIGHT_TURQUOISE
  27632. </member>
  27633. <member name="T:NPOI.HSSF.Util.HSSFColor.PaleBlue">
  27634. Class PALE_BLUE
  27635. </member>
  27636. <member name="T:NPOI.HSSF.Util.HSSFColor.Lavender">
  27637. Class LAVENDER
  27638. </member>
  27639. <member name="T:NPOI.HSSF.Util.HSSFColor.White">
  27640. Class WHITE
  27641. </member>
  27642. <member name="T:NPOI.HSSF.Util.HSSFColor.CornflowerBlue">
  27643. Class CORNFLOWER_BLUE
  27644. </member>
  27645. <member name="T:NPOI.HSSF.Util.HSSFColor.LemonChiffon">
  27646. Class LEMON_CHIFFON
  27647. </member>
  27648. <member name="T:NPOI.HSSF.Util.HSSFColor.Maroon">
  27649. Class MAROON
  27650. </member>
  27651. <member name="T:NPOI.HSSF.Util.HSSFColor.Orchid">
  27652. Class ORCHID
  27653. </member>
  27654. <member name="T:NPOI.HSSF.Util.HSSFColor.Coral">
  27655. Class CORAL
  27656. </member>
  27657. <member name="T:NPOI.HSSF.Util.HSSFColor.RoyalBlue">
  27658. Class ROYAL_BLUE
  27659. </member>
  27660. <member name="T:NPOI.HSSF.Util.HSSFColor.LightCornflowerBlue">
  27661. Class LIGHT_CORNFLOWER_BLUE
  27662. </member>
  27663. <member name="T:NPOI.HSSF.Util.HSSFColor.Automatic">
  27664. Special Default/Normal/Automatic color.
  27665. <i>Note:</i> This class Is NOT in the default HashTables returned by HSSFColor.
  27666. The index Is a special case which Is interpreted in the various SetXXXColor calls.
  27667. @author Jason
  27668. </member>
  27669. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.#ctor(System.Int16,System.Byte[])">
  27670. <summary>
  27671. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFPalette.CustomColor"/> class.
  27672. </summary>
  27673. <param name="byteOffset">The byte offset.</param>
  27674. <param name="colors">The colors.</param>
  27675. </member>
  27676. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.#ctor(System.Int16,System.Byte,System.Byte,System.Byte)">
  27677. <summary>
  27678. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFPalette.CustomColor"/> class.
  27679. </summary>
  27680. <param name="byteOffset">The byte offset.</param>
  27681. <param name="red">The red.</param>
  27682. <param name="green">The green.</param>
  27683. <param name="blue">The blue.</param>
  27684. </member>
  27685. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.GetTriplet">
  27686. <summary>
  27687. Gets triplet representation like that in Excel
  27688. </summary>
  27689. <value></value>
  27690. </member>
  27691. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.GetHexString">
  27692. <summary>
  27693. Gets a hex string exactly like a gnumeric triplet
  27694. </summary>
  27695. <value></value>
  27696. </member>
  27697. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.GetGnumericPart(System.Byte)">
  27698. <summary>
  27699. Gets the gnumeric part.
  27700. </summary>
  27701. <param name="color">The color.</param>
  27702. <returns></returns>
  27703. </member>
  27704. <member name="P:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.Indexed">
  27705. <summary>
  27706. Gets index to the standard palette
  27707. </summary>
  27708. <value></value>
  27709. </member>
  27710. <member name="T:NPOI.HSSF.UserModel.HSSFPatriarch">
  27711. <summary>
  27712. The patriarch is the toplevel container for shapes in a sheet. It does
  27713. little other than act as a container for other shapes and Groups.
  27714. @author Glen Stampoultzis (glens at apache.org)
  27715. </summary>
  27716. </member>
  27717. <member name="T:NPOI.HSSF.UserModel.HSSFShapeContainer">
  27718. <summary>
  27719. An interface that indicates whether a class can contain children.
  27720. @author Glen Stampoultzis (glens at apache.org)
  27721. </summary>
  27722. </member>
  27723. <member name="M:NPOI.HSSF.UserModel.HSSFShapeContainer.AddShape(NPOI.HSSF.UserModel.HSSFShape)">
  27724. <summary>
  27725. dd shape to the list of child records
  27726. </summary>
  27727. <param name="shape">shape</param>
  27728. </member>
  27729. <member name="M:NPOI.HSSF.UserModel.HSSFShapeContainer.SetCoordinates(System.Int32,System.Int32,System.Int32,System.Int32)">
  27730. <summary>
  27731. set coordinates of this group relative to the parent
  27732. </summary>
  27733. <param name="x1">x1</param>
  27734. <param name="y1">y1</param>
  27735. <param name="x2">x2</param>
  27736. <param name="y2">y2</param>
  27737. </member>
  27738. <member name="M:NPOI.HSSF.UserModel.HSSFShapeContainer.RemoveShape(NPOI.HSSF.UserModel.HSSFShape)">
  27739. remove first level shapes
  27740. @param shape to be removed
  27741. @return true if shape is removed else return false
  27742. </member>
  27743. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.Children">
  27744. <summary>
  27745. Gets Any children contained by this shape.
  27746. </summary>
  27747. <value>The children.</value>
  27748. </member>
  27749. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.X1">
  27750. <summary>
  27751. Get the top left x coordinate of this group.
  27752. </summary>
  27753. </member>
  27754. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.Y1">
  27755. <summary>
  27756. Get the top left y coordinate of this group.
  27757. </summary>
  27758. </member>
  27759. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.X2">
  27760. <summary>
  27761. Get the bottom right x coordinate of this group.
  27762. </summary>
  27763. </member>
  27764. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.Y2">
  27765. <summary>
  27766. Get the bottom right y coordinate of this group.
  27767. </summary>
  27768. </member>
  27769. <member name="T:NPOI.SS.UserModel.IDrawing">
  27770. @author Yegor Kozlov
  27771. </member>
  27772. <member name="M:NPOI.SS.UserModel.IDrawing.CreatePicture(NPOI.SS.UserModel.IClientAnchor,System.Int32)">
  27773. Creates a picture.
  27774. @param anchor the client anchor describes how this picture is
  27775. attached to the sheet.
  27776. @param pictureIndex the index of the picture in the workbook collection
  27777. of pictures.
  27778. @return the newly created picture.
  27779. </member>
  27780. <member name="M:NPOI.SS.UserModel.IDrawing.CreateCellComment(NPOI.SS.UserModel.IClientAnchor)">
  27781. Creates a comment.
  27782. @param anchor the client anchor describes how this comment is attached
  27783. to the sheet.
  27784. @return the newly created comment.
  27785. </member>
  27786. <member name="M:NPOI.SS.UserModel.IDrawing.CreateChart(NPOI.SS.UserModel.IClientAnchor)">
  27787. Creates a chart.
  27788. @param anchor the client anchor describes how this chart is attached to
  27789. the sheet.
  27790. @return the newly created chart
  27791. </member>
  27792. <member name="M:NPOI.SS.UserModel.IDrawing.CreateAnchor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  27793. Creates a new client anchor and sets the top-left and bottom-right
  27794. coordinates of the anchor.
  27795. @param dx1 the x coordinate in EMU within the first cell.
  27796. @param dy1 the y coordinate in EMU within the first cell.
  27797. @param dx2 the x coordinate in EMU within the second cell.
  27798. @param dy2 the y coordinate in EMU within the second cell.
  27799. @param col1 the column (0 based) of the first cell.
  27800. @param row1 the row (0 based) of the first cell.
  27801. @param col2 the column (0 based) of the second cell.
  27802. @param row2 the row (0 based) of the second cell.
  27803. @return the newly created client anchor
  27804. </member>
  27805. <member name="F:NPOI.HSSF.UserModel.HSSFPatriarch._boundAggregate">
  27806. The EscherAggregate we have been bound to.
  27807. (This will handle writing us out into records,
  27808. and building up our shapes from the records)
  27809. </member>
  27810. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.#ctor(NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.Record.EscherAggregate)">
  27811. <summary>
  27812. Creates the patriarch.
  27813. </summary>
  27814. <param name="sheet">the sheet this patriarch is stored in.</param>
  27815. <param name="boundAggregate">The bound aggregate.</param>
  27816. </member>
  27817. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.PreSerialize">
  27818. check if any shapes contain wrong data
  27819. At now(13.08.2010) check if patriarch contains 2 or more comments with same coordinates
  27820. </member>
  27821. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.RemoveShape(NPOI.HSSF.UserModel.HSSFShape)">
  27822. @param shape to be removed
  27823. @return true of shape is removed
  27824. </member>
  27825. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateGroup(NPOI.HSSF.UserModel.HSSFClientAnchor)">
  27826. <summary>
  27827. Creates a new Group record stored Under this patriarch.
  27828. </summary>
  27829. <param name="anchor">the client anchor describes how this Group is attached
  27830. to the sheet.</param>
  27831. <returns>the newly created Group.</returns>
  27832. </member>
  27833. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateSimpleShape(NPOI.HSSF.UserModel.HSSFClientAnchor)">
  27834. <summary>
  27835. Creates a simple shape. This includes such shapes as lines, rectangles,
  27836. and ovals.
  27837. Note: Microsoft Excel seems to sometimes disallow
  27838. higher y1 than y2 or higher x1 than x2 in the anchor, you might need to
  27839. reverse them and draw shapes vertically or horizontally flipped!
  27840. </summary>
  27841. <param name="anchor">the client anchor describes how this Group is attached
  27842. to the sheet.</param>
  27843. <returns>the newly created shape.</returns>
  27844. </member>
  27845. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreatePicture(NPOI.HSSF.UserModel.HSSFClientAnchor,System.Int32)">
  27846. <summary>
  27847. Creates a picture.
  27848. </summary>
  27849. <param name="anchor">the client anchor describes how this Group is attached
  27850. to the sheet.</param>
  27851. <param name="pictureIndex">Index of the picture.</param>
  27852. <returns>the newly created shape.</returns>
  27853. </member>
  27854. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreatePicture(NPOI.SS.UserModel.IClientAnchor,System.Int32)">
  27855. <summary>
  27856. CreatePicture
  27857. </summary>
  27858. <param name="anchor">the client anchor describes how this picture is attached to the sheet.</param>
  27859. <param name="pictureIndex">the index of the picture in the workbook collection of pictures.</param>
  27860. <returns>return newly created shape</returns>
  27861. </member>
  27862. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateObjectData(NPOI.HSSF.UserModel.HSSFClientAnchor,System.Int32,System.Int32)">
  27863. Adds a new OLE Package Shape
  27864. @param anchor the client anchor describes how this picture is
  27865. attached to the sheet.
  27866. @param storageId the storageId returned by {@Link HSSFWorkbook.AddOlePackage}
  27867. @param pictureIndex the index of the picture (used as preview image) in the
  27868. workbook collection of pictures.
  27869. @return newly Created shape
  27870. </member>
  27871. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreatePolygon(NPOI.SS.UserModel.IClientAnchor)">
  27872. <summary>
  27873. Creates a polygon
  27874. </summary>
  27875. <param name="anchor">the client anchor describes how this Group is attached
  27876. to the sheet.</param>
  27877. <returns>the newly Created shape.</returns>
  27878. </member>
  27879. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateTextbox(NPOI.SS.UserModel.IClientAnchor)">
  27880. <summary>
  27881. Constructs a textbox Under the patriarch.
  27882. </summary>
  27883. <param name="anchor">the client anchor describes how this Group is attached
  27884. to the sheet.</param>
  27885. <returns>the newly Created textbox.</returns>
  27886. </member>
  27887. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateComment(NPOI.HSSF.UserModel.HSSFAnchor)">
  27888. Constructs a cell comment.
  27889. @param anchor the client anchor describes how this comment is attached
  27890. to the sheet.
  27891. @return the newly created comment.
  27892. </member>
  27893. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateComboBox(NPOI.HSSF.UserModel.HSSFAnchor)">
  27894. YK: used to create autofilters
  27895. @see org.apache.poi.hssf.usermodel.HSSFSheet#setAutoFilter(int, int, int, int)
  27896. </member>
  27897. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateCellComment(NPOI.SS.UserModel.IClientAnchor)">
  27898. <summary>
  27899. Constructs a cell comment.
  27900. </summary>
  27901. <param name="anchor">the client anchor describes how this comment is attached
  27902. to the sheet.</param>
  27903. <returns>the newly created comment.</returns>
  27904. </member>
  27905. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.AddShape(NPOI.HSSF.UserModel.HSSFShape)">
  27906. add a shape to this drawing
  27907. </member>
  27908. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.SetCoordinates(System.Int32,System.Int32,System.Int32,System.Int32)">
  27909. <summary>
  27910. Sets the coordinate space of this Group. All children are contrained
  27911. to these coordinates.
  27912. </summary>
  27913. <param name="x1">The x1.</param>
  27914. <param name="y1">The y1.</param>
  27915. <param name="x2">The x2.</param>
  27916. <param name="y2">The y2.</param>
  27917. </member>
  27918. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.ContainsChart">
  27919. <summary>
  27920. Does this HSSFPatriarch contain a chart?
  27921. (Technically a reference to a chart, since they
  27922. Get stored in a different block of records)
  27923. FIXME - detect chart in all cases (only seems
  27924. to work on some charts so far)
  27925. </summary>
  27926. <returns>
  27927. <c>true</c> if this instance contains chart; otherwise, <c>false</c>.
  27928. </returns>
  27929. </member>
  27930. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.GetBoundAggregate">
  27931. <summary>
  27932. Returns the aggregate escher record we're bound to
  27933. </summary>
  27934. <returns></returns>
  27935. </member>
  27936. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateAnchor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  27937. Creates a new client anchor and sets the top-left and bottom-right
  27938. coordinates of the anchor.
  27939. @param dx1 the x coordinate in EMU within the first cell.
  27940. @param dy1 the y coordinate in EMU within the first cell.
  27941. @param dx2 the x coordinate in EMU within the second cell.
  27942. @param dy2 the y coordinate in EMU within the second cell.
  27943. @param col1 the column (0 based) of the first cell.
  27944. @param row1 the row (0 based) of the first cell.
  27945. @param col2 the column (0 based) of the second cell.
  27946. @param row2 the row (0 based) of the second cell.
  27947. @return the newly created client anchor
  27948. </member>
  27949. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.BuildShapeTree">
  27950. create shape tree from existing escher records tree
  27951. </member>
  27952. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.Children">
  27953. <summary>
  27954. Returns a list of all shapes contained by the patriarch.
  27955. </summary>
  27956. <value>The children.</value>
  27957. </member>
  27958. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.CountOfAllChildren">
  27959. <summary>
  27960. Total count of all children and their children's children.
  27961. </summary>
  27962. <value>The count of all children.</value>
  27963. </member>
  27964. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.X1">
  27965. <summary>
  27966. The top left x coordinate of this Group.
  27967. </summary>
  27968. <value>The x1.</value>
  27969. </member>
  27970. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.Y1">
  27971. <summary>
  27972. The top left y coordinate of this Group.
  27973. </summary>
  27974. <value>The y1.</value>
  27975. </member>
  27976. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.X2">
  27977. <summary>
  27978. The bottom right x coordinate of this Group.
  27979. </summary>
  27980. <value>The x2.</value>
  27981. </member>
  27982. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.Y2">
  27983. <summary>
  27984. The bottom right y coordinate of this Group.
  27985. </summary>
  27986. <value>The y2.</value>
  27987. </member>
  27988. <member name="T:NPOI.HSSF.UserModel.HSSFPatternFormatting">
  27989. <summary>
  27990. High level representation for Conditional Formatting Settings
  27991. @author Dmitriy Kumshayev
  27992. </summary>
  27993. </member>
  27994. <member name="T:NPOI.SS.UserModel.IPatternFormatting">
  27995. @author Yegor Kozlov
  27996. </member>
  27997. <member name="M:NPOI.HSSF.UserModel.HSSFPatternFormatting.#ctor(NPOI.HSSF.Record.CFRuleRecord)">
  27998. <summary>
  27999. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFPatternFormatting"/> class.
  28000. </summary>
  28001. <param name="cfRuleRecord">The cf rule record.</param>
  28002. </member>
  28003. <member name="P:NPOI.HSSF.UserModel.HSSFPatternFormatting.PatternFormattingBlock">
  28004. <summary>
  28005. Gets the pattern formatting block.
  28006. </summary>
  28007. <value>The pattern formatting block.</value>
  28008. </member>
  28009. <member name="P:NPOI.HSSF.UserModel.HSSFPatternFormatting.FillBackgroundColor">
  28010. <summary>
  28011. Gets or sets the color of the fill background.
  28012. </summary>
  28013. <value>The color of the fill background.</value>
  28014. </member>
  28015. <member name="P:NPOI.HSSF.UserModel.HSSFPatternFormatting.FillForegroundColor">
  28016. <summary>
  28017. Gets or sets the color of the fill foreground.
  28018. </summary>
  28019. <value>The color of the fill foreground.</value>
  28020. </member>
  28021. <member name="P:NPOI.HSSF.UserModel.HSSFPatternFormatting.FillPattern">
  28022. <summary>
  28023. Gets or sets the fill pattern.
  28024. </summary>
  28025. <value>The fill pattern.</value>
  28026. </member>
  28027. <member name="T:NPOI.HSSF.UserModel.HSSFPictureData">
  28028. <summary>
  28029. Represents binary data stored in the file. Eg. A GIF, JPEG etc...
  28030. @author Daniel Noll
  28031. </summary>
  28032. </member>
  28033. <member name="M:NPOI.SS.UserModel.IPictureData.SuggestFileExtension">
  28034. Suggests a file extension for this image.
  28035. @return the file extension.
  28036. </member>
  28037. <member name="P:NPOI.SS.UserModel.IPictureData.Data">
  28038. Gets the picture data.
  28039. @return the picture data.
  28040. </member>
  28041. <member name="P:NPOI.SS.UserModel.IPictureData.MimeType">
  28042. Returns the mime type for the image
  28043. </member>
  28044. <member name="P:NPOI.SS.UserModel.IPictureData.PictureType">
  28045. @return the POI internal image type, 0 if unknown image type
  28046. @see Workbook#PICTURE_TYPE_DIB
  28047. @see Workbook#PICTURE_TYPE_EMF
  28048. @see Workbook#PICTURE_TYPE_JPEG
  28049. @see Workbook#PICTURE_TYPE_PICT
  28050. @see Workbook#PICTURE_TYPE_PNG
  28051. @see Workbook#PICTURE_TYPE_WMF
  28052. </member>
  28053. <member name="F:NPOI.HSSF.UserModel.HSSFPictureData.blip">
  28054. Underlying escher blip record containing the bitmap data.
  28055. </member>
  28056. <member name="M:NPOI.HSSF.UserModel.HSSFPictureData.#ctor(NPOI.DDF.EscherBlipRecord)">
  28057. <summary>
  28058. Constructs a picture object.
  28059. </summary>
  28060. <param name="blip">the underlying blip record containing the bitmap data.</param>
  28061. </member>
  28062. <member name="M:NPOI.HSSF.UserModel.HSSFPictureData.SuggestFileExtension">
  28063. <summary>
  28064. Suggests a file extension for this image.
  28065. </summary>
  28066. <returns>the file extension.</returns>
  28067. </member>
  28068. <member name="P:NPOI.HSSF.UserModel.HSSFPictureData.Data">
  28069. <summary>
  28070. Gets the picture data.
  28071. </summary>
  28072. <value>the picture data.</value>
  28073. </member>
  28074. <member name="P:NPOI.HSSF.UserModel.HSSFPictureData.Format">
  28075. <summary>
  28076. gets format of the picture.
  28077. </summary>
  28078. <value>The format.</value>
  28079. </member>
  28080. <member name="P:NPOI.HSSF.UserModel.HSSFPictureData.MimeType">
  28081. Returns the mime type for the image
  28082. </member>
  28083. <member name="P:NPOI.HSSF.UserModel.HSSFPictureData.PictureType">
  28084. @return the POI internal image type, -1 if not unknown image type
  28085. @see Workbook#PICTURE_TYPE_DIB
  28086. @see Workbook#PICTURE_TYPE_EMF
  28087. @see Workbook#PICTURE_TYPE_JPEG
  28088. @see Workbook#PICTURE_TYPE_PICT
  28089. @see Workbook#PICTURE_TYPE_PNG
  28090. @see Workbook#PICTURE_TYPE_WMF
  28091. </member>
  28092. <member name="T:NPOI.HSSF.UserModel.HSSFPolygon">
  28093. <summary>
  28094. @author Glen Stampoultzis (glens at baselinksoftware.com)
  28095. </summary>
  28096. </member>
  28097. <member name="M:NPOI.HSSF.UserModel.HSSFPolygon.CreateSpContainer">
  28098. Generates the shape records for this shape.
  28099. </member>
  28100. <member name="M:NPOI.HSSF.UserModel.HSSFPolygon.CreateObjRecord">
  28101. Creates the low level OBJ record for this shape.
  28102. </member>
  28103. <member name="M:NPOI.HSSF.UserModel.HSSFPolygon.SetPoints(System.Int32[],System.Int32[])">
  28104. @param xPoints - array of x coordinates
  28105. @param yPoints - array of y coordinates
  28106. </member>
  28107. <member name="M:NPOI.HSSF.UserModel.HSSFPolygon.SetPolygonDrawArea(System.Int32,System.Int32)">
  28108. Defines the width and height of the points in the polygon
  28109. @param width
  28110. @param height
  28111. </member>
  28112. <member name="P:NPOI.HSSF.UserModel.HSSFPolygon.XPoints">
  28113. @return array of x coordinates
  28114. </member>
  28115. <member name="P:NPOI.HSSF.UserModel.HSSFPolygon.YPoints">
  28116. @return array of y coordinates
  28117. </member>
  28118. <member name="P:NPOI.HSSF.UserModel.HSSFPolygon.DrawAreaWidth">
  28119. @return shape width
  28120. </member>
  28121. <member name="P:NPOI.HSSF.UserModel.HSSFPolygon.DrawAreaHeight">
  28122. @return shape height
  28123. </member>
  28124. <member name="T:NPOI.HSSF.UserModel.HSSFPrintSetup">
  28125. <summary>
  28126. Used to modify the print Setup.
  28127. @author Shawn Laubach (slaubach at apache dot org)
  28128. </summary>
  28129. </member>
  28130. <member name="P:NPOI.SS.UserModel.IPrintSetup.PaperSize">
  28131. Returns the paper size.
  28132. @return paper size
  28133. </member>
  28134. <member name="P:NPOI.SS.UserModel.IPrintSetup.Scale">
  28135. Returns the scale.
  28136. @return scale
  28137. </member>
  28138. <member name="P:NPOI.SS.UserModel.IPrintSetup.PageStart">
  28139. Returns the page start.
  28140. @return page start
  28141. </member>
  28142. <member name="P:NPOI.SS.UserModel.IPrintSetup.FitWidth">
  28143. Returns the number of pages wide to fit sheet in.
  28144. @return number of pages wide to fit sheet in
  28145. </member>
  28146. <member name="P:NPOI.SS.UserModel.IPrintSetup.FitHeight">
  28147. Returns the number of pages high to fit the sheet in.
  28148. @return number of pages high to fit the sheet in
  28149. </member>
  28150. <member name="P:NPOI.SS.UserModel.IPrintSetup.LeftToRight">
  28151. Returns the left to right print order.
  28152. @return left to right print order
  28153. </member>
  28154. <member name="P:NPOI.SS.UserModel.IPrintSetup.Landscape">
  28155. Returns the landscape mode.
  28156. @return landscape mode
  28157. </member>
  28158. <member name="P:NPOI.SS.UserModel.IPrintSetup.ValidSettings">
  28159. Returns the valid Settings.
  28160. @return valid Settings
  28161. </member>
  28162. <member name="P:NPOI.SS.UserModel.IPrintSetup.NoColor">
  28163. Returns the black and white Setting.
  28164. @return black and white Setting
  28165. </member>
  28166. <member name="P:NPOI.SS.UserModel.IPrintSetup.Draft">
  28167. Returns the draft mode.
  28168. @return draft mode
  28169. </member>
  28170. <member name="P:NPOI.SS.UserModel.IPrintSetup.Notes">
  28171. Returns the print notes.
  28172. @return print notes
  28173. </member>
  28174. <member name="P:NPOI.SS.UserModel.IPrintSetup.NoOrientation">
  28175. Returns the no orientation.
  28176. @return no orientation
  28177. </member>
  28178. <member name="P:NPOI.SS.UserModel.IPrintSetup.UsePage">
  28179. Returns the use page numbers.
  28180. @return use page numbers
  28181. </member>
  28182. <member name="P:NPOI.SS.UserModel.IPrintSetup.HResolution">
  28183. Returns the horizontal resolution.
  28184. @return horizontal resolution
  28185. </member>
  28186. <member name="P:NPOI.SS.UserModel.IPrintSetup.VResolution">
  28187. Returns the vertical resolution.
  28188. @return vertical resolution
  28189. </member>
  28190. <member name="P:NPOI.SS.UserModel.IPrintSetup.HeaderMargin">
  28191. Returns the header margin.
  28192. @return header margin
  28193. </member>
  28194. <member name="P:NPOI.SS.UserModel.IPrintSetup.FooterMargin">
  28195. Returns the footer margin.
  28196. @return footer margin
  28197. </member>
  28198. <member name="P:NPOI.SS.UserModel.IPrintSetup.Copies">
  28199. Returns the number of copies.
  28200. @return number of copies
  28201. </member>
  28202. <member name="M:NPOI.HSSF.UserModel.HSSFPrintSetup.#ctor(NPOI.HSSF.Record.PrintSetupRecord)">
  28203. <summary>
  28204. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFPrintSetup"/> class.
  28205. </summary>
  28206. <param name="printSetupRecord">Takes the low level print Setup record.</param>
  28207. </member>
  28208. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.PaperSize">
  28209. <summary>
  28210. Gets or sets the size of the paper.
  28211. </summary>
  28212. <value>The size of the paper.</value>
  28213. </member>
  28214. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Scale">
  28215. <summary>
  28216. Gets or sets the scale.
  28217. </summary>
  28218. <value>The scale.</value>
  28219. </member>
  28220. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.PageStart">
  28221. <summary>
  28222. Gets or sets the page start.
  28223. </summary>
  28224. <value>The page start.</value>
  28225. </member>
  28226. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.FitWidth">
  28227. <summary>
  28228. Gets or sets the number of pages wide to fit sheet in.
  28229. </summary>
  28230. <value>the number of pages wide to fit sheet in</value>
  28231. </member>
  28232. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.FitHeight">
  28233. <summary>
  28234. Gets or sets number of pages high to fit the sheet in
  28235. </summary>
  28236. <value>number of pages high to fit the sheet in.</value>
  28237. </member>
  28238. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Options">
  28239. <summary>
  28240. Gets or sets the bit flags for the options.
  28241. </summary>
  28242. <value>the bit flags for the options.</value>
  28243. </member>
  28244. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.LeftToRight">
  28245. <summary>
  28246. Gets or sets the left to right print order.
  28247. </summary>
  28248. <value>the left to right print order.</value>
  28249. </member>
  28250. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Landscape">
  28251. <summary>
  28252. Gets or sets the landscape mode.
  28253. </summary>
  28254. <value>the landscape mode.</value>
  28255. </member>
  28256. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.ValidSettings">
  28257. <summary>
  28258. Gets or sets the valid Settings.
  28259. </summary>
  28260. <value>the valid Settings.</value>
  28261. </member>
  28262. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.NoColor">
  28263. <summary>
  28264. Gets or sets the black and white Setting.
  28265. </summary>
  28266. <value>black and white Setting</value>
  28267. </member>
  28268. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Draft">
  28269. <summary>
  28270. Gets or sets the draft mode.
  28271. </summary>
  28272. <value>the draft mode.</value>
  28273. </member>
  28274. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Notes">
  28275. <summary>
  28276. Gets or sets the print notes.
  28277. </summary>
  28278. <value>the print notes.</value>
  28279. </member>
  28280. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.NoOrientation">
  28281. <summary>
  28282. Gets or sets a value indicating whether [no orientation].
  28283. </summary>
  28284. <value><c>true</c> if [no orientation]; otherwise, <c>false</c>.</value>
  28285. </member>
  28286. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.UsePage">
  28287. <summary>
  28288. Gets or sets the use page numbers.
  28289. </summary>
  28290. <value>use page numbers. </value>
  28291. </member>
  28292. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.HResolution">
  28293. <summary>
  28294. Gets or sets the horizontal resolution.
  28295. </summary>
  28296. <value>the horizontal resolution.</value>
  28297. </member>
  28298. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.VResolution">
  28299. <summary>
  28300. Gets or sets the vertical resolution.
  28301. </summary>
  28302. <value>the vertical resolution.</value>
  28303. </member>
  28304. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.HeaderMargin">
  28305. <summary>
  28306. Gets or sets the header margin.
  28307. </summary>
  28308. <value>The header margin.</value>
  28309. </member>
  28310. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.FooterMargin">
  28311. <summary>
  28312. Gets or sets the footer margin.
  28313. </summary>
  28314. <value>The footer margin.</value>
  28315. </member>
  28316. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Copies">
  28317. <summary>
  28318. Gets or sets the number of copies.
  28319. </summary>
  28320. <value>the number of copies.</value>
  28321. </member>
  28322. <member name="T:NPOI.HSSF.UserModel.HSSFRichTextString">
  28323. <summary>
  28324. Rich text Unicode string. These strings can have fonts applied to
  28325. arbitary parts of the string.
  28326. @author Glen Stampoultzis (glens at apache.org)
  28327. @author Jason Height (jheight at apache.org)
  28328. </summary>
  28329. </member>
  28330. <member name="T:NPOI.SS.UserModel.IRichTextString">
  28331. Rich text unicode string. These strings can have fonts
  28332. applied to arbitary parts of the string.
  28333. @author Glen Stampoultzis (glens at apache.org)
  28334. @author Jason Height (jheight at apache.org)
  28335. </member>
  28336. <member name="M:NPOI.SS.UserModel.IRichTextString.ApplyFont(System.Int32,System.Int32,System.Int16)">
  28337. Applies a font to the specified characters of a string.
  28338. @param startIndex The start index to apply the font to (inclusive)
  28339. @param endIndex The end index to apply the font to (exclusive)
  28340. @param fontIndex The font to use.
  28341. </member>
  28342. <member name="M:NPOI.SS.UserModel.IRichTextString.ApplyFont(System.Int32,System.Int32,NPOI.SS.UserModel.IFont)">
  28343. Applies a font to the specified characters of a string.
  28344. @param startIndex The start index to apply the font to (inclusive)
  28345. @param endIndex The end index to apply to font to (exclusive)
  28346. @param font The index of the font to use.
  28347. </member>
  28348. <member name="M:NPOI.SS.UserModel.IRichTextString.ApplyFont(NPOI.SS.UserModel.IFont)">
  28349. Sets the font of the entire string.
  28350. @param font The font to use.
  28351. </member>
  28352. <member name="M:NPOI.SS.UserModel.IRichTextString.ClearFormatting">
  28353. Removes any formatting that may have been applied to the string.
  28354. </member>
  28355. <member name="M:NPOI.SS.UserModel.IRichTextString.GetIndexOfFormattingRun(System.Int32)">
  28356. The index within the string to which the specified formatting run applies.
  28357. @param index the index of the formatting run
  28358. @return the index within the string.
  28359. </member>
  28360. <member name="M:NPOI.SS.UserModel.IRichTextString.ApplyFont(System.Int16)">
  28361. Applies the specified font to the entire string.
  28362. @param fontIndex the font to apply.
  28363. </member>
  28364. <member name="P:NPOI.SS.UserModel.IRichTextString.String">
  28365. Returns the plain string representation.
  28366. </member>
  28367. <member name="P:NPOI.SS.UserModel.IRichTextString.Length">
  28368. @return the number of characters in the font.
  28369. </member>
  28370. <member name="P:NPOI.SS.UserModel.IRichTextString.NumFormattingRuns">
  28371. @return The number of formatting Runs used.
  28372. </member>
  28373. <member name="F:NPOI.HSSF.UserModel.HSSFRichTextString.NO_FONT">
  28374. Place holder for indicating that NO_FONT has been applied here
  28375. </member>
  28376. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.#ctor">
  28377. <summary>
  28378. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFRichTextString"/> class.
  28379. </summary>
  28380. </member>
  28381. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.#ctor(System.String)">
  28382. <summary>
  28383. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFRichTextString"/> class.
  28384. </summary>
  28385. <param name="str">The string.</param>
  28386. </member>
  28387. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.#ctor(NPOI.HSSF.Model.InternalWorkbook,NPOI.HSSF.Record.LabelSSTRecord)">
  28388. <summary>
  28389. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFRichTextString"/> class.
  28390. </summary>
  28391. <param name="book">The workbook.</param>
  28392. <param name="record">The record.</param>
  28393. </member>
  28394. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.SetWorkbookReferences(NPOI.HSSF.Model.InternalWorkbook,NPOI.HSSF.Record.LabelSSTRecord)">
  28395. <summary>
  28396. This must be called to Setup the internal work book references whenever
  28397. a RichTextString Is Added to a cell
  28398. </summary>
  28399. <param name="book">The workbook.</param>
  28400. <param name="record">The record.</param>
  28401. </member>
  28402. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.CloneStringIfRequired">
  28403. <summary>
  28404. Called whenever the Unicode string Is modified. When it Is modified
  28405. we need to Create a new SST index, so that other LabelSSTRecords will not
  28406. be affected by Changes tat we make to this string.
  28407. </summary>
  28408. <returns></returns>
  28409. </member>
  28410. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.AddToSSTIfRequired">
  28411. <summary>
  28412. Adds to SST if required.
  28413. </summary>
  28414. </member>
  28415. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ApplyFont(System.Int32,System.Int32,System.Int16)">
  28416. <summary>
  28417. Applies a font to the specified Chars of a string.
  28418. </summary>
  28419. <param name="startIndex">The start index to apply the font to (inclusive).</param>
  28420. <param name="endIndex">The end index to apply the font to (exclusive).</param>
  28421. <param name="fontIndex">The font to use.</param>
  28422. </member>
  28423. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ApplyFont(System.Int32,System.Int32,NPOI.SS.UserModel.IFont)">
  28424. <summary>
  28425. Applies a font to the specified Chars of a string.
  28426. </summary>
  28427. <param name="startIndex">The start index to apply the font to (inclusive).</param>
  28428. <param name="endIndex"> The end index to apply to font to (exclusive).</param>
  28429. <param name="font">The index of the font to use.</param>
  28430. </member>
  28431. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ApplyFont(NPOI.SS.UserModel.IFont)">
  28432. <summary>
  28433. Sets the font of the entire string.
  28434. </summary>
  28435. <param name="font">The font to use.</param>
  28436. </member>
  28437. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ClearFormatting">
  28438. <summary>
  28439. Removes any formatting that may have been applied to the string.
  28440. </summary>
  28441. </member>
  28442. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.GetFontAtIndex(System.Int32)">
  28443. <summary>
  28444. Returns the font in use at a particular index.
  28445. </summary>
  28446. <param name="index">The index.</param>
  28447. <returns>The font that's currently being applied at that
  28448. index or null if no font Is being applied or the
  28449. index Is out of range.</returns>
  28450. </member>
  28451. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.GetIndexOfFormattingRun(System.Int32)">
  28452. <summary>
  28453. The index within the string to which the specified formatting run applies.
  28454. </summary>
  28455. <param name="index">the index of the formatting run</param>
  28456. <returns>the index within the string.</returns>
  28457. </member>
  28458. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.GetFontOfFormattingRun(System.Int32)">
  28459. <summary>
  28460. Gets the font used in a particular formatting run.
  28461. </summary>
  28462. <param name="index">the index of the formatting run.</param>
  28463. <returns>the font number used.</returns>
  28464. </member>
  28465. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.CompareTo(NPOI.HSSF.UserModel.HSSFRichTextString)">
  28466. <summary>
  28467. Compares one rich text string to another.
  28468. </summary>
  28469. <param name="other">The other rich text string.</param>
  28470. <returns></returns>
  28471. </member>
  28472. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.Equals(System.Object)">
  28473. <summary>
  28474. Equalses the specified o.
  28475. </summary>
  28476. <param name="o">The o.</param>
  28477. <returns></returns>
  28478. </member>
  28479. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ToString">
  28480. <summary>
  28481. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  28482. </summary>
  28483. <returns>
  28484. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  28485. </returns>
  28486. </member>
  28487. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ApplyFont(System.Int16)">
  28488. <summary>
  28489. Applies the specified font to the entire string.
  28490. </summary>
  28491. <param name="fontIndex">Index of the font to apply.</param>
  28492. </member>
  28493. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.String">
  28494. <summary>
  28495. Returns the plain string representation.
  28496. </summary>
  28497. <value>The string.</value>
  28498. </member>
  28499. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.RawUnicodeString">
  28500. <summary>
  28501. Returns the raw, probably shared Unicode String.
  28502. Used when tweaking the styles, eg updating font
  28503. positions.
  28504. Changes to this string may well effect
  28505. other RichTextStrings too!
  28506. </summary>
  28507. <value>The raw unicode string.</value>
  28508. </member>
  28509. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.UnicodeString">
  28510. <summary>
  28511. Gets or sets the unicode string.
  28512. </summary>
  28513. <value>The unicode string.</value>
  28514. </member>
  28515. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.Length">
  28516. <summary>
  28517. Gets the number of Chars in the font..
  28518. </summary>
  28519. <value>The length.</value>
  28520. </member>
  28521. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.NumFormattingRuns">
  28522. <summary>
  28523. Gets the number of formatting runs used. There will always be at
  28524. least one of font NO_FONT.
  28525. </summary>
  28526. <value>The num formatting runs.</value>
  28527. </member>
  28528. <member name="T:NPOI.HSSF.UserModel.HSSFRow">
  28529. <summary>
  28530. High level representation of a row of a spReadsheet.
  28531. Only rows that have cells should be Added to a Sheet.
  28532. @author Andrew C. Oliver (acoliver at apache dot org)
  28533. @author Glen Stampoultzis (glens at apache.org)
  28534. </summary>
  28535. </member>
  28536. <member name="T:NPOI.SS.UserModel.IRow">
  28537. <summary>
  28538. High level representation of a row of a spreadsheet.
  28539. </summary>
  28540. </member>
  28541. <member name="M:NPOI.SS.UserModel.IRow.CreateCell(System.Int32)">
  28542. <summary>
  28543. Use this to create new cells within the row and return it.
  28544. The cell that is returned is a <see cref="T:NPOI.SS.UserModel.ICell"/>/<see cref="F:NPOI.SS.UserModel.CellType.Blank"/>.
  28545. The type can be changed either through calling <c>SetCellValue</c> or <c>SetCellType</c>.
  28546. </summary>
  28547. <param name="column">the column number this cell represents</param>
  28548. <returns>Cell a high level representation of the created cell.</returns>
  28549. <throws>
  28550. ArgumentException if columnIndex &lt; 0 or greater than the maximum number of supported columns
  28551. (255 for *.xls, 1048576 for *.xlsx)
  28552. </throws>
  28553. </member>
  28554. <member name="M:NPOI.SS.UserModel.IRow.CreateCell(System.Int32,NPOI.SS.UserModel.CellType)">
  28555. <summary>
  28556. Use this to create new cells within the row and return it.
  28557. The cell that is returned is a <see cref="T:NPOI.SS.UserModel.ICell"/>/<see cref="F:NPOI.SS.UserModel.CellType.Blank"/>. The type can be changed
  28558. either through calling <code>SetCellValue</code> or <code>SetCellType</code>.
  28559. </summary>
  28560. <param name="column">the column number this cell represents</param>
  28561. <param name="type"></param>
  28562. <returns>Cell a high level representation of the created cell.</returns>
  28563. <throws>ArgumentException if columnIndex &lt; 0 or greater than the maximum number of supported columns
  28564. (255 for *.xls, 1048576 for *.xlsx)
  28565. </throws>
  28566. </member>
  28567. <member name="M:NPOI.SS.UserModel.IRow.RemoveCell(NPOI.SS.UserModel.ICell)">
  28568. <summary>
  28569. Remove the Cell from this row.
  28570. </summary>
  28571. <param name="cell">the cell to remove</param>
  28572. </member>
  28573. <member name="M:NPOI.SS.UserModel.IRow.GetCell(System.Int32)">
  28574. <summary>
  28575. Get the cell representing a given column (logical cell) 0-based. If you
  28576. ask for a cell that is not defined....you get a null.
  28577. </summary>
  28578. <param name="cellnum">0 based column number</param>
  28579. <returns>Cell representing that column or null if undefined.</returns>
  28580. <see cref="M:NPOI.SS.UserModel.IRow.GetCell(System.Int32,NPOI.SS.UserModel.MissingCellPolicy)"/>
  28581. </member>
  28582. <member name="M:NPOI.SS.UserModel.IRow.GetCell(System.Int32,NPOI.SS.UserModel.MissingCellPolicy)">
  28583. <summary>
  28584. Returns the cell at the given (0 based) index, with the specified {@link NPOI.SS.usermodel.Row.MissingCellPolicy}
  28585. </summary>
  28586. <returns>the cell at the given (0 based) index</returns>
  28587. <throws>ArgumentException if cellnum &lt; 0 or the specified MissingCellPolicy is invalid</throws>
  28588. <see cref="F:NPOI.SS.UserModel.MissingCellPolicy.RETURN_NULL_AND_BLANK"/>
  28589. <see cref="F:NPOI.SS.UserModel.MissingCellPolicy.RETURN_BLANK_AS_NULL"/>
  28590. <see cref="F:NPOI.SS.UserModel.MissingCellPolicy.CREATE_NULL_AS_BLANK"/>
  28591. </member>
  28592. <member name="M:NPOI.SS.UserModel.IRow.MoveCell(NPOI.SS.UserModel.ICell,System.Int32)">
  28593. <summary>
  28594. Moves the supplied cell to a new column, which
  28595. must not already have a cell there!
  28596. </summary>
  28597. <param name="cell">The cell to move</param>
  28598. <param name="newColumn">The new column number (0 based)</param>
  28599. </member>
  28600. <member name="M:NPOI.SS.UserModel.IRow.CopyRowTo(System.Int32)">
  28601. <summary>
  28602. Copy the current row to the target row
  28603. </summary>
  28604. <param name="targetIndex">row index of the target row</param>
  28605. <returns>the new copied row object</returns>
  28606. </member>
  28607. <member name="M:NPOI.SS.UserModel.IRow.CopyCell(System.Int32,System.Int32)">
  28608. <summary>
  28609. Copy the source cell to the target cell. If the target cell exists, the new copied cell will be inserted before the existing one
  28610. </summary>
  28611. <param name="sourceIndex">index of the source cell</param>
  28612. <param name="targetIndex">index of the target cell</param>
  28613. <returns>the new copied cell object</returns>
  28614. </member>
  28615. <member name="P:NPOI.SS.UserModel.IRow.RowNum">
  28616. <summary>
  28617. Get row number this row represents
  28618. </summary>
  28619. <returns>the row number (0 based)</returns>
  28620. </member>
  28621. <member name="P:NPOI.SS.UserModel.IRow.FirstCellNum">
  28622. <summary>
  28623. Get the number of the first cell Contained in this row.
  28624. </summary>
  28625. <returns>
  28626. short representing the first logical cell in the row,
  28627. or -1 if the row does not contain any cells.
  28628. </returns>
  28629. </member>
  28630. <member name="P:NPOI.SS.UserModel.IRow.LastCellNum">
  28631. <summary>
  28632. Gets the index of the last cell Contained in this row <b>PLUS ONE</b>. The result also
  28633. happens to be the 1-based column number of the last cell. This value can be used as a
  28634. standard upper bound when iterating over cells:
  28635. <pre>
  28636. short minColIx = row.GetFirstCellNum();
  28637. short maxColIx = row.GetLastCellNum();
  28638. for(short colIx=minColIx; colIx&lt;maxColIx; colIx++) {
  28639. Cell cell = row.GetCell(colIx);
  28640. if(cell == null) {
  28641. continue;
  28642. }
  28643. //... do something with cell
  28644. }
  28645. </pre>
  28646. </summary>
  28647. <returns>
  28648. short representing the last logical cell in the row <b>PLUS ONE</b>,
  28649. or -1 if the row does not contain any cells.
  28650. </returns>
  28651. </member>
  28652. <member name="P:NPOI.SS.UserModel.IRow.PhysicalNumberOfCells">
  28653. <summary>
  28654. Gets the number of defined cells (NOT number of cells in the actual row!).
  28655. That is to say if only columns 0,4,5 have values then there would be 3.
  28656. </summary>
  28657. <returns>int representing the number of defined cells in the row.</returns>
  28658. </member>
  28659. <member name="P:NPOI.SS.UserModel.IRow.ZeroHeight">
  28660. <summary>
  28661. Get whether or not to display this row with 0 height
  28662. </summary>
  28663. <returns>zHeight height is zero or not.</returns>
  28664. </member>
  28665. <member name="P:NPOI.SS.UserModel.IRow.Height">
  28666. <summary>
  28667. Get the row's height measured in twips (1/20th of a point).
  28668. If the height is not set, the default worksheet value is returned,
  28669. <see cref="P:NPOI.SS.UserModel.ISheet.DefaultRowHeightInPoints"/>
  28670. </summary>
  28671. <returns>row height measured in twips (1/20th of a point)</returns>
  28672. </member>
  28673. <member name="P:NPOI.SS.UserModel.IRow.HeightInPoints">
  28674. <summary>
  28675. Returns row height measured in point size.
  28676. If the height is not set, the default worksheet value is returned,
  28677. <see cref="P:NPOI.SS.UserModel.ISheet.DefaultRowHeightInPoints"/>
  28678. </summary>
  28679. <returns>row height measured in point size
  28680. <see cref="P:NPOI.SS.UserModel.ISheet.DefaultRowHeightInPoints"/>
  28681. </returns>
  28682. </member>
  28683. <member name="P:NPOI.SS.UserModel.IRow.IsFormatted">
  28684. <summary>
  28685. Is this row formatted? Most aren't, but some rows
  28686. do have whole-row styles. For those that do, you
  28687. can get the formatting from <see cref="P:NPOI.SS.UserModel.IRow.RowStyle"/>
  28688. </summary>
  28689. </member>
  28690. <member name="P:NPOI.SS.UserModel.IRow.Sheet">
  28691. <summary>
  28692. Returns the Sheet this row belongs to
  28693. </summary>
  28694. <returns>the Sheet that owns this row</returns>
  28695. </member>
  28696. <member name="P:NPOI.SS.UserModel.IRow.RowStyle">
  28697. <summary>
  28698. Returns the whole-row cell styles. Most rows won't
  28699. have one of these, so will return null. Call IsFormmated to check first
  28700. </summary>
  28701. <value>The row style.</value>
  28702. </member>
  28703. <member name="P:NPOI.SS.UserModel.IRow.Cells">
  28704. <summary>
  28705. Get cells in the row
  28706. </summary>
  28707. </member>
  28708. <member name="P:NPOI.SS.UserModel.IRow.OutlineLevel">
  28709. <summary>
  28710. Returns the rows outline level. Increased as you
  28711. put it into more groups (outlines), reduced as
  28712. you take it out of them.
  28713. </summary>
  28714. </member>
  28715. <member name="F:NPOI.HSSF.UserModel.HSSFRow.INITIAL_CAPACITY">
  28716. <summary>
  28717. used for collections
  28718. </summary>
  28719. </member>
  28720. <member name="F:NPOI.HSSF.UserModel.HSSFRow.row">
  28721. reference to low level representation
  28722. </member>
  28723. <member name="F:NPOI.HSSF.UserModel.HSSFRow.book">
  28724. reference to containing low level Workbook
  28725. </member>
  28726. <member name="F:NPOI.HSSF.UserModel.HSSFRow.sheet">
  28727. reference to containing Sheet
  28728. </member>
  28729. <member name="M:NPOI.HSSF.UserModel.HSSFRow.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32)">
  28730. <summary>
  28731. Creates new HSSFRow from scratch. Only HSSFSheet should do this.
  28732. </summary>
  28733. <param name="book">low-level Workbook object containing the sheet that Contains this row</param>
  28734. <param name="sheet">low-level Sheet object that Contains this Row</param>
  28735. <param name="rowNum">the row number of this row (0 based)</param>
  28736. <see cref="M:NPOI.HSSF.UserModel.HSSFSheet.CreateRow(System.Int32)"/>
  28737. </member>
  28738. <member name="M:NPOI.HSSF.UserModel.HSSFRow.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.Record.RowRecord)">
  28739. <summary>
  28740. Creates an HSSFRow from a low level RowRecord object. Only HSSFSheet should do
  28741. this. HSSFSheet uses this when an existing file is Read in.
  28742. </summary>
  28743. <param name="book">low-level Workbook object containing the sheet that Contains this row</param>
  28744. <param name="sheet"> low-level Sheet object that Contains this Row</param>
  28745. <param name="record">the low level api object this row should represent</param>
  28746. <see cref="M:NPOI.HSSF.UserModel.HSSFSheet.CreateRow(System.Int32)"/>
  28747. </member>
  28748. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CreateCell(System.Int32)">
  28749. <summary>
  28750. Use this to create new cells within the row and return it.
  28751. The cell that is returned is a CELL_TYPE_BLANK (<see cref="T:NPOI.SS.UserModel.ICell"/>/<see cref="F:NPOI.SS.UserModel.CellType.Blank"/>).
  28752. The type can be changed either through calling <c>SetCellValue</c> or <c>SetCellType</c>.
  28753. </summary>
  28754. <param name="column">the column number this cell represents</param>
  28755. <returns>a high level representation of the created cell.</returns>
  28756. </member>
  28757. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CreateCell(System.Int32,NPOI.SS.UserModel.CellType)">
  28758. <summary>
  28759. Use this to create new cells within the row and return it.
  28760. The cell that is returned is a CELL_TYPE_BLANK. The type can be changed
  28761. either through calling setCellValue or setCellType.
  28762. </summary>
  28763. <param name="columnIndex">the column number this cell represents</param>
  28764. <param name="type">a high level representation of the created cell.</param>
  28765. <returns></returns>
  28766. </member>
  28767. <member name="M:NPOI.HSSF.UserModel.HSSFRow.RemoveCell(NPOI.SS.UserModel.ICell)">
  28768. <summary>
  28769. Remove the Cell from this row.
  28770. </summary>
  28771. <param name="cell">The cell to Remove.</param>
  28772. </member>
  28773. <member name="M:NPOI.HSSF.UserModel.HSSFRow.RemoveCell(NPOI.SS.UserModel.ICell,System.Boolean)">
  28774. <summary>
  28775. Removes the cell.
  28776. </summary>
  28777. <param name="cell">The cell.</param>
  28778. <param name="alsoRemoveRecords">if set to <c>true</c> [also remove records].</param>
  28779. </member>
  28780. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CalculateNewLastCellPlusOne(System.Int32)">
  28781. used internally to refresh the "last cell plus one" when the last cell is removed.
  28782. @return 0 when row contains no cells
  28783. </member>
  28784. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CalculateNewFirstCell(System.Int32)">
  28785. used internally to refresh the "first cell" when the first cell is removed.
  28786. @return 0 when row contains no cells (also when first cell is occupied)
  28787. </member>
  28788. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CreateCellFromRecord(NPOI.HSSF.Record.CellValueRecordInterface)">
  28789. <summary>
  28790. Create a high level Cell object from an existing low level record. Should
  28791. only be called from HSSFSheet or HSSFRow itself.
  28792. </summary>
  28793. <param name="cell">The low level cell to Create the high level representation from</param>
  28794. <returns> the low level record passed in</returns>
  28795. </member>
  28796. <member name="M:NPOI.HSSF.UserModel.HSSFRow.RemoveAllCells">
  28797. <summary>
  28798. Removes all the cells from the row, and their
  28799. records too.
  28800. </summary>
  28801. </member>
  28802. <member name="M:NPOI.HSSF.UserModel.HSSFRow.MoveCell(NPOI.SS.UserModel.ICell,System.Int32)">
  28803. <summary>
  28804. Moves the supplied cell to a new column, which
  28805. must not already have a cell there!
  28806. </summary>
  28807. <param name="cell">The cell to move</param>
  28808. <param name="newColumn">The new column number (0 based)</param>
  28809. </member>
  28810. <member name="M:NPOI.HSSF.UserModel.HSSFRow.AddCell(NPOI.SS.UserModel.ICell)">
  28811. <summary>
  28812. used internally to Add a cell.
  28813. </summary>
  28814. <param name="cell">The cell.</param>
  28815. </member>
  28816. <member name="M:NPOI.HSSF.UserModel.HSSFRow.RetrieveCell(System.Int32)">
  28817. <summary>
  28818. Get the hssfcell representing a given column (logical cell)
  28819. 0-based. If you ask for a cell that is not defined, then
  28820. you Get a null.
  28821. This is the basic call, with no policies applied
  28822. </summary>
  28823. <param name="cellnum">0 based column number</param>
  28824. <returns>Cell representing that column or null if Undefined.</returns>
  28825. </member>
  28826. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetCell(System.Int16)">
  28827. <summary>
  28828. Get the hssfcell representing a given column (logical cell)
  28829. 0-based. If you ask for a cell that is not defined then
  28830. you get a null, unless you have set a different
  28831. MissingCellPolicy on the base workbook.
  28832. Short method signature provided to retain binary
  28833. compatibility.
  28834. </summary>
  28835. <param name="cellnum">0 based column number</param>
  28836. <returns>Cell representing that column or null if undefined.</returns>
  28837. </member>
  28838. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetCell(System.Int32)">
  28839. <summary>
  28840. Get the hssfcell representing a given column (logical cell)
  28841. 0-based. If you ask for a cell that is not defined then
  28842. you get a null, unless you have set a different
  28843. MissingCellPolicy on the base workbook.
  28844. </summary>
  28845. <param name="cellnum">0 based column number</param>
  28846. <returns>Cell representing that column or null if undefined.</returns>
  28847. </member>
  28848. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetCell(System.Int32,NPOI.SS.UserModel.MissingCellPolicy)">
  28849. <summary>
  28850. Get the hssfcell representing a given column (logical cell)
  28851. 0-based. If you ask for a cell that is not defined, then
  28852. your supplied policy says what to do
  28853. </summary>
  28854. <param name="cellnum">0 based column number</param>
  28855. <param name="policy">Policy on blank / missing cells</param>
  28856. <returns>that column or null if Undefined + policy allows.</returns>
  28857. </member>
  28858. <member name="M:NPOI.HSSF.UserModel.HSSFRow.FindFirstCell(System.Int32)">
  28859. <summary>
  28860. used internally to refresh the "first cell" when the first cell is Removed.
  28861. </summary>
  28862. <param name="firstcell">The first cell index.</param>
  28863. <returns></returns>
  28864. </member>
  28865. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetEnumerator">
  28866. <summary>
  28867. Gets the cell enumerator of the physically defined cells.
  28868. </summary>
  28869. <remarks>
  28870. Note that the 4th element might well not be cell 4, as the iterator
  28871. will not return Un-defined (null) cells.
  28872. Call CellNum on the returned cells to know which cell they are.
  28873. </remarks>
  28874. </member>
  28875. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CompareTo(System.Object)">
  28876. <summary>
  28877. Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
  28878. </summary>
  28879. <param name="obj">An object to compare with this instance.</param>
  28880. <returns>
  28881. A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings:
  28882. Value
  28883. Meaning
  28884. Less than zero
  28885. This instance is less than <paramref name="obj"/>.
  28886. Zero
  28887. This instance is equal to <paramref name="obj"/>.
  28888. Greater than zero
  28889. This instance is greater than <paramref name="obj"/>.
  28890. </returns>
  28891. <exception cref="T:System.ArgumentException">
  28892. <paramref name="obj"/> is not the same type as this instance.
  28893. </exception>
  28894. </member>
  28895. <member name="M:NPOI.HSSF.UserModel.HSSFRow.Equals(System.Object)">
  28896. <summary>
  28897. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  28898. </summary>
  28899. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
  28900. <returns>
  28901. true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
  28902. </returns>
  28903. <exception cref="T:System.NullReferenceException">
  28904. The <paramref name="obj"/> parameter is null.
  28905. </exception>
  28906. </member>
  28907. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetHashCode">
  28908. <summary>
  28909. Returns a hash code. In this case it is the number of the row.
  28910. </summary>
  28911. </member>
  28912. <member name="P:NPOI.HSSF.UserModel.HSSFRow.IsHidden">
  28913. <summary>
  28914. true, when the row is invisible. This is the case when the height is zero.
  28915. </summary>
  28916. </member>
  28917. <member name="P:NPOI.HSSF.UserModel.HSSFRow.RowNum">
  28918. <summary>
  28919. Get row number this row represents
  28920. </summary>
  28921. <value>the row number (0 based)</value>
  28922. </member>
  28923. <member name="P:NPOI.HSSF.UserModel.HSSFRow.OutlineLevel">
  28924. <summary>
  28925. Returns the rows outline level. Increased as you
  28926. put it into more Groups (outlines), reduced as
  28927. you take it out of them.
  28928. </summary>
  28929. <value>The outline level.</value>
  28930. </member>
  28931. <member name="P:NPOI.HSSF.UserModel.HSSFRow.Sheet">
  28932. Returns the HSSFSheet this row belongs to
  28933. @return the HSSFSheet that owns this row
  28934. </member>
  28935. <member name="P:NPOI.HSSF.UserModel.HSSFRow.FirstCellNum">
  28936. <summary>
  28937. Get the number of the first cell contained in this row.
  28938. </summary>
  28939. <value>the first logical cell in the row, or -1 if the row does not contain any cells.</value>
  28940. </member>
  28941. <member name="P:NPOI.HSSF.UserModel.HSSFRow.LastCellNum">
  28942. <summary>
  28943. Gets the index of the last cell contained in this row PLUS ONE
  28944. . The result also happens to be the 1-based column number of the last cell. This value can be used as a
  28945. standard upper bound when iterating over cells:
  28946. </summary>
  28947. <value>
  28948. short representing the last logical cell in the row PLUS ONE, or -1 if the
  28949. row does not contain any cells.
  28950. </value>
  28951. <example>
  28952. short minColIx = row.GetFirstCellNum();
  28953. short maxColIx = row.GetLastCellNum();
  28954. for(short colIx=minColIx; colIx&lt;maxColIx; colIx++) {
  28955. Cell cell = row.GetCell(colIx);
  28956. if(cell == null) {
  28957. continue;
  28958. }
  28959. //... do something with cell
  28960. }
  28961. </example>
  28962. </member>
  28963. <member name="P:NPOI.HSSF.UserModel.HSSFRow.PhysicalNumberOfCells">
  28964. <summary>
  28965. Gets the number of defined cells (NOT number of cells in the actual row!).
  28966. That is to say if only columns 0,4,5 have values then there would be 3.
  28967. </summary>
  28968. <value>the number of defined cells in the row.</value>
  28969. </member>
  28970. <member name="P:NPOI.HSSF.UserModel.HSSFRow.ZeroHeight">
  28971. <summary>
  28972. Gets or sets whether or not to Display this row with 0 height
  28973. </summary>
  28974. <value>height is zero or not.</value>
  28975. </member>
  28976. <member name="P:NPOI.HSSF.UserModel.HSSFRow.Height">
  28977. <summary>
  28978. Get or sets the row's height or ff (-1) for undefined/default-height in twips (1/20th of a point)
  28979. </summary>
  28980. <value>rowheight or 0xff for Undefined (use sheet default)</value>
  28981. </member>
  28982. <member name="P:NPOI.HSSF.UserModel.HSSFRow.IsFormatted">
  28983. <summary>
  28984. is this row formatted? Most aren't, but some rows
  28985. do have whole-row styles. For those that do, you
  28986. can get the formatting from {@link #getRowStyle()}
  28987. </summary>
  28988. <value>
  28989. <c>true</c> if this instance is formatted; otherwise, <c>false</c>.
  28990. </value>
  28991. </member>
  28992. <member name="P:NPOI.HSSF.UserModel.HSSFRow.RowStyle">
  28993. <summary>
  28994. Returns the whole-row cell styles. Most rows won't
  28995. have one of these, so will return null. Call IsFormmated to check first
  28996. </summary>
  28997. <value>The row style.</value>
  28998. </member>
  28999. <member name="P:NPOI.HSSF.UserModel.HSSFRow.HeightInPoints">
  29000. <summary>
  29001. Get the row's height or ff (-1) for Undefined/default-height in points (20*Height)
  29002. </summary>
  29003. <value>row height or 0xff for Undefined (use sheet default).</value>
  29004. </member>
  29005. <member name="P:NPOI.HSSF.UserModel.HSSFRow.RowRecord">
  29006. <summary>
  29007. Get the lowlevel RowRecord represented by this object - should only be called
  29008. by other parts of the high level API
  29009. </summary>
  29010. <value>RowRecord this row represents</value>
  29011. </member>
  29012. <member name="P:NPOI.HSSF.UserModel.HSSFRow.Cells">
  29013. <summary>
  29014. Get cells in the row (existing cells only, no blanks)
  29015. </summary>
  29016. </member>
  29017. <member name="T:NPOI.HSSF.UserModel.HSSFShapeGroup">
  29018. <summary>
  29019. A shape Group may contain other shapes. It was no actual form on the
  29020. sheet.
  29021. @author Glen Stampoultzis (glens at apache.org)
  29022. </summary>
  29023. </member>
  29024. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreateGroup(NPOI.HSSF.UserModel.HSSFChildAnchor)">
  29025. <summary>
  29026. Create another Group Under this Group.
  29027. </summary>
  29028. <param name="anchor">the position of the new Group.</param>
  29029. <returns>the Group</returns>
  29030. </member>
  29031. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreateShape(NPOI.HSSF.UserModel.HSSFChildAnchor)">
  29032. <summary>
  29033. Create a new simple shape Under this Group.
  29034. </summary>
  29035. <param name="anchor">the position of the shape.</param>
  29036. <returns>the shape</returns>
  29037. </member>
  29038. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreateTextbox(NPOI.HSSF.UserModel.HSSFChildAnchor)">
  29039. <summary>
  29040. Create a new textbox Under this Group.
  29041. </summary>
  29042. <param name="anchor">the position of the shape.</param>
  29043. <returns>the textbox</returns>
  29044. </member>
  29045. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreatePolygon(NPOI.HSSF.UserModel.HSSFChildAnchor)">
  29046. <summary>
  29047. Creates a polygon
  29048. </summary>
  29049. <param name="anchor">the client anchor describes how this Group Is attached
  29050. to the sheet.</param>
  29051. <returns>the newly Created shape.</returns>
  29052. </member>
  29053. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreatePicture(NPOI.HSSF.UserModel.HSSFChildAnchor,System.Int32)">
  29054. <summary>
  29055. Creates a picture.
  29056. </summary>
  29057. <param name="anchor">the client anchor describes how this Group Is attached
  29058. to the sheet.</param>
  29059. <param name="pictureIndex">Index of the picture.</param>
  29060. <returns>the newly Created shape.</returns>
  29061. </member>
  29062. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.SetCoordinates(System.Int32,System.Int32,System.Int32,System.Int32)">
  29063. <summary>
  29064. Sets the coordinate space of this Group. All children are constrained
  29065. to these coordinates.
  29066. </summary>
  29067. <param name="x1">The x1.</param>
  29068. <param name="y1">The y1.</param>
  29069. <param name="x2">The x2.</param>
  29070. <param name="y2">The y2.</param>
  29071. </member>
  29072. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.Children">
  29073. <summary>
  29074. Return all children contained by this shape.
  29075. </summary>
  29076. <value></value>
  29077. </member>
  29078. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.X1">
  29079. <summary>
  29080. Gets The top left x coordinate of this Group.
  29081. </summary>
  29082. <value>The x1.</value>
  29083. </member>
  29084. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.Y1">
  29085. <summary>
  29086. Gets The top left y coordinate of this Group.
  29087. </summary>
  29088. <value>The y1.</value>
  29089. </member>
  29090. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.X2">
  29091. <summary>
  29092. Gets The bottom right x coordinate of this Group.
  29093. </summary>
  29094. <value>The x2.</value>
  29095. </member>
  29096. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.Y2">
  29097. <summary>
  29098. Gets the bottom right y coordinate of this Group.
  29099. </summary>
  29100. <value>The y2.</value>
  29101. </member>
  29102. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.CountOfAllChildren">
  29103. <summary>
  29104. Count of all children and their childrens children.
  29105. </summary>
  29106. <value></value>
  29107. </member>
  29108. <member name="T:NPOI.HSSF.UserModel.HSSFSheet">
  29109. <summary>
  29110. High level representation of a worksheet.
  29111. </summary>
  29112. <remarks>
  29113. @author Andrew C. Oliver (acoliver at apache dot org)
  29114. @author Glen Stampoultzis (glens at apache.org)
  29115. @author Libin Roman (romal at vistaportal.com)
  29116. @author Shawn Laubach (slaubach at apache dot org) (Just a little)
  29117. @author Jean-Pierre Paris (jean-pierre.paris at m4x dot org) (Just a little, too)
  29118. @author Yegor Kozlov (yegor at apache.org) (Autosizing columns)
  29119. </remarks>
  29120. </member>
  29121. <member name="T:NPOI.SS.UserModel.ISheet">
  29122. <summary>
  29123. High level representation of a Excel worksheet.
  29124. </summary>
  29125. <remarks>
  29126. Sheets are the central structures within a workbook, and are where a user does most of his spreadsheet work.
  29127. The most common type of sheet is the worksheet, which is represented as a grid of cells. Worksheet cells can
  29128. contain text, numbers, dates, and formulas. Cells can also be formatted.
  29129. </remarks>
  29130. </member>
  29131. <member name="M:NPOI.SS.UserModel.ISheet.CreateRow(System.Int32)">
  29132. <summary>
  29133. Create a new row within the sheet and return the high level representation
  29134. </summary>
  29135. <param name="rownum">The row number.</param>
  29136. <returns>high level Row object representing a row in the sheet</returns>
  29137. <see>RemoveRow(Row)</see>
  29138. </member>
  29139. <member name="M:NPOI.SS.UserModel.ISheet.RemoveRow(NPOI.SS.UserModel.IRow)">
  29140. <summary>
  29141. Remove a row from this sheet. All cells Contained in the row are Removed as well
  29142. </summary>
  29143. <param name="row">a row to Remove.</param>
  29144. </member>
  29145. <member name="M:NPOI.SS.UserModel.ISheet.GetRow(System.Int32)">
  29146. <summary>
  29147. Returns the logical row (not physical) 0-based. If you ask for a row that is not
  29148. defined you get a null. This is to say row 4 represents the fifth row on a sheet.
  29149. </summary>
  29150. <param name="rownum">row to get (0-based).</param>
  29151. <returns>the rownumber or null if its not defined on the sheet</returns>
  29152. </member>
  29153. <member name="M:NPOI.SS.UserModel.ISheet.SetColumnHidden(System.Int32,System.Boolean)">
  29154. <summary>
  29155. Get the visibility state for a given column
  29156. </summary>
  29157. <param name="columnIndex">the column to get (0-based)</param>
  29158. <param name="hidden">the visiblity state of the column</param>
  29159. </member>
  29160. <member name="M:NPOI.SS.UserModel.ISheet.IsColumnHidden(System.Int32)">
  29161. <summary>
  29162. Get the hidden state for a given column
  29163. </summary>
  29164. <param name="columnIndex">the column to set (0-based)</param>
  29165. <returns>hidden - <c>false</c> if the column is visible</returns>
  29166. </member>
  29167. <member name="M:NPOI.SS.UserModel.ISheet.CopyRow(System.Int32,System.Int32)">
  29168. <summary>
  29169. Copy the source row to the target row. If the target row exists, the new copied row will be inserted before the existing one
  29170. </summary>
  29171. <param name="sourceIndex">source index</param>
  29172. <param name="targetIndex">target index</param>
  29173. <returns>the new copied row object</returns>
  29174. </member>
  29175. <member name="M:NPOI.SS.UserModel.ISheet.SetColumnWidth(System.Int32,System.Int32)">
  29176. <summary>
  29177. Set the width (in units of 1/256th of a character width)
  29178. </summary>
  29179. <param name="columnIndex">the column to set (0-based)</param>
  29180. <param name="width">the width in units of 1/256th of a character width</param>
  29181. <remarks>
  29182. The maximum column width for an individual cell is 255 characters.
  29183. This value represents the number of characters that can be displayed
  29184. in a cell that is formatted with the standard font.
  29185. </remarks>
  29186. </member>
  29187. <member name="M:NPOI.SS.UserModel.ISheet.GetColumnWidth(System.Int32)">
  29188. <summary>
  29189. get the width (in units of 1/256th of a character width )
  29190. </summary>
  29191. <param name="columnIndex">the column to get (0-based)</param>
  29192. <returns>the width in units of 1/256th of a character width</returns>
  29193. </member>
  29194. <member name="M:NPOI.SS.UserModel.ISheet.GetColumnWidthInPixels(System.Int32)">
  29195. <summary>
  29196. get the width in pixel
  29197. </summary>
  29198. <param name="columnIndex"></param>
  29199. <returns></returns>
  29200. <remarks>
  29201. Please note, that this method works correctly only for workbooks
  29202. with the default font size (Arial 10pt for .xls and Calibri 11pt for .xlsx).
  29203. If the default font is changed the column width can be streched
  29204. </remarks>
  29205. </member>
  29206. <member name="M:NPOI.SS.UserModel.ISheet.GetColumnStyle(System.Int32)">
  29207. <summary>
  29208. Returns the CellStyle that applies to the given
  29209. (0 based) column, or null if no style has been
  29210. set for that column
  29211. </summary>
  29212. <param name="column">The column.</param>
  29213. </member>
  29214. <member name="M:NPOI.SS.UserModel.ISheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  29215. <summary>
  29216. Adds a merged region of cells (hence those cells form one)
  29217. </summary>
  29218. <param name="region">(rowfrom/colfrom-rowto/colto) to merge.</param>
  29219. <returns>index of this region</returns>
  29220. </member>
  29221. <member name="M:NPOI.SS.UserModel.ISheet.RemoveMergedRegion(System.Int32)">
  29222. <summary>
  29223. Removes a merged region of cells (hence letting them free)
  29224. </summary>
  29225. <param name="index">index of the region to unmerge</param>
  29226. </member>
  29227. <member name="M:NPOI.SS.UserModel.ISheet.GetMergedRegion(System.Int32)">
  29228. <summary>
  29229. Returns the merged region at the specified index
  29230. </summary>
  29231. <param name="index">The index.</param>
  29232. </member>
  29233. <member name="M:NPOI.SS.UserModel.ISheet.GetRowEnumerator">
  29234. <summary>
  29235. Gets the row enumerator.
  29236. </summary>
  29237. <returns>
  29238. an iterator of the PHYSICAL rows. Meaning the 3rd element may not
  29239. be the third row if say for instance the second row is undefined.
  29240. Call <see cref="P:NPOI.SS.UserModel.IRow.RowNum"/> on each row
  29241. if you care which one it is.
  29242. </returns>
  29243. </member>
  29244. <member name="M:NPOI.SS.UserModel.ISheet.GetEnumerator">
  29245. <summary>
  29246. Get the row enumerator
  29247. </summary>
  29248. <returns></returns>
  29249. </member>
  29250. <member name="M:NPOI.SS.UserModel.ISheet.GetMargin(NPOI.SS.UserModel.MarginType)">
  29251. <summary>
  29252. Gets the size of the margin in inches.
  29253. </summary>
  29254. <param name="margin">which margin to get</param>
  29255. <returns>the size of the margin</returns>
  29256. </member>
  29257. <member name="M:NPOI.SS.UserModel.ISheet.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  29258. <summary>
  29259. Sets the size of the margin in inches.
  29260. </summary>
  29261. <param name="margin">which margin to get</param>
  29262. <param name="size">the size of the margin</param>
  29263. </member>
  29264. <member name="M:NPOI.SS.UserModel.ISheet.ProtectSheet(System.String)">
  29265. <summary>
  29266. Sets the protection enabled as well as the password
  29267. </summary>
  29268. <param name="password">to set for protection. Pass <code>null</code> to remove protection</param>
  29269. </member>
  29270. <member name="M:NPOI.SS.UserModel.ISheet.SetZoom(System.Int32,System.Int32)">
  29271. <summary>
  29272. Sets the zoom magnication for the sheet. The zoom is expressed as a
  29273. fraction. For example to express a zoom of 75% use 3 for the numerator
  29274. and 4 for the denominator.
  29275. </summary>
  29276. <param name="numerator">The numerator for the zoom magnification.</param>
  29277. <param name="denominator">denominator for the zoom magnification.</param>
  29278. </member>
  29279. <member name="M:NPOI.SS.UserModel.ISheet.ShowInPane(System.Int32,System.Int32)">
  29280. <summary>
  29281. Sets desktop window pane display area, when the file is first opened in a viewer.
  29282. </summary>
  29283. <param name="toprow">the top row to show in desktop window pane</param>
  29284. <param name="leftcol">the left column to show in desktop window pane</param>
  29285. </member>
  29286. <member name="M:NPOI.SS.UserModel.ISheet.ShowInPane(System.Int16,System.Int16)">
  29287. <summary>
  29288. Sets desktop window pane display area, when the
  29289. file is first opened in a viewer.
  29290. </summary>
  29291. <param name="toprow"> the top row to show in desktop window pane</param>
  29292. <param name="leftcol"> the left column to show in desktop window pane</param>
  29293. </member>
  29294. <member name="M:NPOI.SS.UserModel.ISheet.ShiftRows(System.Int32,System.Int32,System.Int32)">
  29295. <summary>
  29296. Shifts rows between startRow and endRow n number of rows.
  29297. If you use a negative number, it will shift rows up.
  29298. Code ensures that rows don't wrap around.
  29299. Calls shiftRows(startRow, endRow, n, false, false);
  29300. Additionally shifts merged regions that are completely defined in these
  29301. rows (ie. merged 2 cells on a row to be shifted).
  29302. </summary>
  29303. <param name="startRow">the row to start shifting</param>
  29304. <param name="endRow">the row to end shifting</param>
  29305. <param name="n">the number of rows to shift</param>
  29306. </member>
  29307. <member name="M:NPOI.SS.UserModel.ISheet.ShiftRows(System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean)">
  29308. <summary>
  29309. Shifts rows between startRow and endRow n number of rows.
  29310. If you use a negative number, it will shift rows up.
  29311. Code ensures that rows don't wrap around
  29312. Additionally shifts merged regions that are completely defined in these
  29313. rows (ie. merged 2 cells on a row to be shifted).
  29314. </summary>
  29315. <param name="startRow">the row to start shifting</param>
  29316. <param name="endRow">the row to end shifting</param>
  29317. <param name="n">the number of rows to shift</param>
  29318. <param name="copyRowHeight">whether to copy the row height during the shift</param>
  29319. <param name="resetOriginalRowHeight">whether to set the original row's height to the default</param>
  29320. </member>
  29321. <member name="M:NPOI.SS.UserModel.ISheet.CreateFreezePane(System.Int32,System.Int32,System.Int32,System.Int32)">
  29322. <summary>
  29323. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  29324. </summary>
  29325. <param name="colSplit">Horizonatal position of split</param>
  29326. <param name="rowSplit">Vertical position of split</param>
  29327. <param name="leftmostColumn">Top row visible in bottom pane</param>
  29328. <param name="topRow">Left column visible in right pane</param>
  29329. </member>
  29330. <member name="M:NPOI.SS.UserModel.ISheet.CreateFreezePane(System.Int32,System.Int32)">
  29331. <summary>
  29332. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  29333. </summary>
  29334. <param name="colSplit">Horizonatal position of split.</param>
  29335. <param name="rowSplit">Vertical position of split.</param>
  29336. </member>
  29337. <member name="M:NPOI.SS.UserModel.ISheet.CreateSplitPane(System.Int32,System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  29338. <summary>
  29339. Creates a split pane. Any existing freezepane or split pane is overwritten.
  29340. </summary>
  29341. <param name="xSplitPos">Horizonatal position of split (in 1/20th of a point)</param>
  29342. <param name="ySplitPos">Vertical position of split (in 1/20th of a point)</param>
  29343. <param name="leftmostColumn">Left column visible in right pane</param>
  29344. <param name="topRow">Top row visible in bottom pane</param>
  29345. <param name="activePane">Active pane. One of: PANE_LOWER_RIGHT, PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT</param>
  29346. @see #PANE_LOWER_LEFT
  29347. @see #PANE_LOWER_RIGHT
  29348. @see #PANE_UPPER_LEFT
  29349. @see #PANE_UPPER_RIGHT
  29350. </member>
  29351. <member name="M:NPOI.SS.UserModel.ISheet.IsRowBroken(System.Int32)">
  29352. <summary>
  29353. Determines if there is a page break at the indicated row
  29354. </summary>
  29355. <param name="row">The row.</param>
  29356. </member>
  29357. <member name="M:NPOI.SS.UserModel.ISheet.RemoveRowBreak(System.Int32)">
  29358. <summary>
  29359. Removes the page break at the indicated row
  29360. </summary>
  29361. <param name="row">The row index.</param>
  29362. </member>
  29363. <member name="M:NPOI.SS.UserModel.ISheet.SetActiveCell(System.Int32,System.Int32)">
  29364. <summary>
  29365. Sets the active cell.
  29366. </summary>
  29367. <param name="row">The row.</param>
  29368. <param name="column">The column.</param>
  29369. </member>
  29370. <member name="M:NPOI.SS.UserModel.ISheet.SetActiveCellRange(System.Int32,System.Int32,System.Int32,System.Int32)">
  29371. <summary>
  29372. Sets the active cell range.
  29373. </summary>
  29374. <param name="firstRow">The firstrow.</param>
  29375. <param name="lastRow">The lastrow.</param>
  29376. <param name="firstColumn">The firstcolumn.</param>
  29377. <param name="lastColumn">The lastcolumn.</param>
  29378. </member>
  29379. <member name="M:NPOI.SS.UserModel.ISheet.SetActiveCellRange(System.Collections.Generic.List{NPOI.SS.Util.CellRangeAddress8Bit},System.Int32,System.Int32,System.Int32)">
  29380. <summary>
  29381. Sets the active cell range.
  29382. </summary>
  29383. <param name="cellranges">The cellranges.</param>
  29384. <param name="activeRange">The index of the active range.</param>
  29385. <param name="activeRow">The active row in the active range</param>
  29386. <param name="activeColumn">The active column in the active range</param>
  29387. </member>
  29388. <member name="M:NPOI.SS.UserModel.ISheet.SetColumnBreak(System.Int32)">
  29389. <summary>
  29390. Sets a page break at the indicated column
  29391. </summary>
  29392. <param name="column">The column.</param>
  29393. </member>
  29394. <member name="M:NPOI.SS.UserModel.ISheet.SetRowBreak(System.Int32)">
  29395. <summary>
  29396. Sets the row break.
  29397. </summary>
  29398. <param name="row">The row.</param>
  29399. </member>
  29400. <member name="M:NPOI.SS.UserModel.ISheet.IsColumnBroken(System.Int32)">
  29401. <summary>
  29402. Determines if there is a page break at the indicated column
  29403. </summary>
  29404. <param name="column">The column index.</param>
  29405. </member>
  29406. <member name="M:NPOI.SS.UserModel.ISheet.RemoveColumnBreak(System.Int32)">
  29407. <summary>
  29408. Removes a page break at the indicated column
  29409. </summary>
  29410. <param name="column">The column.</param>
  29411. </member>
  29412. <member name="M:NPOI.SS.UserModel.ISheet.SetColumnGroupCollapsed(System.Int32,System.Boolean)">
  29413. <summary>
  29414. Expands or collapses a column group.
  29415. </summary>
  29416. <param name="columnNumber">One of the columns in the group.</param>
  29417. <param name="collapsed">if set to <c>true</c>collapse group.<c>false</c>expand group.</param>
  29418. </member>
  29419. <member name="M:NPOI.SS.UserModel.ISheet.GroupColumn(System.Int32,System.Int32)">
  29420. <summary>
  29421. Create an outline for the provided column range.
  29422. </summary>
  29423. <param name="fromColumn">beginning of the column range.</param>
  29424. <param name="toColumn">end of the column range.</param>
  29425. </member>
  29426. <member name="M:NPOI.SS.UserModel.ISheet.UngroupColumn(System.Int32,System.Int32)">
  29427. <summary>
  29428. Ungroup a range of columns that were previously groupped
  29429. </summary>
  29430. <param name="fromColumn">start column (0-based).</param>
  29431. <param name="toColumn">end column (0-based).</param>
  29432. </member>
  29433. <member name="M:NPOI.SS.UserModel.ISheet.GroupRow(System.Int32,System.Int32)">
  29434. <summary>
  29435. Tie a range of rows toGether so that they can be collapsed or expanded
  29436. </summary>
  29437. <param name="fromRow">start row (0-based)</param>
  29438. <param name="toRow">end row (0-based)</param>
  29439. </member>
  29440. <member name="M:NPOI.SS.UserModel.ISheet.UngroupRow(System.Int32,System.Int32)">
  29441. <summary>
  29442. Ungroup a range of rows that were previously groupped
  29443. </summary>
  29444. <param name="fromRow">start row (0-based)</param>
  29445. <param name="toRow">end row (0-based)</param>
  29446. </member>
  29447. <member name="M:NPOI.SS.UserModel.ISheet.SetRowGroupCollapsed(System.Int32,System.Boolean)">
  29448. <summary>
  29449. Set view state of a groupped range of rows
  29450. </summary>
  29451. <param name="row">start row of a groupped range of rows (0-based).</param>
  29452. <param name="collapse">whether to expand/collapse the detail rows.</param>
  29453. </member>
  29454. <member name="M:NPOI.SS.UserModel.ISheet.SetDefaultColumnStyle(System.Int32,NPOI.SS.UserModel.ICellStyle)">
  29455. <summary>
  29456. Sets the default column style for a given column. POI will only apply this style to new cells Added to the sheet.
  29457. </summary>
  29458. <param name="column">the column index</param>
  29459. <param name="style">the style to set</param>
  29460. </member>
  29461. <member name="M:NPOI.SS.UserModel.ISheet.AutoSizeColumn(System.Int32)">
  29462. <summary>
  29463. Adjusts the column width to fit the contents.
  29464. </summary>
  29465. <param name="column">the column index</param>
  29466. <remarks>
  29467. This process can be relatively slow on large sheets, so this should
  29468. normally only be called once per column, at the end of your
  29469. processing.
  29470. </remarks>
  29471. </member>
  29472. <member name="M:NPOI.SS.UserModel.ISheet.AutoSizeColumn(System.Int32,System.Boolean)">
  29473. <summary>
  29474. Adjusts the column width to fit the contents.
  29475. </summary>
  29476. <param name="column">the column index.</param>
  29477. <param name="useMergedCells">whether to use the contents of merged cells when
  29478. calculating the width of the column. Default is to ignore merged cells.</param>
  29479. <remarks>
  29480. This process can be relatively slow on large sheets, so this should
  29481. normally only be called once per column, at the end of your
  29482. processing.
  29483. </remarks>
  29484. </member>
  29485. <member name="M:NPOI.SS.UserModel.ISheet.GetCellComment(System.Int32,System.Int32)">
  29486. <summary>
  29487. Returns cell comment for the specified row and column
  29488. </summary>
  29489. <param name="row">The row.</param>
  29490. <param name="column">The column.</param>
  29491. </member>
  29492. <member name="M:NPOI.SS.UserModel.ISheet.CreateDrawingPatriarch">
  29493. <summary>
  29494. Creates the top-level drawing patriarch.
  29495. </summary>
  29496. </member>
  29497. <member name="M:NPOI.SS.UserModel.ISheet.SetActive(System.Boolean)">
  29498. <summary>
  29499. Sets whether sheet is selected.
  29500. </summary>
  29501. <param name="value">Whether to select the sheet or deselect the sheet.</param>
  29502. </member>
  29503. <member name="M:NPOI.SS.UserModel.ISheet.SetArrayFormula(System.String,NPOI.SS.Util.CellRangeAddress)">
  29504. <summary>
  29505. Sets array formula to specified region for result.
  29506. </summary>
  29507. <param name="formula">text representation of the formula</param>
  29508. <param name="range">Region of array formula for result</param>
  29509. <returns>the <see cref="T:NPOI.SS.UserModel.ICellRange`1"/> of cells affected by this change</returns>
  29510. </member>
  29511. <member name="M:NPOI.SS.UserModel.ISheet.RemoveArrayFormula(NPOI.SS.UserModel.ICell)">
  29512. <summary>
  29513. Remove a Array Formula from this sheet. All cells contained in the Array Formula range are removed as well
  29514. </summary>
  29515. <param name="cell">any cell within Array Formula range</param>
  29516. <returns>the <see cref="T:NPOI.SS.UserModel.ICellRange`1"/> of cells affected by this change</returns>
  29517. </member>
  29518. <member name="M:NPOI.SS.UserModel.ISheet.IsMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  29519. <summary>
  29520. Checks if the provided region is part of the merged regions.
  29521. </summary>
  29522. <param name="mergedRegion">Region searched in the merged regions</param>
  29523. <returns><c>true</c>, when the region is contained in at least one of the merged regions</returns>
  29524. </member>
  29525. <member name="M:NPOI.SS.UserModel.ISheet.GetDataValidationHelper">
  29526. <summary>
  29527. Create an instance of a DataValidationHelper.
  29528. </summary>
  29529. <returns>Instance of a DataValidationHelper</returns>
  29530. </member>
  29531. <member name="M:NPOI.SS.UserModel.ISheet.GetDataValidations">
  29532. <summary>
  29533. Returns the list of DataValidation in the sheet.
  29534. </summary>
  29535. <returns>list of DataValidation in the sheet</returns>
  29536. </member>
  29537. <member name="M:NPOI.SS.UserModel.ISheet.AddValidationData(NPOI.SS.UserModel.IDataValidation)">
  29538. <summary>
  29539. Creates a data validation object
  29540. </summary>
  29541. <param name="dataValidation">The data validation object settings</param>
  29542. </member>
  29543. <member name="M:NPOI.SS.UserModel.ISheet.SetAutoFilter(NPOI.SS.Util.CellRangeAddress)">
  29544. <summary>
  29545. Enable filtering for a range of cells
  29546. </summary>
  29547. <param name="range">the range of cells to filter</param>
  29548. </member>
  29549. <member name="M:NPOI.SS.UserModel.ISheet.CopySheet(System.String)">
  29550. <summary>
  29551. Copy sheet with a new name
  29552. </summary>
  29553. <param name="Name">new sheet name</param>
  29554. <returns>cloned sheet</returns>
  29555. </member>
  29556. <member name="M:NPOI.SS.UserModel.ISheet.CopySheet(System.String,System.Boolean)">
  29557. <summary>
  29558. Copy sheet with a new name
  29559. </summary>
  29560. <param name="Name">new sheet name</param>
  29561. <param name="copyStyle">whether to copy styles</param>
  29562. <returns>cloned sheet</returns>
  29563. </member>
  29564. <member name="M:NPOI.SS.UserModel.ISheet.GetColumnOutlineLevel(System.Int32)">
  29565. <summary>
  29566. Returns the column outline level. Increased as you
  29567. put it into more groups (outlines), reduced as
  29568. you take it out of them.
  29569. </summary>
  29570. <param name="columnIndex"></param>
  29571. <returns></returns>
  29572. </member>
  29573. <member name="P:NPOI.SS.UserModel.ISheet.PhysicalNumberOfRows">
  29574. <summary>
  29575. Returns the number of physically defined rows (NOT the number of rows in the sheet)
  29576. </summary>
  29577. <value>the number of physically defined rows in this sheet.</value>
  29578. </member>
  29579. <member name="P:NPOI.SS.UserModel.ISheet.FirstRowNum">
  29580. <summary>
  29581. Gets the first row on the sheet
  29582. </summary>
  29583. <value>the number of the first logical row on the sheet (0-based).</value>
  29584. </member>
  29585. <member name="P:NPOI.SS.UserModel.ISheet.LastRowNum">
  29586. <summary>
  29587. Gets the last row on the sheet
  29588. </summary>
  29589. <value>last row contained n this sheet (0-based)</value>
  29590. </member>
  29591. <member name="P:NPOI.SS.UserModel.ISheet.ForceFormulaRecalculation">
  29592. <summary>
  29593. whether force formula recalculation.
  29594. </summary>
  29595. </member>
  29596. <member name="P:NPOI.SS.UserModel.ISheet.DefaultColumnWidth">
  29597. <summary>
  29598. Get the default column width for the sheet (if the columns do not define their own width)
  29599. in characters
  29600. </summary>
  29601. <value>default column width measured in characters.</value>
  29602. </member>
  29603. <member name="P:NPOI.SS.UserModel.ISheet.DefaultRowHeight">
  29604. <summary>
  29605. Get the default row height for the sheet (if the rows do not define their own height) in
  29606. twips (1/20 of a point)
  29607. </summary>
  29608. <value>default row height measured in twips (1/20 of a point)</value>
  29609. </member>
  29610. <member name="P:NPOI.SS.UserModel.ISheet.DefaultRowHeightInPoints">
  29611. <summary>
  29612. Get the default row height for the sheet (if the rows do not define their own height) in
  29613. points.
  29614. </summary>
  29615. <value>The default row height in points.</value>
  29616. </member>
  29617. <member name="P:NPOI.SS.UserModel.ISheet.HorizontallyCenter">
  29618. <summary>
  29619. Determine whether printed output for this sheet will be horizontally centered.
  29620. </summary>
  29621. </member>
  29622. <member name="P:NPOI.SS.UserModel.ISheet.VerticallyCenter">
  29623. <summary>
  29624. Determine whether printed output for this sheet will be vertically centered.
  29625. </summary>
  29626. </member>
  29627. <member name="P:NPOI.SS.UserModel.ISheet.NumMergedRegions">
  29628. <summary>
  29629. Returns the number of merged regions
  29630. </summary>
  29631. </member>
  29632. <member name="P:NPOI.SS.UserModel.ISheet.DisplayZeros">
  29633. <summary>
  29634. Gets the flag indicating whether the window should show 0 (zero) in cells Containing zero value.
  29635. When false, cells with zero value appear blank instead of showing the number zero.
  29636. </summary>
  29637. <value>whether all zero values on the worksheet are displayed.</value>
  29638. </member>
  29639. <member name="P:NPOI.SS.UserModel.ISheet.Autobreaks">
  29640. <summary>
  29641. Gets or sets a value indicating whether the sheet displays Automatic Page Breaks.
  29642. </summary>
  29643. </member>
  29644. <member name="P:NPOI.SS.UserModel.ISheet.DisplayGuts">
  29645. <summary>
  29646. Get whether to display the guts or not,
  29647. </summary>
  29648. <value>default value is true</value>
  29649. </member>
  29650. <member name="P:NPOI.SS.UserModel.ISheet.FitToPage">
  29651. <summary>
  29652. Flag indicating whether the Fit to Page print option is enabled.
  29653. </summary>
  29654. </member>
  29655. <member name="P:NPOI.SS.UserModel.ISheet.RowSumsBelow">
  29656. <summary>
  29657. Flag indicating whether summary rows appear below detail in an outline, when applying an outline.
  29658. When true a summary row is inserted below the detailed data being summarized and a
  29659. new outline level is established on that row.
  29660. When false a summary row is inserted above the detailed data being summarized and a new outline level
  29661. is established on that row.
  29662. </summary>
  29663. <returns><c>true</c> if row summaries appear below detail in the outline</returns>
  29664. </member>
  29665. <member name="P:NPOI.SS.UserModel.ISheet.RowSumsRight">
  29666. <summary>
  29667. Flag indicating whether summary columns appear to the right of detail in an outline, when applying an outline.
  29668. When true a summary column is inserted to the right of the detailed data being summarized
  29669. and a new outline level is established on that column.
  29670. When false a summary column is inserted to the left of the detailed data being
  29671. summarized and a new outline level is established on that column.
  29672. </summary>
  29673. <returns><c>true</c> if col summaries appear right of the detail in the outline</returns>
  29674. </member>
  29675. <member name="P:NPOI.SS.UserModel.ISheet.IsPrintGridlines">
  29676. <summary>
  29677. Gets the flag indicating whether this sheet displays the lines
  29678. between rows and columns to make editing and reading easier.
  29679. </summary>
  29680. <returns><c>true</c> if this sheet displays gridlines.</returns>
  29681. </member>
  29682. <member name="P:NPOI.SS.UserModel.ISheet.PrintSetup">
  29683. <summary>
  29684. Gets the print Setup object.
  29685. </summary>
  29686. <returns>The user model for the print Setup object.</returns>
  29687. </member>
  29688. <member name="P:NPOI.SS.UserModel.ISheet.Header">
  29689. <summary>
  29690. Gets the user model for the default document header.
  29691. <p/>
  29692. Note that XSSF offers more kinds of document headers than HSSF does
  29693. </summary>
  29694. <returns>the document header. Never <code>null</code></returns>
  29695. </member>
  29696. <member name="P:NPOI.SS.UserModel.ISheet.Footer">
  29697. <summary>
  29698. Gets the user model for the default document footer.
  29699. <p/>
  29700. Note that XSSF offers more kinds of document footers than HSSF does.
  29701. </summary>
  29702. <returns>the document footer. Never <code>null</code></returns>
  29703. </member>
  29704. <member name="P:NPOI.SS.UserModel.ISheet.Protect">
  29705. <summary>
  29706. Answer whether protection is enabled or disabled
  29707. </summary>
  29708. <returns>true => protection enabled; false => protection disabled</returns>
  29709. </member>
  29710. <member name="P:NPOI.SS.UserModel.ISheet.ScenarioProtect">
  29711. <summary>
  29712. Answer whether scenario protection is enabled or disabled
  29713. </summary>
  29714. <returns>true => protection enabled; false => protection disabled</returns>
  29715. </member>
  29716. <member name="P:NPOI.SS.UserModel.ISheet.TabColorIndex">
  29717. <summary>
  29718. Gets or sets the tab color of the _sheet
  29719. </summary>
  29720. </member>
  29721. <member name="P:NPOI.SS.UserModel.ISheet.DrawingPatriarch">
  29722. <summary>
  29723. Returns the top-level drawing patriach, if there is one.
  29724. This will hold any graphics or charts for the _sheet.
  29725. WARNING - calling this will trigger a parsing of the
  29726. associated escher records. Any that aren't supported
  29727. (such as charts and complex drawing types) will almost
  29728. certainly be lost or corrupted when written out. Only
  29729. use this with simple drawings, otherwise call
  29730. HSSFSheet#CreateDrawingPatriarch() and
  29731. start from scratch!
  29732. </summary>
  29733. <value>The drawing patriarch.</value>
  29734. </member>
  29735. <member name="P:NPOI.SS.UserModel.ISheet.TopRow">
  29736. <summary>
  29737. The top row in the visible view when the sheet is
  29738. first viewed after opening it in a viewer
  29739. </summary>
  29740. <value>the rownum (0 based) of the top row.</value>
  29741. </member>
  29742. <member name="P:NPOI.SS.UserModel.ISheet.LeftCol">
  29743. <summary>
  29744. The left col in the visible view when the sheet is
  29745. first viewed after opening it in a viewer
  29746. </summary>
  29747. <value>the rownum (0 based) of the top row</value>
  29748. </member>
  29749. <member name="P:NPOI.SS.UserModel.ISheet.PaneInformation">
  29750. <summary>
  29751. Returns the information regarding the currently configured pane (split or freeze)
  29752. </summary>
  29753. <value>if no pane configured returns <c>null</c> else return the pane information.</value>
  29754. </member>
  29755. <member name="P:NPOI.SS.UserModel.ISheet.DisplayGridlines">
  29756. <summary>
  29757. Returns if gridlines are displayed
  29758. </summary>
  29759. </member>
  29760. <member name="P:NPOI.SS.UserModel.ISheet.DisplayFormulas">
  29761. <summary>
  29762. Returns if formulas are displayed
  29763. </summary>
  29764. </member>
  29765. <member name="P:NPOI.SS.UserModel.ISheet.DisplayRowColHeadings">
  29766. <summary>
  29767. Returns if RowColHeadings are displayed.
  29768. </summary>
  29769. </member>
  29770. <member name="P:NPOI.SS.UserModel.ISheet.IsActive">
  29771. <summary>
  29772. Returns if RowColHeadings are displayed.
  29773. </summary>
  29774. </member>
  29775. <member name="P:NPOI.SS.UserModel.ISheet.RowBreaks">
  29776. <summary>
  29777. Retrieves all the horizontal page breaks
  29778. </summary>
  29779. <value>all the horizontal page breaks, or null if there are no row page breaks</value>
  29780. </member>
  29781. <member name="P:NPOI.SS.UserModel.ISheet.ColumnBreaks">
  29782. <summary>
  29783. Retrieves all the vertical page breaks
  29784. </summary>
  29785. <value>all the vertical page breaks, or null if there are no column page breaks.</value>
  29786. </member>
  29787. <member name="P:NPOI.SS.UserModel.ISheet.Workbook">
  29788. <summary>
  29789. Gets the parent workbook.
  29790. </summary>
  29791. </member>
  29792. <member name="P:NPOI.SS.UserModel.ISheet.SheetName">
  29793. <summary>
  29794. Gets the name of the sheet.
  29795. </summary>
  29796. </member>
  29797. <member name="P:NPOI.SS.UserModel.ISheet.IsSelected">
  29798. <summary>
  29799. Gets or sets a value indicating whether this sheet is currently selected.
  29800. </summary>
  29801. </member>
  29802. <member name="P:NPOI.SS.UserModel.ISheet.SheetConditionalFormatting">
  29803. <summary>
  29804. The 'Conditional Formatting' facet for this <c>Sheet</c>
  29805. </summary>
  29806. <returns>conditional formatting rule for this sheet</returns>
  29807. </member>
  29808. <member name="P:NPOI.SS.UserModel.ISheet.IsRightToLeft">
  29809. <summary>
  29810. Whether the text is displayed in right-to-left mode in the window
  29811. </summary>
  29812. </member>
  29813. <member name="P:NPOI.SS.UserModel.ISheet.RepeatingRows">
  29814. <summary>
  29815. Get or set the repeating rows used when printing the sheet, as found in File->PageSetup->Sheet.
  29816. <p/>
  29817. Repeating rows cover a range of contiguous rows, e.g.:
  29818. <pre>
  29819. Sheet1!$1:$1
  29820. Sheet2!$5:$8
  29821. </pre>
  29822. The {@link CellRangeAddress} returned contains a column part which spans
  29823. all columns, and a row part which specifies the contiguous range of
  29824. repeating rows.
  29825. <p/>
  29826. If the Sheet does not have any repeating rows defined, null is returned.
  29827. </summary>
  29828. </member>
  29829. <member name="P:NPOI.SS.UserModel.ISheet.RepeatingColumns">
  29830. <summary>
  29831. Gets or set the repeating columns used when printing the sheet, as found in File->PageSetup->Sheet.
  29832. <p/>
  29833. Repeating columns cover a range of contiguous columns, e.g.:
  29834. <pre>
  29835. Sheet1!$A:$A
  29836. Sheet2!$C:$F
  29837. </pre>
  29838. The {@link CellRangeAddress} returned contains a row part which spans all
  29839. rows, and a column part which specifies the contiguous range of
  29840. repeating columns.
  29841. <p/>
  29842. If the Sheet does not have any repeating columns defined, null is
  29843. returned.
  29844. </summary>
  29845. </member>
  29846. <member name="F:NPOI.HSSF.UserModel.HSSFSheet.INITIAL_CAPACITY">
  29847. Used for compile-time optimization. This is the initial size for the collection of
  29848. rows. It is currently Set to 20. If you generate larger sheets you may benefit
  29849. by Setting this to a higher number and recompiling a custom edition of HSSFSheet.
  29850. </member>
  29851. <member name="F:NPOI.HSSF.UserModel.HSSFSheet.PX_DEFAULT">
  29852. width of 1px in columns with default width in units of 1/256 of a character width
  29853. </member>
  29854. <member name="F:NPOI.HSSF.UserModel.HSSFSheet.PX_MODIFIED">
  29855. width of 1px in columns with overridden width in units of 1/256 of a character width
  29856. </member>
  29857. <member name="F:NPOI.HSSF.UserModel.HSSFSheet._sheet">
  29858. reference to the low level Sheet object
  29859. </member>
  29860. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook)">
  29861. <summary>
  29862. Creates new HSSFSheet - called by HSSFWorkbook to create a _sheet from
  29863. scratch. You should not be calling this from application code (its protected anyhow).
  29864. </summary>
  29865. <param name="workbook">The HSSF Workbook object associated with the _sheet.</param>
  29866. <see cref="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateSheet"/>
  29867. </member>
  29868. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.Model.InternalSheet)">
  29869. <summary>
  29870. Creates an HSSFSheet representing the given Sheet object. Should only be
  29871. called by HSSFWorkbook when reading in an exisiting file.
  29872. </summary>
  29873. <param name="workbook">The HSSF Workbook object associated with the _sheet.</param>
  29874. <param name="sheet">lowlevel Sheet object this _sheet will represent</param>
  29875. <see cref="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.DirectoryNode,System.Boolean)"/>
  29876. </member>
  29877. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CloneSheet(NPOI.HSSF.UserModel.HSSFWorkbook)">
  29878. <summary>
  29879. Clones the _sheet.
  29880. </summary>
  29881. <param name="workbook">The _workbook.</param>
  29882. <returns>the cloned sheet</returns>
  29883. </member>
  29884. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CopyRow(System.Int32,System.Int32)">
  29885. <summary>
  29886. Copy one row to the target row
  29887. </summary>
  29888. <param name="sourceIndex">index of the source row</param>
  29889. <param name="targetIndex">index of the target row</param>
  29890. </member>
  29891. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetPropertiesFromSheet(NPOI.HSSF.Model.InternalSheet)">
  29892. <summary>
  29893. used internally to Set the properties given a Sheet object
  29894. </summary>
  29895. <param name="sheet">The _sheet.</param>
  29896. </member>
  29897. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateRow(System.Int32)">
  29898. <summary>
  29899. Create a new row within the _sheet and return the high level representation
  29900. </summary>
  29901. <param name="rownum">The row number.</param>
  29902. <returns></returns>
  29903. @see org.apache.poi.hssf.usermodel.HSSFRow
  29904. @see #RemoveRow(HSSFRow)
  29905. </member>
  29906. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateRowFromRecord(NPOI.HSSF.Record.RowRecord)">
  29907. <summary>
  29908. Used internally to Create a high level Row object from a low level row object.
  29909. USed when Reading an existing file
  29910. </summary>
  29911. <param name="row">low level record to represent as a high level Row and Add to _sheet.</param>
  29912. <returns>HSSFRow high level representation</returns>
  29913. </member>
  29914. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveRow(NPOI.SS.UserModel.IRow)">
  29915. <summary>
  29916. Remove a row from this _sheet. All cells contained in the row are Removed as well
  29917. </summary>
  29918. <param name="row">the row to Remove.</param>
  29919. </member>
  29920. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.FindLastRow(System.Int32)">
  29921. <summary>
  29922. used internally to refresh the "last row" when the last row is Removed.
  29923. </summary>
  29924. <param name="lastrow">The last row.</param>
  29925. <returns></returns>
  29926. </member>
  29927. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.FindFirstRow(System.Int32)">
  29928. <summary>
  29929. used internally to refresh the "first row" when the first row is Removed.
  29930. </summary>
  29931. <param name="firstrow">The first row.</param>
  29932. <returns></returns>
  29933. </member>
  29934. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddRow(NPOI.HSSF.UserModel.HSSFRow,System.Boolean)">
  29935. Add a row to the _sheet
  29936. @param AddLow whether to Add the row to the low level model - false if its already there
  29937. </member>
  29938. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetColumnStyle(System.Int32)">
  29939. <summary>
  29940. Returns the HSSFCellStyle that applies to the given
  29941. (0 based) column, or null if no style has been
  29942. set for that column
  29943. </summary>
  29944. <param name="column">The column.</param>
  29945. <returns></returns>
  29946. </member>
  29947. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetRow(System.Int32)">
  29948. <summary>
  29949. Returns the logical row (not physical) 0-based. If you ask for a row that is not
  29950. defined you get a null. This is to say row 4 represents the fifth row on a _sheet.
  29951. </summary>
  29952. <param name="rowIndex">Index of the row to get.</param>
  29953. <returns>the row number or null if its not defined on the _sheet</returns>
  29954. </member>
  29955. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddValidationData(NPOI.SS.UserModel.IDataValidation)">
  29956. <summary>
  29957. Creates a data validation object
  29958. </summary>
  29959. <param name="dataValidation">The data validation object settings</param>
  29960. </member>
  29961. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetColumnHidden(System.Int32,System.Boolean)">
  29962. <summary>
  29963. Get the visibility state for a given column.F:\Gloria\�о�\�ļ���ʽ\NPOI\src\NPOI\HSSF\Util\HSSFDataValidation.cs
  29964. </summary>
  29965. <param name="column">the column to Get (0-based).</param>
  29966. <param name="hidden">the visiblity state of the column.</param>
  29967. </member>
  29968. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.IsColumnHidden(System.Int32)">
  29969. <summary>
  29970. Get the hidden state for a given column.
  29971. </summary>
  29972. <param name="column">the column to Set (0-based)</param>
  29973. <returns>the visiblity state of the column;
  29974. </returns>
  29975. </member>
  29976. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetColumnWidth(System.Int32,System.Int32)">
  29977. <summary>
  29978. Set the width (in Units of 1/256th of a Char width)
  29979. </summary>
  29980. <param name="column">the column to Set (0-based)</param>
  29981. <param name="width">the width in Units of 1/256th of a Char width</param>
  29982. </member>
  29983. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetColumnWidth(System.Int32)">
  29984. <summary>
  29985. Get the width (in Units of 1/256th of a Char width )
  29986. </summary>
  29987. <param name="column">the column to Set (0-based)</param>
  29988. <returns>the width in Units of 1/256th of a Char width</returns>
  29989. </member>
  29990. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddMergedRegion(NPOI.SS.Util.Region)">
  29991. <summary>
  29992. Adds a merged region of cells (hence those cells form one)
  29993. </summary>
  29994. <param name="region">The region (rowfrom/colfrom-rowto/colto) to merge.</param>
  29995. <returns>index of this region</returns>
  29996. </member>
  29997. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  29998. <summary>
  29999. adds a merged region of cells (hence those cells form one)
  30000. </summary>
  30001. <param name="region">region (rowfrom/colfrom-rowto/colto) to merge</param>
  30002. <returns>index of this region</returns>
  30003. </member>
  30004. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveMergedRegion(System.Int32)">
  30005. <summary>
  30006. Removes a merged region of cells (hence letting them free)
  30007. </summary>
  30008. <param name="index">index of the region to Unmerge</param>
  30009. </member>
  30010. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetRowEnumerator">
  30011. <summary>
  30012. Gets the row enumerator.
  30013. </summary>
  30014. <returns>
  30015. an iterator of the PHYSICAL rows. Meaning the 3rd element may not
  30016. be the third row if say for instance the second row is undefined.
  30017. Call <see cref="P:NPOI.SS.UserModel.IRow.RowNum"/> on each row
  30018. if you care which one it is.
  30019. </returns>
  30020. </member>
  30021. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetEnumerator">
  30022. <summary>
  30023. Alias for GetRowEnumerator() to allow <c>foreach</c> loops.
  30024. </summary>
  30025. <returns>
  30026. an iterator of the PHYSICAL rows. Meaning the 3rd element may not
  30027. be the third row if say for instance the second row is undefined.
  30028. Call <see cref="P:NPOI.SS.UserModel.IRow.RowNum"/> on each row
  30029. if you care which one it is.
  30030. </returns>
  30031. </member>
  30032. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetActiveCell(System.Int32,System.Int32)">
  30033. <summary>
  30034. Sets the active cell.
  30035. </summary>
  30036. <param name="row">The row.</param>
  30037. <param name="column">The column.</param>
  30038. </member>
  30039. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetActiveCellRange(System.Int32,System.Int32,System.Int32,System.Int32)">
  30040. <summary>
  30041. Sets the active cell range.
  30042. </summary>
  30043. <param name="firstRow">The first row.</param>
  30044. <param name="lastRow">The last row.</param>
  30045. <param name="firstColumn">The first column.</param>
  30046. <param name="lastColumn">The last column.</param>
  30047. </member>
  30048. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetActiveCellRange(System.Collections.Generic.List{NPOI.SS.Util.CellRangeAddress8Bit},System.Int32,System.Int32,System.Int32)">
  30049. <summary>
  30050. Sets the active cell range.
  30051. </summary>
  30052. <param name="cellranges">The cellranges.</param>
  30053. <param name="activeRange">The index of the active range.</param>
  30054. <param name="activeRow">The active row in the active range</param>
  30055. <param name="activeColumn">The active column in the active range</param>
  30056. </member>
  30057. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetActive(System.Boolean)">
  30058. <summary>
  30059. Sets whether sheet is selected.
  30060. </summary>
  30061. <param name="sel">Whether to select the sheet or deselect the sheet.</param>
  30062. </member>
  30063. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ProtectSheet(System.String)">
  30064. <summary>
  30065. Sets the protection enabled as well as the password
  30066. </summary>
  30067. <param name="password">password to set for protection, pass <code>null</code> to remove protection</param>
  30068. </member>
  30069. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetZoom(System.Int32,System.Int32)">
  30070. <summary>
  30071. Sets the zoom magnication for the _sheet. The zoom is expressed as a
  30072. fraction. For example to express a zoom of 75% use 3 for the numerator
  30073. and 4 for the denominator.
  30074. </summary>
  30075. <param name="numerator">The numerator for the zoom magnification.</param>
  30076. <param name="denominator">The denominator for the zoom magnification.</param>
  30077. </member>
  30078. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetEnclosedBorderOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  30079. <summary>
  30080. Sets the enclosed border of region.
  30081. </summary>
  30082. <param name="region">The region.</param>
  30083. <param name="borderType">Type of the border.</param>
  30084. <param name="color">The color.</param>
  30085. </member>
  30086. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetBorderRightOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  30087. <summary>
  30088. Sets the right border of region.
  30089. </summary>
  30090. <param name="region">The region.</param>
  30091. <param name="borderType">Type of the border.</param>
  30092. <param name="color">The color.</param>
  30093. </member>
  30094. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetBorderLeftOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  30095. <summary>
  30096. Sets the left border of region.
  30097. </summary>
  30098. <param name="region">The region.</param>
  30099. <param name="borderType">Type of the border.</param>
  30100. <param name="color">The color.</param>
  30101. </member>
  30102. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetBorderTopOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  30103. <summary>
  30104. Sets the top border of region.
  30105. </summary>
  30106. <param name="region">The region.</param>
  30107. <param name="borderType">Type of the border.</param>
  30108. <param name="color">The color.</param>
  30109. </member>
  30110. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetBorderBottomOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  30111. <summary>
  30112. Sets the bottom border of region.
  30113. </summary>
  30114. <param name="region">The region.</param>
  30115. <param name="borderType">Type of the border.</param>
  30116. <param name="color">The color.</param>
  30117. </member>
  30118. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShowInPane(System.Int32,System.Int32)">
  30119. Sets desktop window pane display area, when the
  30120. file is first opened in a viewer.
  30121. @param toprow the top row to show in desktop window pane
  30122. @param leftcol the left column to show in desktop window pane
  30123. </member>
  30124. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShowInPane(System.Int16,System.Int16)">
  30125. <summary>
  30126. Sets desktop window pane display area, when the
  30127. file is first opened in a viewer.
  30128. </summary>
  30129. <param name="toprow">the top row to show in desktop window pane</param>
  30130. <param name="leftcol">the left column to show in desktop window pane</param>
  30131. </member>
  30132. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShiftMerged(System.Int32,System.Int32,System.Int32,System.Boolean)">
  30133. <summary>
  30134. Shifts the merged regions left or right depending on mode
  30135. TODO: MODE , this is only row specific
  30136. </summary>
  30137. <param name="startRow">The start row.</param>
  30138. <param name="endRow">The end row.</param>
  30139. <param name="n">The n.</param>
  30140. <param name="IsRow">if set to <c>true</c> [is row].</param>
  30141. </member>
  30142. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32)">
  30143. <summary>
  30144. Shifts rows between startRow and endRow n number of rows.
  30145. If you use a negative number, it will Shift rows up.
  30146. Code Ensures that rows don't wrap around.
  30147. Calls ShiftRows(startRow, endRow, n, false, false);
  30148. Additionally Shifts merged regions that are completely defined in these
  30149. rows (ie. merged 2 cells on a row to be Shifted).
  30150. </summary>
  30151. <param name="startRow">the row to start Shifting</param>
  30152. <param name="endRow">the row to end Shifting</param>
  30153. <param name="n">the number of rows to Shift</param>
  30154. </member>
  30155. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean)">
  30156. <summary>
  30157. Shifts rows between startRow and endRow n number of rows.
  30158. If you use a negative number, it will shift rows up.
  30159. Code ensures that rows don't wrap around
  30160. Additionally shifts merged regions that are completely defined in these
  30161. rows (ie. merged 2 cells on a row to be shifted).
  30162. TODO Might want to add bounds checking here
  30163. </summary>
  30164. <param name="startRow">the row to start shifting</param>
  30165. <param name="endRow">the row to end shifting</param>
  30166. <param name="n">the number of rows to shift</param>
  30167. <param name="copyRowHeight">whether to copy the row height during the shift</param>
  30168. <param name="resetOriginalRowHeight">whether to set the original row's height to the default</param>
  30169. </member>
  30170. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean,System.Boolean)">
  30171. <summary>
  30172. Shifts rows between startRow and endRow n number of rows.
  30173. If you use a negative number, it will Shift rows up.
  30174. Code Ensures that rows don't wrap around
  30175. Additionally Shifts merged regions that are completely defined in these
  30176. rows (ie. merged 2 cells on a row to be Shifted).
  30177. TODO Might want to Add bounds Checking here
  30178. </summary>
  30179. <param name="startRow">the row to start Shifting</param>
  30180. <param name="endRow">the row to end Shifting</param>
  30181. <param name="n">the number of rows to Shift</param>
  30182. <param name="copyRowHeight">whether to copy the row height during the Shift</param>
  30183. <param name="resetOriginalRowHeight">whether to Set the original row's height to the default</param>
  30184. <param name="moveComments">if set to <c>true</c> [move comments].</param>
  30185. </member>
  30186. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.InsertChartRecords(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  30187. <summary>
  30188. Inserts the chart records.
  30189. </summary>
  30190. <param name="records">The records.</param>
  30191. </member>
  30192. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateFreezePane(System.Int32,System.Int32,System.Int32,System.Int32)">
  30193. <summary>
  30194. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  30195. </summary>
  30196. <param name="colSplit">Horizonatal position of split.</param>
  30197. <param name="rowSplit">Vertical position of split.</param>
  30198. <param name="leftmostColumn">Top row visible in bottom pane</param>
  30199. <param name="topRow">Left column visible in right pane.</param>
  30200. </member>
  30201. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateFreezePane(System.Int32,System.Int32)">
  30202. <summary>
  30203. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  30204. </summary>
  30205. <param name="colSplit">Horizonatal position of split.</param>
  30206. <param name="rowSplit">Vertical position of split.</param>
  30207. </member>
  30208. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateSplitPane(System.Int32,System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  30209. <summary>
  30210. Creates a split pane. Any existing freezepane or split pane is overwritten.
  30211. </summary>
  30212. <param name="xSplitPos">Horizonatal position of split (in 1/20th of a point).</param>
  30213. <param name="ySplitPos">Vertical position of split (in 1/20th of a point).</param>
  30214. <param name="leftmostColumn">Left column visible in right pane.</param>
  30215. <param name="topRow">Top row visible in bottom pane.</param>
  30216. <param name="activePane">Active pane. One of: PANE_LOWER_RIGHT,PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT</param>
  30217. </member>
  30218. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetMargin(NPOI.SS.UserModel.MarginType)">
  30219. <summary>
  30220. Gets the size of the margin in inches.
  30221. </summary>
  30222. <param name="margin">which margin to get.</param>
  30223. <returns>the size of the margin</returns>
  30224. </member>
  30225. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  30226. <summary>
  30227. Sets the size of the margin in inches.
  30228. </summary>
  30229. <param name="margin">which margin to get.</param>
  30230. <param name="size">the size of the margin</param>
  30231. </member>
  30232. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetRowBreak(System.Int32)">
  30233. <summary>
  30234. Sets a page break at the indicated row
  30235. </summary>
  30236. <param name="row">The row.</param>
  30237. </member>
  30238. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.IsRowBroken(System.Int32)">
  30239. <summary>
  30240. Determines if there is a page break at the indicated row
  30241. </summary>
  30242. <param name="row">The row.</param>
  30243. <returns>
  30244. <c>true</c> if [is row broken] [the specified row]; otherwise, <c>false</c>.
  30245. </returns>
  30246. </member>
  30247. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveRowBreak(System.Int32)">
  30248. <summary>
  30249. Removes the page break at the indicated row
  30250. </summary>
  30251. <param name="row">The row.</param>
  30252. </member>
  30253. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetColumnBreak(System.Int32)">
  30254. <summary>
  30255. Sets a page break at the indicated column
  30256. </summary>
  30257. <param name="column">The column.</param>
  30258. </member>
  30259. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.IsColumnBroken(System.Int32)">
  30260. <summary>
  30261. Determines if there is a page break at the indicated column
  30262. </summary>
  30263. <param name="column">The column.</param>
  30264. <returns>
  30265. <c>true</c> if [is column broken] [the specified column]; otherwise, <c>false</c>.
  30266. </returns>
  30267. </member>
  30268. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveColumnBreak(System.Int32)">
  30269. <summary>
  30270. Removes a page break at the indicated column
  30271. </summary>
  30272. <param name="column">The column.</param>
  30273. </member>
  30274. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ValidateRow(System.Int32)">
  30275. <summary>
  30276. Runs a bounds Check for row numbers
  30277. </summary>
  30278. <param name="row">The row.</param>
  30279. </member>
  30280. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ValidateColumn(System.Int32)">
  30281. <summary>
  30282. Runs a bounds Check for column numbers
  30283. </summary>
  30284. <param name="column">The column.</param>
  30285. </member>
  30286. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.DumpDrawingRecords(System.Boolean)">
  30287. <summary>
  30288. Aggregates the drawing records and dumps the escher record hierarchy
  30289. to the standard output.
  30290. </summary>
  30291. <param name="fat">if set to <c>true</c> [fat].</param>
  30292. </member>
  30293. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateDrawingPatriarch">
  30294. Creates the top-level drawing patriarch. This will have
  30295. the effect of removing any existing drawings on this
  30296. sheet.
  30297. This may then be used to add graphics or charts
  30298. @return The new patriarch.
  30299. </member>
  30300. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetColumnGroupCollapsed(System.Int32,System.Boolean)">
  30301. <summary>
  30302. Expands or collapses a column Group.
  30303. </summary>
  30304. <param name="columnNumber">One of the columns in the Group.</param>
  30305. <param name="collapsed">true = collapse Group, false = expand Group.</param>
  30306. </member>
  30307. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GroupColumn(System.Int32,System.Int32)">
  30308. <summary>
  30309. Create an outline for the provided column range.
  30310. </summary>
  30311. <param name="fromColumn">beginning of the column range.</param>
  30312. <param name="toColumn">end of the column range.</param>
  30313. </member>
  30314. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.UngroupColumn(System.Int32,System.Int32)">
  30315. <summary>
  30316. Ungroups the column.
  30317. </summary>
  30318. <param name="fromColumn">From column.</param>
  30319. <param name="toColumn">To column.</param>
  30320. </member>
  30321. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GroupRow(System.Int32,System.Int32)">
  30322. <summary>
  30323. Groups the row.
  30324. </summary>
  30325. <param name="fromRow">From row.</param>
  30326. <param name="toRow">To row.</param>
  30327. </member>
  30328. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveArrayFormula(NPOI.SS.UserModel.ICell)">
  30329. <summary>
  30330. Remove a Array Formula from this sheet. All cells contained in the Array Formula range are removed as well
  30331. </summary>
  30332. <param name="cell">any cell within Array Formula range</param>
  30333. <returns>the <see cref="T:NPOI.SS.UserModel.ICellRange`1"/> of cells affected by this change</returns>
  30334. </member>
  30335. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetCellRange(NPOI.SS.Util.CellRangeAddress)">
  30336. <summary>
  30337. Also creates cells if they don't exist.
  30338. </summary>
  30339. </member>
  30340. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetArrayFormula(System.String,NPOI.SS.Util.CellRangeAddress)">
  30341. <summary>
  30342. Sets array formula to specified region for result.
  30343. </summary>
  30344. <param name="formula">text representation of the formula</param>
  30345. <param name="range">Region of array formula for result</param>
  30346. <returns>the <see cref="T:NPOI.SS.UserModel.ICellRange`1"/> of cells affected by this change</returns>
  30347. </member>
  30348. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.UngroupRow(System.Int32,System.Int32)">
  30349. <summary>
  30350. Ungroups the row.
  30351. </summary>
  30352. <param name="fromRow">From row.</param>
  30353. <param name="toRow">To row.</param>
  30354. </member>
  30355. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetRowGroupCollapsed(System.Int32,System.Boolean)">
  30356. <summary>
  30357. Sets the row group collapsed.
  30358. </summary>
  30359. <param name="row">The row.</param>
  30360. <param name="collapse">if set to <c>true</c> [collapse].</param>
  30361. </member>
  30362. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetDefaultColumnStyle(System.Int32,NPOI.SS.UserModel.ICellStyle)">
  30363. <summary>
  30364. Sets the default column style for a given column. POI will only apply this style to new cells Added to the _sheet.
  30365. </summary>
  30366. <param name="column">the column index</param>
  30367. <param name="style">the style to set</param>
  30368. </member>
  30369. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AutoSizeColumn(System.Int32)">
  30370. <summary>
  30371. Adjusts the column width to fit the contents.
  30372. This Process can be relatively slow on large sheets, so this should
  30373. normally only be called once per column, at the end of your
  30374. Processing.
  30375. </summary>
  30376. <param name="column">the column index.</param>
  30377. </member>
  30378. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AutoSizeColumn(System.Int32,System.Boolean)">
  30379. <summary>
  30380. Adjusts the column width to fit the contents.
  30381. This Process can be relatively slow on large sheets, so this should
  30382. normally only be called once per column, at the end of your
  30383. Processing.
  30384. You can specify whether the content of merged cells should be considered or ignored.
  30385. Default is to ignore merged cells.
  30386. </summary>
  30387. <param name="column">the column index</param>
  30388. <param name="useMergedCells">whether to use the contents of merged cells when calculating the width of the column</param>
  30389. </member>
  30390. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.IsMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  30391. <summary>
  30392. Checks if the provided region is part of the merged regions.
  30393. </summary>
  30394. <param name="mergedRegion">Region searched in the merged regions</param>
  30395. <returns><c>true</c>, when the region is contained in at least one of the merged regions</returns>
  30396. </member>
  30397. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetMergedRegion(System.Int32)">
  30398. <summary>
  30399. Gets the merged region at the specified index
  30400. </summary>
  30401. <param name="index">The index.</param>
  30402. <returns></returns>
  30403. </member>
  30404. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.HSSFFont2Font(NPOI.HSSF.UserModel.HSSFFont)">
  30405. <summary>
  30406. Convert HSSFFont to Font.
  30407. </summary>
  30408. <param name="font1">The font.</param>
  30409. <returns></returns>
  30410. </member>
  30411. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetCellComment(System.Int32,System.Int32)">
  30412. <summary>
  30413. Returns cell comment for the specified row and column
  30414. </summary>
  30415. <param name="row">The row.</param>
  30416. <param name="column">The column.</param>
  30417. <returns>cell comment or null if not found</returns>
  30418. </member>
  30419. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetDataValidationHelper">
  30420. <summary>
  30421. Create an instance of a DataValidationHelper.
  30422. </summary>
  30423. <returns>Instance of a DataValidationHelper</returns>
  30424. </member>
  30425. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetAutoFilter(NPOI.SS.Util.CellRangeAddress)">
  30426. <summary>
  30427. Enable filtering for a range of cells
  30428. </summary>
  30429. <param name="range">the range of cells to filter</param>
  30430. </member>
  30431. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetColumnOutlineLevel(System.Int32)">
  30432. <summary>
  30433. Returns the column outline level. Increased as you
  30434. put it into more groups (outlines), reduced as
  30435. you take it out of them.
  30436. </summary>
  30437. <param name="columnIndex"></param>
  30438. <returns></returns>
  30439. </member>
  30440. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayZeros">
  30441. Gets the flag indicating whether the window should show 0 (zero) in cells containing zero value.
  30442. When false, cells with zero value appear blank instead of showing the number zero.
  30443. In Excel 2003 this option can be changed in the Options dialog on the View tab.
  30444. @return whether all zero values on the worksheet are displayed
  30445. </member>
  30446. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.PhysicalNumberOfRows">
  30447. <summary>
  30448. Returns the number of phsyically defined rows (NOT the number of rows in the _sheet)
  30449. </summary>
  30450. <value>The physical number of rows.</value>
  30451. </member>
  30452. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.FirstRowNum">
  30453. <summary>
  30454. Gets the first row on the _sheet
  30455. </summary>
  30456. <value>the number of the first logical row on the _sheet</value>
  30457. </member>
  30458. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.LastRowNum">
  30459. <summary>
  30460. Gets the last row on the _sheet
  30461. </summary>
  30462. <value>last row contained n this _sheet.</value>
  30463. </member>
  30464. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DefaultColumnWidth">
  30465. <summary>
  30466. Gets or sets the default width of the column.
  30467. </summary>
  30468. <value>The default width of the column.</value>
  30469. </member>
  30470. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DefaultRowHeight">
  30471. <summary>
  30472. Get the default row height for the _sheet (if the rows do not define their own height) in
  30473. twips (1/20 of a point)
  30474. </summary>
  30475. <value>The default height of the row.</value>
  30476. </member>
  30477. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DefaultRowHeightInPoints">
  30478. <summary>
  30479. Get the default row height for the _sheet (if the rows do not define their own height) in
  30480. points.
  30481. </summary>
  30482. <value>The default row height in points.</value>
  30483. </member>
  30484. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsGridsPrinted">
  30485. <summary>
  30486. Get whether gridlines are printed.
  30487. </summary>
  30488. <value>
  30489. <c>true</c> if printed; otherwise, <c>false</c>.
  30490. </value>
  30491. </member>
  30492. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.ForceFormulaRecalculation">
  30493. <summary>
  30494. Whether a record must be Inserted or not at generation to indicate that
  30495. formula must be recalculated when _workbook is opened.
  30496. </summary>
  30497. <value>
  30498. <c>true</c> if [force formula recalculation]; otherwise, <c>false</c>.
  30499. </value>
  30500. @return true if an Uncalced record must be Inserted or not at generation
  30501. </member>
  30502. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.VerticallyCenter">
  30503. <summary>
  30504. Determine whether printed output for this _sheet will be vertically centered.
  30505. </summary>
  30506. <value><c>true</c> if [vertically center]; otherwise, <c>false</c>.</value>
  30507. </member>
  30508. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.HorizontallyCenter">
  30509. <summary>
  30510. Determine whether printed output for this _sheet will be horizontally centered.
  30511. </summary>
  30512. <value><c>true</c> if [horizontally center]; otherwise, <c>false</c>.</value>
  30513. </member>
  30514. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.NumMergedRegions">
  30515. <summary>
  30516. returns the number of merged regions
  30517. </summary>
  30518. <value>The number of merged regions</value>
  30519. </member>
  30520. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Sheet">
  30521. <summary>
  30522. used internally in the API to Get the low level Sheet record represented by this
  30523. Object.
  30524. </summary>
  30525. <value>low level representation of this HSSFSheet.</value>
  30526. </member>
  30527. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.AlternativeExpression">
  30528. <summary>
  30529. Gets or sets whether alternate expression evaluation is on
  30530. </summary>
  30531. <value>
  30532. <c>true</c> if [alternative expression]; otherwise, <c>false</c>.
  30533. </value>
  30534. </member>
  30535. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.AlternativeFormula">
  30536. <summary>
  30537. whether alternative formula entry is on
  30538. </summary>
  30539. <value><c>true</c> alternative formulas or not; otherwise, <c>false</c>.</value>
  30540. </member>
  30541. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Autobreaks">
  30542. <summary>
  30543. show automatic page breaks or not
  30544. </summary>
  30545. <value>whether to show auto page breaks</value>
  30546. </member>
  30547. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Dialog">
  30548. <summary>
  30549. Gets or sets a value indicating whether _sheet is a dialog _sheet
  30550. </summary>
  30551. <value><c>true</c> if is dialog; otherwise, <c>false</c>.</value>
  30552. </member>
  30553. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayGuts">
  30554. <summary>
  30555. Gets or sets a value indicating whether to Display the guts or not.
  30556. </summary>
  30557. <value><c>true</c> if guts or no guts (or glory); otherwise, <c>false</c>.</value>
  30558. </member>
  30559. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.FitToPage">
  30560. <summary>
  30561. Gets or sets a value indicating whether fit to page option is on
  30562. </summary>
  30563. <value><c>true</c> if [fit to page]; otherwise, <c>false</c>.</value>
  30564. </member>
  30565. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.RowSumsBelow">
  30566. <summary>
  30567. Get if row summaries appear below detail in the outline
  30568. </summary>
  30569. <value><c>true</c> if below or not; otherwise, <c>false</c>.</value>
  30570. </member>
  30571. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.RowSumsRight">
  30572. <summary>
  30573. Get if col summaries appear right of the detail in the outline
  30574. </summary>
  30575. <value><c>true</c> right or not; otherwise, <c>false</c>.</value>
  30576. </member>
  30577. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsPrintGridlines">
  30578. <summary>
  30579. Gets or sets whether gridlines are printed.
  30580. </summary>
  30581. <value>
  30582. <c>true</c> Gridlines are printed; otherwise, <c>false</c>.
  30583. </value>
  30584. </member>
  30585. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.PrintSetup">
  30586. <summary>
  30587. Gets the print setup object.
  30588. </summary>
  30589. <value>The user model for the print setup object.</value>
  30590. </member>
  30591. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Header">
  30592. <summary>
  30593. Gets the user model for the document header.
  30594. </summary>
  30595. <value>The Document header.</value>
  30596. </member>
  30597. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Footer">
  30598. <summary>
  30599. Gets the user model for the document footer.
  30600. </summary>
  30601. <value>The Document footer.</value>
  30602. </member>
  30603. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsRightToLeft">
  30604. <summary>
  30605. Gets or sets whether the worksheet is displayed from right to left instead of from left to right.
  30606. </summary>
  30607. <value>true for right to left, false otherwise</value>
  30608. <remarks>poi bug 47970</remarks>
  30609. </member>
  30610. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsSelected">
  30611. <summary>
  30612. Note - this is not the same as whether the _sheet is focused (isActive)
  30613. </summary>
  30614. <value>
  30615. <c>true</c> if this _sheet is currently selected; otherwise, <c>false</c>.
  30616. </value>
  30617. </member>
  30618. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsActive">
  30619. <summary>
  30620. Gets or sets a value indicating if this _sheet is currently focused.
  30621. </summary>
  30622. <value><c>true</c> if this _sheet is currently focused; otherwise, <c>false</c>.</value>
  30623. </member>
  30624. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Protect">
  30625. <summary>
  30626. Answer whether protection is enabled or disabled
  30627. </summary>
  30628. <value><c>true</c> if protection enabled; otherwise, <c>false</c>.</value>
  30629. </member>
  30630. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Password">
  30631. <summary>
  30632. Gets the hashed password
  30633. </summary>
  30634. <value>The password.</value>
  30635. </member>
  30636. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.ObjectProtect">
  30637. <summary>
  30638. Answer whether object protection is enabled or disabled
  30639. </summary>
  30640. <value><c>true</c> if protection enabled; otherwise, <c>false</c>.</value>
  30641. </member>
  30642. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.ScenarioProtect">
  30643. <summary>
  30644. Answer whether scenario protection is enabled or disabled
  30645. </summary>
  30646. <value><c>true</c> if protection enabled; otherwise, <c>false</c>.</value>
  30647. </member>
  30648. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.TopRow">
  30649. <summary>
  30650. The top row in the visible view when the _sheet is
  30651. first viewed after opening it in a viewer
  30652. </summary>
  30653. <value>the rownum (0 based) of the top row</value>
  30654. </member>
  30655. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.LeftCol">
  30656. <summary>
  30657. The left col in the visible view when the _sheet Is
  30658. first viewed after opening it in a viewer
  30659. </summary>
  30660. <value>the rownum (0 based) of the top row</value>
  30661. </member>
  30662. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.PaneInformation">
  30663. <summary>
  30664. Returns the information regarding the currently configured pane (split or freeze).
  30665. </summary>
  30666. <value>null if no pane configured, or the pane information.</value>
  30667. </member>
  30668. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayGridlines">
  30669. <summary>
  30670. Gets or sets if gridlines are Displayed.
  30671. </summary>
  30672. <value>whether gridlines are Displayed</value>
  30673. </member>
  30674. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayFormulas">
  30675. <summary>
  30676. Gets or sets a value indicating whether formulas are displayed.
  30677. </summary>
  30678. <value>whether formulas are Displayed</value>
  30679. </member>
  30680. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayRowColHeadings">
  30681. <summary>
  30682. Gets or sets a value indicating whether RowColHeadings are displayed.
  30683. </summary>
  30684. <value>
  30685. whether RowColHeadings are displayed
  30686. </value>
  30687. </member>
  30688. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.RowBreaks">
  30689. <summary>
  30690. Retrieves all the horizontal page breaks
  30691. </summary>
  30692. <value>all the horizontal page breaks, or null if there are no row page breaks</value>
  30693. </member>
  30694. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.ColumnBreaks">
  30695. <summary>
  30696. Retrieves all the vertical page breaks
  30697. </summary>
  30698. <value>all the vertical page breaks, or null if there are no column page breaks</value>
  30699. </member>
  30700. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DrawingEscherAggregate">
  30701. <summary>
  30702. Returns the agregate escher records for this _sheet,
  30703. it there is one.
  30704. WARNING - calling this will trigger a parsing of the
  30705. associated escher records. Any that aren't supported
  30706. (such as charts and complex drawing types) will almost
  30707. certainly be lost or corrupted when written out.
  30708. </summary>
  30709. <value>The drawing escher aggregate.</value>
  30710. </member>
  30711. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DrawingPatriarch">
  30712. This will hold any graphics or charts for the sheet.
  30713. @return the top-level drawing patriarch, if there is one, else returns null
  30714. </member>
  30715. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.TabColorIndex">
  30716. <summary>
  30717. Gets or sets the tab color of the _sheet
  30718. </summary>
  30719. </member>
  30720. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsAutoTabColor">
  30721. <summary>
  30722. Gets or sets whether the tab color of _sheet is automatic
  30723. </summary>
  30724. </member>
  30725. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.SheetConditionalFormatting">
  30726. <summary>
  30727. Gets the sheet conditional formatting.
  30728. </summary>
  30729. <value>The sheet conditional formatting.</value>
  30730. </member>
  30731. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DVRecords">
  30732. <summary>
  30733. Get the DVRecords objects that are associated to this _sheet
  30734. </summary>
  30735. <value>a list of DVRecord instances</value>
  30736. </member>
  30737. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Workbook">
  30738. <summary>
  30739. Provide a reference to the parent workbook.
  30740. </summary>
  30741. </member>
  30742. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.SheetName">
  30743. <summary>
  30744. Returns the name of this _sheet
  30745. </summary>
  30746. </member>
  30747. <member name="T:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting">
  30748. <summary>
  30749. The Conditional Formatting facet of HSSFSheet
  30750. @author Dmitriy Kumshayev
  30751. </summary>
  30752. </member>
  30753. <member name="T:NPOI.SS.UserModel.ISheetConditionalFormatting">
  30754. The 'Conditional Formatting' facet of <c>Sheet</c>
  30755. @author Dmitriy Kumshayev
  30756. @author Yegor Kozlov
  30757. @since 3.8
  30758. </member>
  30759. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule)">
  30760. <summary>
  30761. Add a new Conditional Formatting to the sheet.
  30762. </summary>
  30763. <param name="regions">list of rectangular regions to apply conditional formatting rules</param>
  30764. <param name="rule">the rule to apply</param>
  30765. <returns>index of the newly Created Conditional Formatting object</returns>
  30766. </member>
  30767. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule,NPOI.SS.UserModel.IConditionalFormattingRule)">
  30768. <summary>
  30769. Add a new Conditional Formatting consisting of two rules.
  30770. </summary>
  30771. <param name="regions"> list of rectangular regions to apply conditional formatting rules</param>
  30772. <param name="rule1">the first rule</param>
  30773. <param name="rule2">the second rule</param>
  30774. <returns>index of the newly Created Conditional Formatting object</returns>
  30775. </member>
  30776. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule[])">
  30777. <summary>
  30778. Add a new Conditional Formatting Set to the sheet.
  30779. </summary>
  30780. <param name="regions">list of rectangular regions to apply conditional formatting rules</param>
  30781. <param name="cfRules">Set of up to three conditional formatting rules</param>
  30782. <returns>index of the newly Created Conditional Formatting object</returns>
  30783. </member>
  30784. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.UserModel.IConditionalFormatting)">
  30785. <summary>
  30786. Adds a copy of a ConditionalFormatting object to the sheet
  30787. </summary>
  30788. <param name="cf">the Conditional Formatting to clone</param>
  30789. <returns>index of the new Conditional Formatting object</returns>
  30790. <remarks>
  30791. This method could be used to copy ConditionalFormatting object
  30792. from one sheet to another. For example:
  30793. ConditionalFormatting cf = sheet.GetConditionalFormattingAt(index);
  30794. newSheet.AddConditionalFormatting(cf);
  30795. </remarks>
  30796. </member>
  30797. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ComparisonOperator,System.String,System.String)">
  30798. A factory method allowing to create a conditional formatting rule
  30799. with a cell comparison operator
  30800. <p>
  30801. The Created conditional formatting rule Compares a cell value
  30802. to a formula calculated result, using the specified operator.
  30803. The type of the Created condition is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS}
  30804. </p>
  30805. @param comparisonOperation - MUST be a constant value from
  30806. <c>{@link ComparisonOperator}</c>: <p>
  30807. <ul>
  30808. <li>BETWEEN</li>
  30809. <li>NOT_BETWEEN</li>
  30810. <li>EQUAL</li>
  30811. <li>NOT_EQUAL</li>
  30812. <li>GT</li>
  30813. <li>LT</li>
  30814. <li>GE</li>
  30815. <li>LE</li>
  30816. </ul>
  30817. </p>
  30818. @param formula1 - formula for the valued, Compared with the cell
  30819. @param formula2 - second formula (only used with
  30820. {@link ComparisonOperator#BETWEEN}) and {@link ComparisonOperator#NOT_BETWEEN} operations)
  30821. </member>
  30822. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ComparisonOperator,System.String)">
  30823. <summary>
  30824. Create a conditional formatting rule that Compares a cell value to a formula calculated result, using an operator
  30825. </summary>
  30826. <param name="comparisonOperation">MUST be a constant value from ComparisonOperator except BETWEEN and NOT_BETWEEN</param>
  30827. <param name="formula">the formula to determine if the conditional formatting is applied</param>
  30828. <returns>a conditional formatting rule</returns>
  30829. </member>
  30830. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingRule(System.String)">
  30831. <summary>
  30832. Create a conditional formatting rule based on a Boolean formula.
  30833. When the formula result is true, the cell is highlighted.
  30834. </summary>
  30835. <param name="formula">the formula to Evaluate. MUST be a Boolean function.</param>
  30836. <returns>conditional formatting rule</returns>
  30837. </member>
  30838. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.GetConditionalFormattingAt(System.Int32)">
  30839. <summary>
  30840. Gets Conditional Formatting object at a particular index
  30841. </summary>
  30842. <param name="index">0-based index of the Conditional Formatting object to fetch</param>
  30843. <returns>Conditional Formatting object or null if not found</returns>
  30844. <exception cref="T:System.ArgumentException">throws ArgumentException if the index is outside of the allowable range (0 ... numberOfFormats-1)</exception>
  30845. </member>
  30846. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.RemoveConditionalFormatting(System.Int32)">
  30847. <summary>
  30848. Removes a Conditional Formatting object by index
  30849. </summary>
  30850. <param name="index">0-based index of the Conditional Formatting object to remove</param>
  30851. <exception cref="T:System.ArgumentException">throws ArgumentException if the index is outside of the allowable range (0 ... numberOfFormats-1)</exception>
  30852. </member>
  30853. <member name="P:NPOI.SS.UserModel.ISheetConditionalFormatting.NumConditionalFormattings">
  30854. <summary>
  30855. get the number of conditional formats in this sheet
  30856. </summary>
  30857. </member>
  30858. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ComparisonOperator,System.String,System.String)">
  30859. <summary>
  30860. A factory method allowing to Create a conditional formatting rule
  30861. with a cell comparison operator
  30862. TODO - formulas containing cell references are currently not Parsed properly
  30863. </summary>
  30864. <param name="comparisonOperation">a constant value from HSSFConditionalFormattingRule.ComparisonOperator</param>
  30865. <param name="formula1">formula for the valued, Compared with the cell</param>
  30866. <param name="formula2">second formula (only used with HSSFConditionalFormattingRule#COMPARISON_OPERATOR_BETWEEN
  30867. and HSSFConditionalFormattingRule#COMPARISON_OPERATOR_NOT_BETWEEN operations)</param>
  30868. <returns></returns>
  30869. </member>
  30870. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.CreateConditionalFormattingRule(System.String)">
  30871. <summary>
  30872. A factory method allowing to Create a conditional formatting rule with a formula.
  30873. The formatting rules are applied by Excel when the value of the formula not equal to 0.
  30874. TODO - formulas containing cell references are currently not Parsed properly
  30875. </summary>
  30876. <param name="formula">formula for the valued, Compared with the cell</param>
  30877. <returns></returns>
  30878. </member>
  30879. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.UserModel.IConditionalFormatting)">
  30880. <summary>
  30881. Adds a copy of HSSFConditionalFormatting object to the sheet
  30882. This method could be used to copy HSSFConditionalFormatting object
  30883. from one sheet to another.
  30884. </summary>
  30885. <param name="cf">HSSFConditionalFormatting object</param>
  30886. <returns>index of the new Conditional Formatting object</returns>
  30887. <example>
  30888. HSSFConditionalFormatting cf = sheet.GetConditionalFormattingAt(index);
  30889. newSheet.AddConditionalFormatting(cf);
  30890. </example>
  30891. </member>
  30892. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule[])">
  30893. <summary>
  30894. Allows to Add a new Conditional Formatting Set to the sheet.
  30895. </summary>
  30896. <param name="regions">list of rectangular regions to apply conditional formatting rules</param>
  30897. <param name="cfRules">Set of up to three conditional formatting rules</param>
  30898. <returns>index of the newly Created Conditional Formatting object</returns>
  30899. </member>
  30900. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule)">
  30901. <summary>
  30902. Adds the conditional formatting.
  30903. </summary>
  30904. <param name="regions">The regions.</param>
  30905. <param name="rule1">The rule1.</param>
  30906. <returns></returns>
  30907. </member>
  30908. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule,NPOI.SS.UserModel.IConditionalFormattingRule)">
  30909. <summary>
  30910. Adds the conditional formatting.
  30911. </summary>
  30912. <param name="regions">The regions.</param>
  30913. <param name="rule1">The rule1.</param>
  30914. <param name="rule2">The rule2.</param>
  30915. <returns></returns>
  30916. </member>
  30917. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.GetConditionalFormattingAt(System.Int32)">
  30918. <summary>
  30919. Gets Conditional Formatting object at a particular index
  30920. @param index
  30921. of the Conditional Formatting object to fetch
  30922. </summary>
  30923. <param name="index">Conditional Formatting object</param>
  30924. <returns></returns>
  30925. </member>
  30926. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.RemoveConditionalFormatting(System.Int32)">
  30927. <summary>
  30928. Removes a Conditional Formatting object by index
  30929. </summary>
  30930. <param name="index">index of a Conditional Formatting object to Remove</param>
  30931. </member>
  30932. <member name="P:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.NumConditionalFormattings">
  30933. <summary>
  30934. the number of Conditional Formatting objects of the sheet
  30935. </summary>
  30936. <value>The num conditional formattings.</value>
  30937. </member>
  30938. <member name="T:NPOI.HSSF.UserModel.HSSFWorkbook">
  30939. <summary>
  30940. High level representation of a workbook. This is the first object most users
  30941. will construct whether they are reading or writing a workbook. It is also the
  30942. top level object for creating new sheets/etc.
  30943. </summary>
  30944. @author Andrew C. Oliver (acoliver at apache dot org)
  30945. @author Glen Stampoultzis (glens at apache.org)
  30946. @author Shawn Laubach (slaubach at apache dot org)
  30947. </member>
  30948. <member name="T:NPOI.SS.UserModel.IWorkbook">
  30949. <summary>
  30950. High level interface of a Excel workbook. This is the first object most users
  30951. will construct whether they are reading or writing a workbook. It is also the
  30952. top level object for creating new sheets/etc.
  30953. This interface is shared between the implementation specific to xls and xlsx.
  30954. This way it is possible to access Excel workbooks stored in both formats.
  30955. </summary>
  30956. </member>
  30957. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSheetOrder(System.String,System.Int32)">
  30958. <summary>
  30959. Sets the order of appearance for a given sheet.
  30960. </summary>
  30961. <param name="sheetname">the name of the sheet to reorder</param>
  30962. <param name="pos">the position that we want to insert the sheet into (0 based)</param>
  30963. </member>
  30964. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSelectedTab(System.Int32)">
  30965. <summary>
  30966. Sets the tab whose data is actually seen when the sheet is opened.
  30967. This may be different from the "selected sheet" since excel seems to
  30968. allow you to show the data of one sheet when another is seen "selected"
  30969. in the tabs (at the bottom).
  30970. </summary>
  30971. <param name="index">the index of the sheet to select (0 based)</param>
  30972. </member>
  30973. <member name="M:NPOI.SS.UserModel.IWorkbook.SetActiveSheet(System.Int32)">
  30974. <summary>
  30975. set the active sheet. The active sheet is is the sheet
  30976. which is currently displayed when the workbook is viewed in Excel.
  30977. </summary>
  30978. <param name="sheetIndex">index of the active sheet (0-based)</param>
  30979. </member>
  30980. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheetName(System.Int32)">
  30981. <summary>
  30982. Set the sheet name
  30983. </summary>
  30984. <param name="sheet">sheet number (0 based)</param>
  30985. <returns>Sheet name</returns>
  30986. </member>
  30987. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSheetName(System.Int32,System.String)">
  30988. <summary>
  30989. Set the sheet name.
  30990. </summary>
  30991. <param name="sheet">sheet number (0 based)</param>
  30992. <param name="name">sheet name</param>
  30993. </member>
  30994. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheetIndex(System.String)">
  30995. <summary>
  30996. Returns the index of the sheet by its name
  30997. </summary>
  30998. <param name="name">the sheet name</param>
  30999. <returns>index of the sheet (0 based)</returns>
  31000. </member>
  31001. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheetIndex(NPOI.SS.UserModel.ISheet)">
  31002. <summary>
  31003. Returns the index of the given sheet
  31004. </summary>
  31005. <param name="sheet">the sheet to look up</param>
  31006. <returns>index of the sheet (0 based)</returns>
  31007. </member>
  31008. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateSheet">
  31009. <summary>
  31010. Sreate an Sheet for this Workbook, Adds it to the sheets and returns
  31011. the high level representation. Use this to create new sheets.
  31012. </summary>
  31013. <returns></returns>
  31014. </member>
  31015. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateSheet(System.String)">
  31016. <summary>
  31017. Create an Sheet for this Workbook, Adds it to the sheets and returns
  31018. the high level representation. Use this to create new sheets.
  31019. </summary>
  31020. <param name="sheetname">sheetname to set for the sheet.</param>
  31021. <returns>Sheet representing the new sheet.</returns>
  31022. </member>
  31023. <member name="M:NPOI.SS.UserModel.IWorkbook.CloneSheet(System.Int32)">
  31024. <summary>
  31025. Create an Sheet from an existing sheet in the Workbook.
  31026. </summary>
  31027. <param name="sheetNum"></param>
  31028. <returns></returns>
  31029. </member>
  31030. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheetAt(System.Int32)">
  31031. <summary>
  31032. Get the Sheet object at the given index.
  31033. </summary>
  31034. <param name="index">index of the sheet number (0-based physical &amp; logical)</param>
  31035. <returns>Sheet at the provided index</returns>
  31036. </member>
  31037. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheet(System.String)">
  31038. <summary>
  31039. Get sheet with the given name
  31040. </summary>
  31041. <param name="name">name of the sheet</param>
  31042. <returns>Sheet with the name provided or null if it does not exist</returns>
  31043. </member>
  31044. <member name="M:NPOI.SS.UserModel.IWorkbook.RemoveSheetAt(System.Int32)">
  31045. <summary>
  31046. Removes sheet at the given index
  31047. </summary>
  31048. <param name="index"></param>
  31049. </member>
  31050. <member name="M:NPOI.SS.UserModel.IWorkbook.GetEnumerator">
  31051. <summary>
  31052. Enumerate sheets
  31053. </summary>
  31054. <returns></returns>
  31055. </member>
  31056. <member name="M:NPOI.SS.UserModel.IWorkbook.SetRepeatingRowsAndColumns(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  31057. To set just repeating columns:
  31058. workbook.SetRepeatingRowsAndColumns(0,0,1,-1-1);
  31059. To set just repeating rows:
  31060. workbook.SetRepeatingRowsAndColumns(0,-1,-1,0,4);
  31061. To remove all repeating rows and columns for a sheet.
  31062. workbook.SetRepeatingRowsAndColumns(0,-1,-1,-1,-1);
  31063. <summary>
  31064. Sets the repeating rows and columns for a sheet (as found in
  31065. File->PageSetup->Sheet). This is function is included in the workbook
  31066. because it Creates/modifies name records which are stored at the
  31067. workbook level.
  31068. </summary>
  31069. <param name="sheetIndex">0 based index to sheet.</param>
  31070. <param name="startColumn">0 based start of repeating columns.</param>
  31071. <param name="endColumn">0 based end of repeating columns.</param>
  31072. <param name="startRow">0 based start of repeating rows.</param>
  31073. <param name="endRow">0 based end of repeating rows.</param>
  31074. </member>
  31075. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateFont">
  31076. <summary>
  31077. Create a new Font and add it to the workbook's font table
  31078. </summary>
  31079. <returns></returns>
  31080. </member>
  31081. <member name="M:NPOI.SS.UserModel.IWorkbook.FindFont(System.Int16,System.Int16,System.Int16,System.String,System.Boolean,System.Boolean,NPOI.SS.UserModel.FontSuperScript,NPOI.SS.UserModel.FontUnderlineType)">
  31082. <summary>
  31083. Finds a font that matches the one with the supplied attributes
  31084. </summary>
  31085. <param name="boldWeight"></param>
  31086. <param name="color"></param>
  31087. <param name="fontHeight"></param>
  31088. <param name="name"></param>
  31089. <param name="italic"></param>
  31090. <param name="strikeout"></param>
  31091. <param name="typeOffset"></param>
  31092. <param name="underline"></param>
  31093. <returns>the font with the matched attributes or null</returns>
  31094. </member>
  31095. <member name="M:NPOI.SS.UserModel.IWorkbook.GetFontAt(System.Int16)">
  31096. <summary>
  31097. Get the font at the given index number
  31098. </summary>
  31099. <param name="idx">index number (0-based)</param>
  31100. <returns>font at the index</returns>
  31101. </member>
  31102. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateCellStyle">
  31103. <summary>
  31104. Create a new Cell style and add it to the workbook's style table
  31105. </summary>
  31106. <returns>the new Cell Style object</returns>
  31107. </member>
  31108. <member name="M:NPOI.SS.UserModel.IWorkbook.GetCellStyleAt(System.Int16)">
  31109. <summary>
  31110. Get the cell style object at the given index
  31111. </summary>
  31112. <param name="idx">index within the set of styles (0-based)</param>
  31113. <returns>CellStyle object at the index</returns>
  31114. </member>
  31115. <member name="M:NPOI.SS.UserModel.IWorkbook.Write(System.IO.Stream)">
  31116. <summary>
  31117. Write out this workbook to an OutPutstream.
  31118. </summary>
  31119. <param name="stream">the stream you wish to write to</param>
  31120. </member>
  31121. <member name="M:NPOI.SS.UserModel.IWorkbook.GetName(System.String)">
  31122. <summary>
  31123. the defined name with the specified name.
  31124. </summary>
  31125. <param name="name">the name of the defined name</param>
  31126. <returns>the defined name with the specified name. null if not found</returns>
  31127. </member>
  31128. <member name="M:NPOI.SS.UserModel.IWorkbook.GetNameAt(System.Int32)">
  31129. <summary>
  31130. the defined name at the specified index
  31131. </summary>
  31132. <param name="nameIndex">position of the named range (0-based)</param>
  31133. <returns></returns>
  31134. </member>
  31135. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateName">
  31136. <summary>
  31137. Creates a new (unInitialised) defined name in this workbook
  31138. </summary>
  31139. <returns>new defined name object</returns>
  31140. </member>
  31141. <member name="M:NPOI.SS.UserModel.IWorkbook.GetNameIndex(System.String)">
  31142. <summary>
  31143. Gets the defined name index by name
  31144. </summary>
  31145. <param name="name">the name of the defined name</param>
  31146. <returns>zero based index of the defined name.</returns>
  31147. </member>
  31148. <member name="M:NPOI.SS.UserModel.IWorkbook.RemoveName(System.Int32)">
  31149. <summary>
  31150. Remove the defined name at the specified index
  31151. </summary>
  31152. <param name="index">named range index (0 based)</param>
  31153. </member>
  31154. <member name="M:NPOI.SS.UserModel.IWorkbook.RemoveName(System.String)">
  31155. <summary>
  31156. Remove a defined name by name
  31157. </summary>
  31158. <param name="name">the name of the defined name</param>
  31159. </member>
  31160. <member name="M:NPOI.SS.UserModel.IWorkbook.LinkExternalWorkbook(System.String,NPOI.SS.UserModel.IWorkbook)">
  31161. <summary>
  31162. Adds the linking required to allow formulas referencing the specified
  31163. external workbook to be added to this one. In order for formulas
  31164. such as "[MyOtherWorkbook]Sheet3!$A$5" to be added to the file,
  31165. some linking information must first be recorded. Once a given external
  31166. workbook has been linked, then formulas using it can added. Each workbook
  31167. needs linking only once. <br/>
  31168. This linking only applies for writing formulas.
  31169. To link things for evaluation, see {@link FormulaEvaluator#setupReferencedWorkbooks(java.util.Map)}
  31170. </summary>
  31171. <param name="name">The name the workbook will be referenced as in formulas</param>
  31172. <param name="workbook">The open workbook to fetch the link required information from</param>
  31173. <returns></returns>
  31174. </member>
  31175. <member name="M:NPOI.SS.UserModel.IWorkbook.SetPrintArea(System.Int32,System.String)">
  31176. <summary>
  31177. Sets the printarea for the sheet provided
  31178. </summary>
  31179. <param name="sheetIndex">Zero-based sheet index</param>
  31180. <param name="reference">Valid name Reference for the Print Area</param>
  31181. </member>
  31182. <member name="M:NPOI.SS.UserModel.IWorkbook.SetPrintArea(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  31183. <summary>
  31184. Sets the printarea for the sheet provided
  31185. </summary>
  31186. <param name="sheetIndex">Zero-based sheet index (0 = First Sheet)</param>
  31187. <param name="startColumn">Column to begin printarea</param>
  31188. <param name="endColumn">Column to end the printarea</param>
  31189. <param name="startRow">Row to begin the printarea</param>
  31190. <param name="endRow">Row to end the printarea</param>
  31191. </member>
  31192. <member name="M:NPOI.SS.UserModel.IWorkbook.GetPrintArea(System.Int32)">
  31193. <summary>
  31194. Retrieves the reference for the printarea of the specified sheet,
  31195. the sheet name is Appended to the reference even if it was not specified.
  31196. </summary>
  31197. <param name="sheetIndex">Zero-based sheet index</param>
  31198. <returns>Null if no print area has been defined</returns>
  31199. </member>
  31200. <member name="M:NPOI.SS.UserModel.IWorkbook.RemovePrintArea(System.Int32)">
  31201. <summary>
  31202. Delete the printarea for the sheet specified
  31203. </summary>
  31204. <param name="sheetIndex">Zero-based sheet index (0 = First Sheet)</param>
  31205. </member>
  31206. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateDataFormat">
  31207. <summary>
  31208. Returns the instance of DataFormat for this workbook.
  31209. </summary>
  31210. <returns>the DataFormat object</returns>
  31211. </member>
  31212. <member name="M:NPOI.SS.UserModel.IWorkbook.AddPicture(System.Byte[],NPOI.SS.UserModel.PictureType)">
  31213. <summary>
  31214. Adds a picture to the workbook.
  31215. </summary>
  31216. <param name="pictureData">The bytes of the picture</param>
  31217. <param name="format">The format of the picture.</param>
  31218. <returns>the index to this picture (1 based).</returns>
  31219. </member>
  31220. <member name="M:NPOI.SS.UserModel.IWorkbook.GetAllPictures">
  31221. <summary>
  31222. Gets all pictures from the Workbook.
  31223. </summary>
  31224. <returns>the list of pictures (a list of link PictureData objects.)</returns>
  31225. </member>
  31226. <member name="M:NPOI.SS.UserModel.IWorkbook.GetCreationHelper">
  31227. <summary>
  31228. Return an object that handles instantiating concrete classes of
  31229. the various instances one needs for HSSF and XSSF.
  31230. </summary>
  31231. <returns></returns>
  31232. </member>
  31233. <member name="M:NPOI.SS.UserModel.IWorkbook.IsSheetHidden(System.Int32)">
  31234. <summary>
  31235. Check whether a sheet is hidden.
  31236. </summary>
  31237. <param name="sheetIx">number of sheet</param>
  31238. <returns>true if sheet is hidden</returns>
  31239. </member>
  31240. <member name="M:NPOI.SS.UserModel.IWorkbook.IsSheetVeryHidden(System.Int32)">
  31241. Check whether a sheet is very hidden.
  31242. <p>
  31243. This is different from the normal hidden status
  31244. ({@link #isSheetHidden(int)})
  31245. </p>
  31246. @param sheetIx sheet index to check
  31247. @return <code>true</code> if sheet is very hidden
  31248. </member>
  31249. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSheetHidden(System.Int32,NPOI.SS.UserModel.SheetState)">
  31250. Hide or unhide a sheet
  31251. @param sheetIx the sheet index (0-based)
  31252. @param hidden True to mark the sheet as hidden, false otherwise
  31253. </member>
  31254. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSheetHidden(System.Int32,System.Int32)">
  31255. Hide or unhide a sheet.
  31256. <pre>
  31257. 0 = not hidden
  31258. 1 = hidden
  31259. 2 = very hidden.
  31260. </pre>
  31261. @param sheetIx The sheet number
  31262. @param hidden 0 for not hidden, 1 for hidden, 2 for very hidden
  31263. </member>
  31264. <member name="M:NPOI.SS.UserModel.IWorkbook.AddToolPack(NPOI.SS.Formula.Udf.UDFFinder)">
  31265. <summary>
  31266. Register a new toolpack in this workbook.
  31267. </summary>
  31268. <param name="toopack">the toolpack to register</param>
  31269. </member>
  31270. <member name="P:NPOI.SS.UserModel.IWorkbook.ActiveSheetIndex">
  31271. <summary>
  31272. get the active sheet. The active sheet is is the sheet
  31273. which is currently displayed when the workbook is viewed in Excel.
  31274. </summary>
  31275. </member>
  31276. <member name="P:NPOI.SS.UserModel.IWorkbook.FirstVisibleTab">
  31277. <summary>
  31278. Gets the first tab that is displayed in the list of tabs in excel.
  31279. </summary>
  31280. </member>
  31281. <member name="P:NPOI.SS.UserModel.IWorkbook.NumberOfSheets">
  31282. <summary>
  31283. Get the number of spreadsheets in the workbook
  31284. </summary>
  31285. </member>
  31286. <member name="P:NPOI.SS.UserModel.IWorkbook.NumberOfFonts">
  31287. <summary>
  31288. Get the number of fonts in the font table
  31289. </summary>
  31290. </member>
  31291. <member name="P:NPOI.SS.UserModel.IWorkbook.NumCellStyles">
  31292. <summary>
  31293. Get the number of styles the workbook Contains
  31294. </summary>
  31295. </member>
  31296. <member name="P:NPOI.SS.UserModel.IWorkbook.NumberOfNames">
  31297. <summary>
  31298. the total number of defined names in this workbook
  31299. </summary>
  31300. </member>
  31301. <member name="P:NPOI.SS.UserModel.IWorkbook.MissingCellPolicy">
  31302. <summary>
  31303. Retrieves the current policy on what to do when getting missing or blank cells from a row.
  31304. </summary>
  31305. </member>
  31306. <member name="P:NPOI.SS.UserModel.IWorkbook.IsHidden">
  31307. <summary>
  31308. if this workbook is not visible in the GUI
  31309. </summary>
  31310. </member>
  31311. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.MAX_STYLES">
  31312. The maximum number of cell styles in a .xls workbook.
  31313. The 'official' limit is 4,000, but POI allows a slightly larger number.
  31314. This extra delta takes into account built-in styles that are automatically
  31315. created for new workbooks
  31316. See http://office.microsoft.com/en-us/excel-help/excel-specifications-and-limits-HP005199291.aspx
  31317. </member>
  31318. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.INITIAL_CAPACITY">
  31319. used for compile-time performance/memory optimization. This determines the
  31320. initial capacity for the sheet collection. Its currently Set to 3.
  31321. Changing it in this release will decrease performance
  31322. since you're never allowed to have more or less than three sheets!
  31323. </member>
  31324. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.ENCODING_COMPRESSED_UNICODE">
  31325. @deprecated POI will now properly handle Unicode strings without
  31326. forceing an encoding
  31327. </member>
  31328. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.ENCODING_UTF_16">
  31329. @deprecated POI will now properly handle Unicode strings without
  31330. forceing an encoding
  31331. </member>
  31332. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.workbook">
  31333. this Is the reference to the low level Workbook object
  31334. </member>
  31335. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook._sheets">
  31336. this holds the HSSFSheet objects attached to this workbook
  31337. </member>
  31338. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.names">
  31339. this holds the HSSFName objects attached to this workbook
  31340. </member>
  31341. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.preserveNodes">
  31342. holds whether or not to preserve other nodes in the POIFS. Used
  31343. for macros and embedded objects.
  31344. </member>
  31345. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.formatter">
  31346. Used to keep track of the data formatter so that all
  31347. CreateDataFormatter calls return the same one for a given
  31348. book. This Ensures that updates from one places Is visible
  31349. someplace else.
  31350. </member>
  31351. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.fonts">
  31352. this holds the HSSFFont objects attached to this workbook.
  31353. We only create these from the low level records as required.
  31354. </member>
  31355. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor">
  31356. <summary>
  31357. Creates new HSSFWorkbook from scratch (start here!)
  31358. </summary>
  31359. </member>
  31360. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  31361. Companion to HSSFWorkbook(POIFSFileSystem), this constructs the
  31362. POI filesystem around your inputstream, including all nodes.
  31363. This calls {@link #HSSFWorkbook(InputStream, boolean)} with
  31364. preserve nodes set to true.
  31365. @see #HSSFWorkbook(InputStream, boolean)
  31366. @see #HSSFWorkbook(POIFSFileSystem)
  31367. @see org.apache.poi.poifs.filesystem.POIFSFileSystem
  31368. @exception IOException if the stream cannot be read
  31369. </member>
  31370. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem,System.Boolean)">
  31371. <summary>
  31372. given a POI POIFSFileSystem object, Read in its Workbook and populate the high and
  31373. low level models. If you're Reading in a workbook...start here.
  31374. </summary>
  31375. <param name="fs">the POI filesystem that Contains the Workbook stream.</param>
  31376. <param name="preserveNodes">whether to preseve other nodes, such as
  31377. macros. This takes more memory, so only say yes if you
  31378. need to. If Set, will store all of the POIFSFileSystem
  31379. in memory</param>
  31380. </member>
  31381. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.WORKBOOK_DIR_ENTRY_NAMES">
  31382. Normally, the Workbook will be in a POIFS Stream
  31383. called "Workbook". However, some weird XLS generators use "WORKBOOK"
  31384. </member>
  31385. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.DirectoryNode,NPOI.POIFS.FileSystem.POIFSFileSystem,System.Boolean)">
  31386. <summary>
  31387. given a POI POIFSFileSystem object, and a specific directory
  31388. within it, Read in its Workbook and populate the high and
  31389. low level models. If you're Reading in a workbook...start here.
  31390. </summary>
  31391. <param name="directory">the POI filesystem directory to Process from</param>
  31392. <param name="fs">the POI filesystem that Contains the Workbook stream.</param>
  31393. <param name="preserveNodes">whether to preseve other nodes, such as
  31394. macros. This takes more memory, so only say yes if you
  31395. need to. If Set, will store all of the POIFSFileSystem
  31396. in memory</param>
  31397. </member>
  31398. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.DirectoryNode,System.Boolean)">
  31399. given a POI POIFSFileSystem object, and a specific directory
  31400. within it, read in its Workbook and populate the high and
  31401. low level models. If you're reading in a workbook...start here.
  31402. @param directory the POI filesystem directory to process from
  31403. @param preserveNodes whether to preseve other nodes, such as
  31404. macros. This takes more memory, so only say yes if you
  31405. need to. If set, will store all of the POIFSFileSystem
  31406. in memory
  31407. @see org.apache.poi.poifs.filesystem.POIFSFileSystem
  31408. @exception IOException if the stream cannot be read
  31409. </member>
  31410. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(System.IO.Stream,System.Boolean)">
  31411. Companion to HSSFWorkbook(POIFSFileSystem), this constructs the POI filesystem around your
  31412. inputstream.
  31413. @param s the POI filesystem that Contains the Workbook stream.
  31414. @param preserveNodes whether to preseve other nodes, such as
  31415. macros. This takes more memory, so only say yes if you
  31416. need to.
  31417. @see org.apache.poi.poifs.filesystem.POIFSFileSystem
  31418. @see #HSSFWorkbook(POIFSFileSystem)
  31419. @exception IOException if the stream cannot be Read
  31420. </member>
  31421. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetPropertiesFromWorkbook(NPOI.HSSF.Model.InternalWorkbook)">
  31422. used internally to Set the workbook properties.
  31423. </member>
  31424. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ConvertLabelRecords(System.Collections.IList,System.Int32)">
  31425. <summary>
  31426. This is basically a kludge to deal with the now obsolete Label records. If
  31427. you have to read in a sheet that contains Label records, be aware that the rest
  31428. of the API doesn't deal with them, the low level structure only provides Read-only
  31429. semi-immutable structures (the Sets are there for interface conformance with NO
  31430. impelmentation). In short, you need to call this function passing it a reference
  31431. to the Workbook object. All labels will be converted to LabelSST records and their
  31432. contained strings will be written to the Shared String tabel (SSTRecord) within
  31433. the Workbook.
  31434. </summary>
  31435. <param name="records">The records.</param>
  31436. <param name="offset">The offset.</param>
  31437. </member>
  31438. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSheetOrder(System.String,System.Int32)">
  31439. <summary>
  31440. Sets the order of appearance for a given sheet.
  31441. </summary>
  31442. <param name="sheetname">the name of the sheet to reorder</param>
  31443. <param name="pos">the position that we want to Insert the sheet into (0 based)</param>
  31444. </member>
  31445. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ValidateSheetIndex(System.Int32)">
  31446. <summary>
  31447. Validates the index of the sheet.
  31448. </summary>
  31449. <param name="index">The index.</param>
  31450. </member>
  31451. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.InsertChartRecord">
  31452. Test only. Do not use
  31453. </member>
  31454. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSelectedTab(System.Int32)">
  31455. <summary>
  31456. Selects a single sheet. This may be different to
  31457. the 'active' sheet (which Is the sheet with focus).
  31458. </summary>
  31459. <param name="index">The index.</param>
  31460. </member>
  31461. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSelectedTabs(System.Int32[])">
  31462. <summary>
  31463. Sets the selected tabs.
  31464. </summary>
  31465. <param name="indexes">The indexes.</param>
  31466. </member>
  31467. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetActiveSheet(System.Int32)">
  31468. <summary>
  31469. Sets the tab whose data is actually seen when the sheet is opened.
  31470. This may be different from the "selected sheet" since excel seems to
  31471. allow you to show the data of one sheet when another Is seen "selected"
  31472. in the tabs (at the bottom).
  31473. <param name="index">The sheet number(0 based).</param>
  31474. </summary>
  31475. </member>
  31476. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSheetName(System.Int32,System.String)">
  31477. <summary>
  31478. Set the sheet name.
  31479. </summary>
  31480. <param name="sheetIx">The sheet number(0 based).</param>
  31481. <param name="name">The name.</param>
  31482. </member>
  31483. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheetName(System.Int32)">
  31484. <summary>
  31485. Get the sheet name
  31486. </summary>
  31487. <param name="sheetIx">The sheet index.</param>
  31488. <returns>Sheet name</returns>
  31489. </member>
  31490. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.IsSheetHidden(System.Int32)">
  31491. <summary>
  31492. Check whether a sheet is hidden
  31493. </summary>
  31494. <param name="sheetIx">The sheet index.</param>
  31495. <returns>
  31496. <c>true</c> if sheet is hidden; otherwise, <c>false</c>.
  31497. </returns>
  31498. </member>
  31499. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.IsSheetVeryHidden(System.Int32)">
  31500. <summary>
  31501. Check whether a sheet is very hidden.
  31502. This is different from the normal
  31503. hidden status
  31504. </summary>
  31505. <param name="sheetIx">The sheet index.</param>
  31506. <returns>
  31507. <c>true</c> if sheet is very hidden; otherwise, <c>false</c>.
  31508. </returns>
  31509. </member>
  31510. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSheetHidden(System.Int32,NPOI.SS.UserModel.SheetState)">
  31511. <summary>
  31512. Hide or Unhide a sheet
  31513. </summary>
  31514. <param name="sheetIx">The sheet index</param>
  31515. <param name="hidden">True to mark the sheet as hidden, false otherwise</param>
  31516. </member>
  31517. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSheetHidden(System.Int32,System.Int32)">
  31518. <summary>
  31519. Hide or unhide a sheet.
  31520. </summary>
  31521. <param name="sheetIx">The sheet number</param>
  31522. <param name="hidden">0 for not hidden, 1 for hidden, 2 for very hidden</param>
  31523. </member>
  31524. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheetIndex(System.String)">
  31525. <summary>
  31526. Returns the index of the sheet by his name
  31527. </summary>
  31528. <param name="name">the sheet name</param>
  31529. <returns>index of the sheet (0 based)</returns>
  31530. </member>
  31531. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheetIndex(NPOI.SS.UserModel.ISheet)">
  31532. <summary>
  31533. Returns the index of the given sheet
  31534. </summary>
  31535. <param name="sheet">the sheet to look up</param>
  31536. <returns>index of the sheet (0 based).-1
  31537. if not found </returns>
  31538. </member>
  31539. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetExternalSheetIndex(System.Int32)">
  31540. <summary>
  31541. Returns the external sheet index of the sheet
  31542. with the given internal index, creating one
  31543. if needed.
  31544. Used by some of the more obscure formula and
  31545. named range things.
  31546. </summary>
  31547. <param name="internalSheetIndex">Index of the internal sheet.</param>
  31548. <returns></returns>
  31549. </member>
  31550. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateSheet">
  31551. <summary>
  31552. Create an HSSFSheet for this HSSFWorkbook, Adds it to the sheets and returns
  31553. the high level representation. Use this to Create new sheets.
  31554. </summary>
  31555. <returns>HSSFSheet representing the new sheet.</returns>
  31556. </member>
  31557. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CloneSheet(System.Int32)">
  31558. <summary>
  31559. Create an HSSFSheet from an existing sheet in the HSSFWorkbook.
  31560. </summary>
  31561. <param name="sheetIndex">the sheet index</param>
  31562. <returns>HSSFSheet representing the Cloned sheet.</returns>
  31563. </member>
  31564. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetUniqueSheetName(System.String)">
  31565. <summary>
  31566. Gets the name of the unique sheet.
  31567. </summary>
  31568. <param name="srcName">Name of the SRC.</param>
  31569. <returns></returns>
  31570. </member>
  31571. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateSheet(System.String)">
  31572. <summary>
  31573. Create an HSSFSheet for this HSSFWorkbook, Adds it to the sheets and
  31574. returns the high level representation. Use this to Create new sheets.
  31575. </summary>
  31576. <param name="sheetname">sheetname to set for the sheet.</param>
  31577. <returns>HSSFSheet representing the new sheet.</returns>
  31578. </member>
  31579. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheets">
  31580. <summary>
  31581. Gets the sheets.
  31582. </summary>
  31583. <returns></returns>
  31584. </member>
  31585. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheetAt(System.Int32)">
  31586. <summary>
  31587. Get the HSSFSheet object at the given index.
  31588. </summary>
  31589. <param name="index">index of the sheet number (0-based)</param>
  31590. <returns>HSSFSheet at the provided index</returns>
  31591. </member>
  31592. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheet(System.String)">
  31593. <summary>
  31594. Get sheet with the given name (case insensitive match)
  31595. </summary>
  31596. <param name="name">name of the sheet</param>
  31597. <returns>HSSFSheet with the name provided or null if it does not exist</returns>
  31598. </member>
  31599. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemoveSheetAt(System.Int32)">
  31600. <summary>
  31601. Removes sheet at the given index.
  31602. </summary>
  31603. <param name="index">index of the sheet (0-based)</param>
  31604. <remarks>
  31605. Care must be taken if the Removed sheet Is the currently active or only selected sheet in
  31606. the workbook. There are a few situations when Excel must have a selection and/or active
  31607. sheet. (For example when printing - see Bug 40414).
  31608. This method makes sure that if the Removed sheet was active, another sheet will become
  31609. active in its place. Furthermore, if the Removed sheet was the only selected sheet, another
  31610. sheet will become selected. The newly active/selected sheet will have the same index, or
  31611. one less if the Removed sheet was the last in the workbook.
  31612. </remarks>
  31613. </member>
  31614. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetRepeatingRowsAndColumns(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  31615. <summary>
  31616. Sets the repeating rows and columns for a sheet (as found in
  31617. File-&gt;PageSetup-&gt;Sheet). This Is function Is included in the workbook
  31618. because it Creates/modifies name records which are stored at the
  31619. workbook level.
  31620. </summary>
  31621. <param name="sheetIndex">0 based index to sheet.</param>
  31622. <param name="startColumn">0 based start of repeating columns.</param>
  31623. <param name="endColumn">0 based end of repeating columns.</param>
  31624. <param name="startRow">0 based start of repeating rows.</param>
  31625. <param name="endRow">0 based end of repeating rows.</param>
  31626. <example>
  31627. To set just repeating columns:
  31628. workbook.SetRepeatingRowsAndColumns(0,0,1,-1-1);
  31629. To set just repeating rows:
  31630. workbook.SetRepeatingRowsAndColumns(0,-1,-1,0,4);
  31631. To remove all repeating rows and columns for a sheet.
  31632. workbook.SetRepeatingRowsAndColumns(0,-1,-1,-1,-1);
  31633. </example>
  31634. </member>
  31635. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateFont">
  31636. <summary>
  31637. Create a new Font and Add it to the workbook's font table
  31638. </summary>
  31639. <returns>new font object</returns>
  31640. </member>
  31641. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.FindFont(System.Int16,System.Int16,System.Int16,System.String,System.Boolean,System.Boolean,NPOI.SS.UserModel.FontSuperScript,NPOI.SS.UserModel.FontUnderlineType)">
  31642. <summary>
  31643. Finds a font that matches the one with the supplied attributes
  31644. </summary>
  31645. <param name="boldWeight">The bold weight.</param>
  31646. <param name="color">The color.</param>
  31647. <param name="fontHeight">Height of the font.</param>
  31648. <param name="name">The name.</param>
  31649. <param name="italic">if set to <c>true</c> [italic].</param>
  31650. <param name="strikeout">if set to <c>true</c> [strikeout].</param>
  31651. <param name="typeOffset">The type offset.</param>
  31652. <param name="underline">The underline.</param>
  31653. <returns></returns>
  31654. </member>
  31655. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetFontAt(System.Int16)">
  31656. <summary>
  31657. Get the font at the given index number
  31658. </summary>
  31659. <param name="idx">The index number</param>
  31660. <returns>HSSFFont at the index</returns>
  31661. </member>
  31662. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ResetFontCache">
  31663. <summary>
  31664. Reset the fonts cache, causing all new calls
  31665. to getFontAt() to create new objects.
  31666. Should only be called after deleting fonts,
  31667. and that's not something you should normally do
  31668. </summary>
  31669. </member>
  31670. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateCellStyle">
  31671. <summary>
  31672. Create a new Cell style and Add it to the workbook's style table
  31673. </summary>
  31674. <returns>the new Cell Style object</returns>
  31675. </member>
  31676. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetCellStyleAt(System.Int16)">
  31677. <summary>
  31678. Get the cell style object at the given index
  31679. </summary>
  31680. <param name="idx">index within the Set of styles</param>
  31681. <returns>HSSFCellStyle object at the index</returns>
  31682. </member>
  31683. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.Close">
  31684. Closes the underlying {@link NPOIFSFileSystem} from which
  31685. the Workbook was read, if any. Has no effect on Workbooks
  31686. opened from an InputStream, or newly created ones.
  31687. </member>
  31688. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.Write(System.IO.Stream)">
  31689. <summary>
  31690. Write out this workbook to an Outputstream. Constructs
  31691. a new POI POIFSFileSystem, passes in the workbook binary representation and
  31692. Writes it out.
  31693. </summary>
  31694. <param name="stream">the java OutputStream you wish to Write the XLS to</param>
  31695. </member>
  31696. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetBytes">
  31697. <summary>
  31698. Get the bytes of just the HSSF portions of the XLS file.
  31699. Use this to construct a POI POIFSFileSystem yourself.
  31700. </summary>
  31701. <returns>byte[] array containing the binary representation of this workbook and all contained
  31702. sheets, rows, cells, etc.</returns>
  31703. </member>
  31704. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook._udfFinder">
  31705. The locator of user-defined functions.
  31706. By default includes functions from the Excel Analysis Toolpack
  31707. </member>
  31708. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.AddToolPack(NPOI.SS.Formula.Udf.UDFFinder)">
  31709. Register a new toolpack in this workbook.
  31710. @param toopack the toolpack to register
  31711. </member>
  31712. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetNameAt(System.Int32)">
  31713. <summary>
  31714. Gets the Named range
  31715. </summary>
  31716. <param name="nameIndex">position of the named range</param>
  31717. <returns>named range high level</returns>
  31718. </member>
  31719. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetNameName(System.Int32)">
  31720. <summary>
  31721. Gets the named range name
  31722. </summary>
  31723. <param name="index">the named range index (0 based)</param>
  31724. <returns>named range name</returns>
  31725. </member>
  31726. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ResolveNameXText(System.Int32,System.Int32)">
  31727. <summary>
  31728. TODO - make this less cryptic / move elsewhere
  31729. </summary>
  31730. <param name="reFindex">Index to REF entry in EXTERNSHEET record in the Link Table</param>
  31731. <param name="definedNameIndex">zero-based to DEFINEDNAME or EXTERNALNAME record</param>
  31732. <returns>the string representation of the defined or external name</returns>
  31733. </member>
  31734. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetPrintArea(System.Int32,System.String)">
  31735. <summary>
  31736. Sets the printarea for the sheet provided
  31737. i.e. Reference = $A$1:$B$2
  31738. </summary>
  31739. <param name="sheetIndex">Zero-based sheet index (0 Represents the first sheet to keep consistent with java)</param>
  31740. <param name="reference">Valid name Reference for the Print Area</param>
  31741. </member>
  31742. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetPrintArea(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  31743. <summary>
  31744. Sets the print area.
  31745. </summary>
  31746. <param name="sheetIndex">Zero-based sheet index (0 = First Sheet)</param>
  31747. <param name="startColumn">Column to begin printarea</param>
  31748. <param name="endColumn">Column to end the printarea</param>
  31749. <param name="startRow">Row to begin the printarea</param>
  31750. <param name="endRow">Row to end the printarea</param>
  31751. </member>
  31752. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetPrintArea(System.Int32)">
  31753. <summary>
  31754. Retrieves the reference for the printarea of the specified sheet, the sheet name Is Appended to the reference even if it was not specified.
  31755. </summary>
  31756. <param name="sheetIndex">Zero-based sheet index (0 Represents the first sheet to keep consistent with java)</param>
  31757. <returns>String Null if no print area has been defined</returns>
  31758. </member>
  31759. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemovePrintArea(System.Int32)">
  31760. <summary>
  31761. Delete the printarea for the sheet specified
  31762. </summary>
  31763. <param name="sheetIndex">Zero-based sheet index (0 = First Sheet)</param>
  31764. </member>
  31765. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateName">
  31766. <summary>
  31767. Creates a new named range and Add it to the model
  31768. </summary>
  31769. <returns>named range high level</returns>
  31770. </member>
  31771. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetNameIndex(System.String)">
  31772. <summary>
  31773. Gets the named range index by his name
  31774. Note:
  31775. Excel named ranges are case-insensitive and
  31776. this method performs a case-insensitive search.
  31777. </summary>
  31778. <param name="name">named range name</param>
  31779. <returns>named range index</returns>
  31780. </member>
  31781. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetNameIndex(NPOI.HSSF.UserModel.HSSFName)">
  31782. <summary>
  31783. As GetNameIndex(String) is not necessarily unique
  31784. (name + sheet index is unique), this method is more accurate.
  31785. </summary>
  31786. <param name="name">the name whose index in the list of names of this workbook should be looked up.</param>
  31787. <returns>an index value >= 0 if the name was found; -1, if the name was not found</returns>
  31788. </member>
  31789. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemoveName(System.Int32)">
  31790. <summary>
  31791. Remove the named range by his index
  31792. </summary>
  31793. <param name="index">The named range index (0 based)</param>
  31794. </member>
  31795. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateDataFormat">
  31796. <summary>
  31797. Creates the instance of HSSFDataFormat for this workbook.
  31798. </summary>
  31799. <returns>the HSSFDataFormat object</returns>
  31800. </member>
  31801. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemoveName(System.String)">
  31802. <summary>
  31803. Remove the named range by his name
  31804. </summary>
  31805. <param name="name">named range name</param>
  31806. </member>
  31807. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemoveName(NPOI.HSSF.UserModel.HSSFName)">
  31808. <summary>
  31809. As #removeName(String) is not necessarily unique (name + sheet index is unique),
  31810. this method is more accurate.
  31811. </summary>
  31812. <param name="name">the name to remove.</param>
  31813. </member>
  31814. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.DumpDrawingGroupRecords(System.Boolean)">
  31815. <summary>
  31816. Spits out a list of all the drawing records in the workbook.
  31817. </summary>
  31818. <param name="fat">if set to <c>true</c> [fat].</param>
  31819. </member>
  31820. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.AddPicture(System.Byte[],NPOI.SS.UserModel.PictureType)">
  31821. <summary>
  31822. Adds a picture to the workbook.
  31823. </summary>
  31824. <param name="pictureData">The bytes of the picture</param>
  31825. <param name="format">The format of the picture. One of
  31826. PictureType.</param>
  31827. <returns>the index to this picture (1 based).</returns>
  31828. </member>
  31829. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetAllPictures">
  31830. <summary>
  31831. Gets all pictures from the Workbook.
  31832. </summary>
  31833. <returns>the list of pictures (a list of HSSFPictureData objects.)</returns>
  31834. </member>
  31835. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SearchForPictures(System.Collections.IList,System.Collections.Generic.List{NPOI.HSSF.UserModel.HSSFPictureData})">
  31836. <summary>
  31837. Performs a recursive search for pictures in the given list of escher records.
  31838. </summary>
  31839. <param name="escherRecords">the escher records.</param>
  31840. <param name="pictures">the list to populate with the pictures.</param>
  31841. </member>
  31842. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.LinkExternalWorkbook(System.String,NPOI.SS.UserModel.IWorkbook)">
  31843. <summary>
  31844. Adds the LinkTable records required to allow formulas referencing
  31845. the specified external workbook to be added to this one. Allows
  31846. formulas such as "[MyOtherWorkbook]Sheet3!$A$5" to be added to the
  31847. file, for workbooks not already referenced.
  31848. </summary>
  31849. <param name="name">The name the workbook will be referenced as in formulas</param>
  31850. <param name="workbook">The open workbook to fetch the link required information from</param>
  31851. <returns></returns>
  31852. </member>
  31853. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.WriteProtectWorkbook(System.String,System.String)">
  31854. <summary>
  31855. protect a workbook with a password (not encypted, just Sets Writeprotect
  31856. flags and the password.
  31857. </summary>
  31858. <param name="password">password to set</param>
  31859. <param name="username">The username.</param>
  31860. </member>
  31861. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.UnwriteProtectWorkbook">
  31862. <summary>
  31863. Removes the Write protect flag
  31864. </summary>
  31865. </member>
  31866. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetAllEmbeddedObjects">
  31867. <summary>
  31868. Gets all embedded OLE2 objects from the Workbook.
  31869. </summary>
  31870. <returns>the list of embedded objects (a list of HSSFObjectData objects.)</returns>
  31871. </member>
  31872. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetAllEmbeddedObjects(NPOI.HSSF.UserModel.HSSFSheet,System.Collections.Generic.List{NPOI.HSSF.UserModel.HSSFObjectData})">
  31873. <summary>
  31874. Gets all embedded OLE2 objects from the Workbook.
  31875. </summary>
  31876. <param name="sheet">the list of records to search.</param>
  31877. <param name="objects">the list of embedded objects to populate.</param>
  31878. </member>
  31879. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetAllEmbeddedObjects(NPOI.HSSF.UserModel.HSSFShapeContainer,System.Collections.Generic.List{NPOI.HSSF.UserModel.HSSFObjectData})">
  31880. <summary>
  31881. Recursively iterates a shape container to get all embedded objects.
  31882. </summary>
  31883. <param name="parent">the parent.</param>
  31884. <param name="objects">the list of embedded objects to populate.</param>
  31885. </member>
  31886. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetEnumerator">
  31887. <summary>
  31888. Support foreach ISheet, e.g.
  31889. HSSFWorkbook workbook = new HSSFWorkbook();
  31890. foreach(ISheet sheet in workbook) ...
  31891. </summary>
  31892. <returns>Enumeration of all the sheets of this workbook</returns>
  31893. </member>
  31894. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ChangeExternalReference(System.String,System.String)">
  31895. Changes an external referenced file to another file.
  31896. A formular in Excel which refers a cell in another file is saved in two parts:
  31897. The referenced file is stored in an reference table. the row/cell information is saved separate.
  31898. This method invokation will only change the reference in the lookup-table itself.
  31899. @param oldUrl The old URL to search for and which is to be replaced
  31900. @param newUrl The URL replacement
  31901. @return true if the oldUrl was found and replaced with newUrl. Otherwise false
  31902. </member>
  31903. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.MissingCellPolicy">
  31904. <summary>
  31905. Retrieves the current policy on what to do when
  31906. getting missing or blank cells from a row.
  31907. The default is to return blank and null cells.
  31908. </summary>
  31909. <value>The missing cell policy.</value>
  31910. </member>
  31911. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.ActiveSheetIndex">
  31912. <summary>
  31913. Gets the tab whose data is actually seen when the sheet is opened.
  31914. This may be different from the "selected sheet" since excel seems to
  31915. allow you to show the data of one sheet when another Is seen "selected"
  31916. in the tabs (at the bottom).
  31917. </summary>
  31918. </member>
  31919. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.FirstVisibleTab">
  31920. <summary>
  31921. Gets or sets the first tab that is displayed in the list of tabs
  31922. in excel.
  31923. </summary>
  31924. </member>
  31925. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NumberOfSheets">
  31926. <summary>
  31927. Get the number of spreadsheets in the workbook (this will be three after serialization)
  31928. </summary>
  31929. <value>The number of sheets.</value>
  31930. </member>
  31931. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.BackupFlag">
  31932. <summary>
  31933. determine whether the Excel GUI will backup the workbook when saving.
  31934. </summary>
  31935. <value>the current Setting for backups.</value>
  31936. </member>
  31937. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NumberOfFonts">
  31938. <summary>
  31939. Get the number of fonts in the font table
  31940. </summary>
  31941. <value>The number of fonts.</value>
  31942. </member>
  31943. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NumCellStyles">
  31944. <summary>
  31945. Get the number of styles the workbook Contains
  31946. </summary>
  31947. <value>count of cell styles</value>
  31948. </member>
  31949. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.Workbook">
  31950. <summary>
  31951. Gets the workbook.
  31952. </summary>
  31953. <value>The workbook.</value>
  31954. </member>
  31955. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NumberOfNames">
  31956. <summary>
  31957. Gets the total number of named ranges in the workboko
  31958. </summary>
  31959. <value>The number of named ranges</value>
  31960. </member>
  31961. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.IsWriteProtected">
  31962. <summary>
  31963. Is the workbook protected with a password (not encrypted)?
  31964. </summary>
  31965. <value>
  31966. <c>true</c> if this instance is write protected; otherwise, <c>false</c>.
  31967. </value>
  31968. </member>
  31969. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NewUID">
  31970. <summary>
  31971. Gets the new UID.
  31972. </summary>
  31973. <value>The new UID.</value>
  31974. </member>
  31975. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.ForceFormulaRecalculation">
  31976. <summary>
  31977. Whether the application shall perform a full recalculation when the workbook is opened.
  31978. Typically you want to force formula recalculation when you modify cell formulas or values
  31979. of a workbook previously created by Excel. When set to true, this flag will tell Excel
  31980. that it needs to recalculate all formulas in the workbook the next time the file is opened.
  31981. Note, that recalculation updates cached formula results and, thus, modifies the workbook.
  31982. Depending on the version, Excel may prompt you with "Do you want to save the changes in <em>filename</em>?"
  31983. on close.
  31984. Value is true if the application will perform a full recalculation of
  31985. workbook values when the workbook is opened.
  31986. since 3.8
  31987. </summary>
  31988. </member>
  31989. <member name="T:NPOI.HSSF.UserModel.HSSFWorkbook.SheetRecordCollector">
  31990. <summary>
  31991. Totals the sizes of all sheet records and eventually serializes them
  31992. </summary>
  31993. </member>
  31994. <member name="T:NPOI.HSSF.UserModel.OperationEvaluatorFactory">
  31995. This class Creates <c>OperationEval</c> instances to help evaluate <c>OperationPtg</c>
  31996. formula tokens.
  31997. @author Josh Micich
  31998. </member>
  31999. <member name="M:NPOI.HSSF.UserModel.OperationEvaluatorFactory.Create(NPOI.SS.Formula.PTG.OperationPtg)">
  32000. returns the OperationEval concrete impl instance corresponding
  32001. to the supplied operationPtg
  32002. </member>
  32003. <member name="T:NPOI.HSSF.UserModel.StaticFontMetrics">
  32004. Allows the user to lookup the font metrics for a particular font without
  32005. actually having the font on the system. The font details are Loaded
  32006. as a resource from the POI jar file (or classpath) and should be contained
  32007. in path "/font_metrics.properties". The font widths are for a 10 point
  32008. version of the font. Use a multiplier for other sizes.
  32009. @author Glen Stampoultzis (glens at apache.org)
  32010. </member>
  32011. <member name="F:NPOI.HSSF.UserModel.StaticFontMetrics.fontMetricsProps">
  32012. The font metrics property file we're using
  32013. </member>
  32014. <member name="F:NPOI.HSSF.UserModel.StaticFontMetrics.fontDetailsMap">
  32015. Our cache of font details we've alReady looked up
  32016. </member>
  32017. <member name="M:NPOI.HSSF.UserModel.StaticFontMetrics.GetFontDetails(System.Drawing.Font)">
  32018. Retrieves the fake font details for a given font.
  32019. @param font the font to lookup.
  32020. @return the fake font.
  32021. </member>
  32022. <member name="F:NPOI.HSSF.Util.GUID._d1">
  32023. 4 bytes - little endian
  32024. </member>
  32025. <member name="F:NPOI.HSSF.Util.GUID._d2">
  32026. 2 bytes - little endian
  32027. </member>
  32028. <member name="F:NPOI.HSSF.Util.GUID._d3">
  32029. 2 bytes - little endian
  32030. </member>
  32031. <member name="F:NPOI.HSSF.Util.GUID._d4">
  32032. 8 bytes - serialized as big endian, stored with inverted endianness here
  32033. </member>
  32034. <member name="M:NPOI.HSSF.Util.GUID.Parse(System.String)">
  32035. Read a GUID in standard text form e.g.<br/>
  32036. 13579BDF-0246-8ACE-0123-456789ABCDEF
  32037. <br/> -&gt; <br/>
  32038. 0x13579BDF, 0x0246, 0x8ACE 0x0123456789ABCDEF
  32039. </member>
  32040. <member name="T:NPOI.HSSF.Util.HSSFCellRangeAddress">
  32041. <p>Title: HSSFCellRangeAddress</p>
  32042. <p>Description:
  32043. Implementation of the cell range Address lists,like Is described in
  32044. OpenOffice.org's Excel Documentation .
  32045. In BIFF8 there Is a common way to store absolute cell range Address
  32046. lists in several records (not formulas). A cell range Address list
  32047. consists of a field with the number of ranges and the list of the range
  32048. Addresses. Each cell range Address (called an AddR structure) Contains
  32049. 4 16-bit-values.</p>
  32050. <p>Copyright: Copyright (c) 2004</p>
  32051. <p>Company: </p>
  32052. @author Dragos Buleandra (dragos.buleandra@trade2b.ro)
  32053. @version 2.0-pre
  32054. </member>
  32055. <member name="F:NPOI.HSSF.Util.HSSFCellRangeAddress.field_Addr_number">
  32056. Number of following AddR structures
  32057. </member>
  32058. <member name="F:NPOI.HSSF.Util.HSSFCellRangeAddress.field_regions_list">
  32059. List of AddR structures. Each structure represents a cell range
  32060. </member>
  32061. <member name="M:NPOI.HSSF.Util.HSSFCellRangeAddress.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  32062. Construct a new HSSFCellRangeAddress object and Sets its fields appropriately .
  32063. Even this Isn't an Excel record , I kept the same behavior for reading/writing
  32064. the object's data as for a regular record .
  32065. @param in the RecordInputstream to read the record from
  32066. </member>
  32067. <member name="M:NPOI.HSSF.Util.HSSFCellRangeAddress.AddAddRStructure(System.Int16,System.Int16,System.Int16,System.Int16)">
  32068. Add an AddR structure .
  32069. @param first_row - the upper left hand corner's row
  32070. @param first_col - the upper left hand corner's col
  32071. @param last_row - the lower right hand corner's row
  32072. @param last_col - the lower right hand corner's col
  32073. @return the index of this AddR structure
  32074. </member>
  32075. <member name="M:NPOI.HSSF.Util.HSSFCellRangeAddress.RemoveAddRStructureAt(System.Int32)">
  32076. Remove the AddR structure stored at the passed in index
  32077. @param index The AddR structure's index
  32078. </member>
  32079. <member name="M:NPOI.HSSF.Util.HSSFCellRangeAddress.GetAddRStructureAt(System.Int32)">
  32080. return the AddR structure at the given index.
  32081. @return AddrStructure representing
  32082. </member>
  32083. <member name="P:NPOI.HSSF.Util.HSSFCellRangeAddress.AddRStructureNumber">
  32084. Get the number of following AddR structures.
  32085. The number of this structures Is automatically Set when reading an Excel file
  32086. and/or increased when you manually Add a new AddR structure .
  32087. This Is the reason there Isn't a Set method for this field .
  32088. @return number of AddR structures
  32089. </member>
  32090. <member name="P:NPOI.HSSF.Util.HSSFCellRangeAddress.AddrStructure.FirstColumn">
  32091. Get the upper left hand corner column number
  32092. @return column number for the upper left hand corner
  32093. </member>
  32094. <member name="P:NPOI.HSSF.Util.HSSFCellRangeAddress.AddrStructure.FirstRow">
  32095. Get the upper left hand corner row number
  32096. @return row number for the upper left hand corner
  32097. </member>
  32098. <member name="P:NPOI.HSSF.Util.HSSFCellRangeAddress.AddrStructure.LastColumn">
  32099. Get the lower right hand corner column number
  32100. @return column number for the lower right hand corner
  32101. </member>
  32102. <member name="P:NPOI.HSSF.Util.HSSFCellRangeAddress.AddrStructure.LastRow">
  32103. Get the lower right hand corner row number
  32104. @return row number for the lower right hand corner
  32105. </member>
  32106. <member name="T:NPOI.HSSF.Util.RangeAddress">
  32107. * Title: Range Address
  32108. * Description: provides connectivity utilities for ranges
  32109. *
  32110. *
  32111. * REFERENCE:
  32112. * @author IgOr KaTz &amp; EuGeNe BuMaGiN (Tal Moshaiov) (VistaPortal LDT.)
  32113. @version 1.0
  32114. </member>
  32115. <member name="M:NPOI.HSSF.Util.RangeAddress.#ctor(System.String)">
  32116. Accepts an external reference from excel.
  32117. i.e. Sheet1!$A$4:$B$9
  32118. @param _url
  32119. </member>
  32120. <member name="P:NPOI.HSSF.Util.RangeAddress.Address">
  32121. @return String <b>note: </b> All absolute references are Removed
  32122. </member>
  32123. <member name="T:NPOI.HSSF.Util.RKUtil">
  32124. Utility class for helping convert RK numbers.
  32125. @author Andrew C. Oliver (acoliver at apache dot org)
  32126. @author Glen Stampoultzis (glens at apache.org)
  32127. @author Rolf-J黵gen Moll
  32128. @see org.apache.poi.hssf.record.MulRKRecord
  32129. @see org.apache.poi.hssf.record.RKRecord
  32130. </member>
  32131. <member name="M:NPOI.HSSF.Util.RKUtil.DecodeNumber(System.Int32)">
  32132. Do the dirty work of decoding; made a private static method to
  32133. facilitate testing the algorithm
  32134. </member>
  32135. <member name="M:NPOI.SS.Formula.Atp.AnalysisToolPak.GetSupportedFunctionNames">
  32136. Returns a collection of ATP function names implemented by POI.
  32137. @return an array of supported functions
  32138. @since 3.8 beta6
  32139. </member>
  32140. <member name="M:NPOI.SS.Formula.Atp.AnalysisToolPak.GetNotSupportedFunctionNames">
  32141. Returns a collection of ATP function names NOT implemented by POI.
  32142. @return an array of not supported functions
  32143. @since 3.8 beta6
  32144. </member>
  32145. <member name="M:NPOI.SS.Formula.Atp.AnalysisToolPak.RegisterFunction(System.String,NPOI.SS.Formula.Functions.FreeRefFunction)">
  32146. Register a ATP function in runtime.
  32147. @param name the function name
  32148. @param func the functoin to register
  32149. @throws ArgumentException if the function is unknown or already registered.
  32150. @since 3.8 beta6
  32151. </member>
  32152. <member name="T:NPOI.SS.Formula.Atp.MRound">
  32153. Implementation of Excel 'Analysis ToolPak' function MROUND()<br/>
  32154. Returns a number rounded to the desired multiple.<p/>
  32155. <b>Syntax</b><br/>
  32156. <b>MROUND</b>(<b>number</b>, <b>multiple</b>)
  32157. <p/>
  32158. @author Yegor Kozlov
  32159. </member>
  32160. <member name="T:NPOI.SS.Formula.Atp.ParityFunction">
  32161. Implementation of Excel 'Analysis ToolPak' function ISEVEN() ISODD()<br/>
  32162. @author Josh Micich
  32163. </member>
  32164. <member name="T:NPOI.SS.Formula.Atp.RandBetween">
  32165. * Implementation of Excel 'Analysis ToolPak' function RANDBETWEEN()<br/>
  32166. *
  32167. * Returns a random integer number between the numbers you specify.<p/>
  32168. *
  32169. * <b>Syntax</b><br/>
  32170. * <b>RANDBETWEEN</b>(<b>bottom</b>, <b>top</b>)<p/>
  32171. *
  32172. * <b>bottom</b> is the smallest integer RANDBETWEEN will return.<br/>
  32173. * <b>top</b> is the largest integer RANDBETWEEN will return.<br/>
  32174. * @author Brendan Nolan
  32175. </member>
  32176. <member name="M:NPOI.SS.Formula.Atp.RandBetween.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  32177. Evaluate for RANDBETWEEN(). Must be given two arguments. Bottom must be greater than top.
  32178. Bottom is rounded up and top value is rounded down. After rounding top has to be set greater
  32179. than top.
  32180. @see org.apache.poi.ss.formula.functions.FreeRefFunction#evaluate(org.apache.poi.ss.formula.eval.ValueEval[], org.apache.poi.ss.formula.OperationEvaluationContext)
  32181. </member>
  32182. <member name="T:NPOI.SS.Formula.Atp.YearFrac">
  32183. Implementation of Excel 'Analysis ToolPak' function YEARFRAC()<br/>
  32184. Returns the fraction of the year spanned by two dates.<p/>
  32185. <b>Syntax</b><br/>
  32186. <b>YEARFRAC</b>(<b>startDate</b>, <b>endDate</b>, basis)<p/>
  32187. The <b>basis</b> optionally specifies the behaviour of YEARFRAC as follows:
  32188. <table border="0" cellpadding="1" cellspacing="0" summary="basis parameter description">
  32189. <tr><th>Value</th><th>Days per Month</th><th>Days per Year</th></tr>
  32190. <tr align='center'><td>0 (default)</td><td>30</td><td>360</td></tr>
  32191. <tr align='center'><td>1</td><td>actual</td><td>actual</td></tr>
  32192. <tr align='center'><td>2</td><td>actual</td><td>360</td></tr>
  32193. <tr align='center'><td>3</td><td>actual</td><td>365</td></tr>
  32194. <tr align='center'><td>4</td><td>30</td><td>360</td></tr>
  32195. </table>
  32196. </member>
  32197. <member name="T:NPOI.SS.Formula.Atp.YearFracCalculator">
  32198. <summary>
  32199. Internal calculation methods for Excel 'Analysis ToolPak' function YEARFRAC()
  32200. Algorithm inspired by www.dwheeler.com/yearfrac
  32201. @author Josh Micich
  32202. </summary>
  32203. <remarks>
  32204. Date Count convention
  32205. http://en.wikipedia.org/wiki/Day_count_convention
  32206. </remarks>
  32207. <remarks>
  32208. Office Online Help on YEARFRAC
  32209. http://office.microsoft.com/en-us/excel/HP052093441033.aspx
  32210. </remarks>
  32211. </member>
  32212. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.MS_PER_HOUR">
  32213. use UTC time-zone to avoid daylight savings issues
  32214. </member>
  32215. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.LONG_MONTH_LEN">
  32216. the length of normal long months i.e. 31
  32217. </member>
  32218. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.SHORT_MONTH_LEN">
  32219. the length of normal short months i.e. 30
  32220. </member>
  32221. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Calculate(System.Double,System.Double,System.Int32)">
  32222. <summary>
  32223. Calculates YEARFRAC()
  32224. </summary>
  32225. <param name="pStartDateVal">The start date.</param>
  32226. <param name="pEndDateVal">The end date.</param>
  32227. <param name="basis">The basis value.</param>
  32228. <returns></returns>
  32229. </member>
  32230. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis0(System.Int32,System.Int32)">
  32231. <summary>
  32232. Basis 0, 30/360 date convention
  32233. </summary>
  32234. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  32235. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  32236. <returns></returns>
  32237. </member>
  32238. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis1(System.Int32,System.Int32)">
  32239. <summary>
  32240. Basis 1, Actual/Actual date convention
  32241. </summary>
  32242. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  32243. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  32244. <returns></returns>
  32245. </member>
  32246. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis2(System.Int32,System.Int32)">
  32247. <summary>
  32248. Basis 2, Actual/360 date convention
  32249. </summary>
  32250. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  32251. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  32252. <returns></returns>
  32253. </member>
  32254. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis3(System.Double,System.Double)">
  32255. <summary>
  32256. Basis 3, Actual/365 date convention
  32257. </summary>
  32258. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  32259. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  32260. <returns></returns>
  32261. </member>
  32262. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis4(System.Int32,System.Int32)">
  32263. <summary>
  32264. Basis 4, European 30/360 date convention
  32265. </summary>
  32266. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  32267. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  32268. <returns></returns>
  32269. </member>
  32270. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.CalculateAdjusted(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate,NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate,System.Int32,System.Int32)">
  32271. <summary>
  32272. Calculates the adjusted.
  32273. </summary>
  32274. <param name="startDate">The start date.</param>
  32275. <param name="endDate">The end date.</param>
  32276. <param name="date1day">The date1day.</param>
  32277. <param name="date2day">The date2day.</param>
  32278. <returns></returns>
  32279. </member>
  32280. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.IsLastDayOfMonth(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate)">
  32281. <summary>
  32282. Determines whether [is last day of month] [the specified date].
  32283. </summary>
  32284. <param name="date">The date.</param>
  32285. <returns>
  32286. <c>true</c> if [is last day of month] [the specified date]; otherwise, <c>false</c>.
  32287. </returns>
  32288. </member>
  32289. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.GetLastDayOfMonth(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate)">
  32290. <summary>
  32291. Gets the last day of month.
  32292. </summary>
  32293. <param name="date">The date.</param>
  32294. <returns></returns>
  32295. </member>
  32296. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.ShouldCountFeb29(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate,NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate)">
  32297. <summary>
  32298. Assumes dates are no more than 1 year apart.
  32299. </summary>
  32300. <param name="start">The start.</param>
  32301. <param name="end">The end.</param>
  32302. <returns><c>true</c>
  32303. if dates both within a leap year, or span a period including Feb 29</returns>
  32304. </member>
  32305. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.DateDiff(System.Int64,System.Int64)">
  32306. <summary>
  32307. return the whole number of days between the two time-stamps. Both time-stamps are
  32308. assumed to represent 12:00 midnight on the respective day.
  32309. </summary>
  32310. <param name="startDateTicks">The start date ticks.</param>
  32311. <param name="endDateTicks">The end date ticks.</param>
  32312. <returns></returns>
  32313. </member>
  32314. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.AverageYearLength(System.Int32,System.Int32)">
  32315. <summary>
  32316. Averages the length of the year.
  32317. </summary>
  32318. <param name="startYear">The start year.</param>
  32319. <param name="endYear">The end year.</param>
  32320. <returns></returns>
  32321. </member>
  32322. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.IsLeapYear(System.Int32)">
  32323. <summary>
  32324. determine Leap Year
  32325. </summary>
  32326. <param name="i">the year</param>
  32327. <returns></returns>
  32328. </member>
  32329. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.IsGreaterThanOneYear(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate,NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate)">
  32330. <summary>
  32331. Determines whether [is greater than one year] [the specified start].
  32332. </summary>
  32333. <param name="start">The start date.</param>
  32334. <param name="end">The end date.</param>
  32335. <returns>
  32336. <c>true</c> if [is greater than one year] [the specified start]; otherwise, <c>false</c>.
  32337. </returns>
  32338. </member>
  32339. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.CreateDate(System.Int32)">
  32340. <summary>
  32341. Creates the date.
  32342. </summary>
  32343. <param name="dayCount">The day count.</param>
  32344. <returns></returns>
  32345. </member>
  32346. <member name="T:NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate">
  32347. <summary>
  32348. Simple Date Wrapper
  32349. </summary>
  32350. </member>
  32351. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate.month">
  32352. 1-based month
  32353. </member>
  32354. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate.day">
  32355. day of month
  32356. </member>
  32357. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate.ticks">
  32358. milliseconds since 1970
  32359. </member>
  32360. <member name="T:NPOI.SS.Formula.CellCacheEntry">
  32361. Stores the parameters that identify the evaluation of one cell.<br/>
  32362. </member>
  32363. <member name="T:NPOI.SS.Formula.ICacheEntry">
  32364. A (mostly) opaque interface To allow test clients To trace cache values
  32365. Each spreadsheet cell Gets one unique cache entry instance. These objects
  32366. are safe To use as keys in {@link java.util.HashMap}s
  32367. </member>
  32368. <member name="M:NPOI.SS.Formula.CellCacheEntry.RecurseClearCachedFormulaResults">
  32369. Calls formulaCell.SetFormulaResult(null, null) recursively all the way up the tree of
  32370. dependencies. Calls usedCell.ClearConsumingCell(fc) for each child of a cell that Is
  32371. Cleared along the way.
  32372. @param formulaCells
  32373. </member>
  32374. <member name="M:NPOI.SS.Formula.CellCacheEntry.RecurseClearCachedFormulaResults(NPOI.SS.Formula.IEvaluationListener,System.Int32)">
  32375. Identical To {@link #RecurseClearCachedFormulaResults()} except for the listener call-backs
  32376. </member>
  32377. <member name="T:NPOI.SS.Formula.CellEvaluationFrame">
  32378. Stores details about the current evaluation of a cell.<br/>
  32379. </member>
  32380. <member name="M:NPOI.SS.Formula.CellEvaluationFrame.AddSensitiveInputCell(NPOI.SS.Formula.CellCacheEntry)">
  32381. @param inputCell a cell directly used by the formula of this evaluation frame
  32382. </member>
  32383. <member name="M:NPOI.SS.Formula.CellEvaluationFrame.GetSensitiveInputCells">
  32384. @return never <c>null</c>, (possibly empty) array of all cells directly used while
  32385. evaluating the formula of this frame.
  32386. </member>
  32387. <member name="T:NPOI.SS.Formula.CollaboratingWorkbooksEnvironment">
  32388. Manages a collection of {@link WorkbookEvaluator}s, in order To support evaluation of formulas
  32389. across spreadsheets.<p/>
  32390. For POI internal use only
  32391. @author Josh Micich
  32392. </member>
  32393. <member name="M:NPOI.SS.Formula.CollaboratingWorkbooksEnvironment.Unhook">
  32394. </member>
  32395. <member name="T:NPOI.SS.Formula.EvaluationCache">
  32396. Performance optimisation for {@link HSSFFormulaEvaluator}. This class stores previously
  32397. calculated values of already visited cells, To avoid unnecessary re-calculation when the
  32398. same cells are referenced multiple times
  32399. @author Josh Micich
  32400. </member>
  32401. <member name="F:NPOI.SS.Formula.EvaluationCache._evaluationListener">
  32402. only used for testing. <c>null</c> otherwise
  32403. </member>
  32404. <member name="M:NPOI.SS.Formula.EvaluationCache.Clear">
  32405. Should be called whenever there are Changes To input cells in the evaluated workbook.
  32406. </member>
  32407. <member name="T:NPOI.SS.Formula.EvaluationTracker">
  32408. <summary>
  32409. Instances of this class keep track of multiple dependent cell evaluations due
  32410. To recursive calls To <see cref="M:NPOI.SS.Formula.WorkbookEvaluator.Evaluate(NPOI.SS.Formula.IEvaluationCell)"/>
  32411. The main purpose of this class is To detect an attempt To evaluate a cell
  32412. that is already being evaluated. In other words, it detects circular
  32413. references in spreadsheet formulas.
  32414. </summary>
  32415. <remarks>
  32416. @author Josh Micich
  32417. </remarks>
  32418. </member>
  32419. <member name="M:NPOI.SS.Formula.EvaluationTracker.StartEvaluate(NPOI.SS.Formula.FormulaCellCacheEntry)">
  32420. Notifies this evaluation tracker that evaluation of the specified cell Is
  32421. about To start.<br/>
  32422. In the case of a <c>true</c> return code, the caller should
  32423. continue evaluation of the specified cell, and also be sure To call
  32424. <c>endEvaluate()</c> when complete.<br/>
  32425. In the case of a <c>null</c> return code, the caller should
  32426. return an evaluation result of
  32427. <c>ErrorEval.CIRCULAR_REF_ERROR</c>, and not call <c>endEvaluate()</c>.
  32428. <br/>
  32429. @return <c>false</c> if the specified cell is already being evaluated
  32430. </member>
  32431. <member name="M:NPOI.SS.Formula.EvaluationTracker.EndEvaluate(NPOI.SS.Formula.CellCacheEntry)">
  32432. Notifies this evaluation tracker that the evaluation of the specified cell is complete. <p/>
  32433. Every successful call To <c>startEvaluate</c> must be followed by a call To <c>endEvaluate</c> (recommended in a finally block) To enable
  32434. proper tracking of which cells are being evaluated at any point in time.<p/>
  32435. Assuming a well behaved client, parameters To this method would not be
  32436. required. However, they have been included To assert correct behaviour,
  32437. and form more meaningful error messages.
  32438. </member>
  32439. <member name="T:NPOI.SS.Formula.Eval.AreaEval">
  32440. Evaluation of 2D (Row+Column) and 3D (Sheet+Row+Column) areas
  32441. </member>
  32442. <member name="M:NPOI.SS.Formula.Eval.AreaEval.Contains(System.Int32,System.Int32)">
  32443. returns true if the cell at row and col specified
  32444. as absolute indexes in the sheet is contained in
  32445. this area.
  32446. @param row
  32447. @param col
  32448. </member>
  32449. <member name="M:NPOI.SS.Formula.Eval.AreaEval.ContainsColumn(System.Int32)">
  32450. returns true if the specified col is in range
  32451. @param col
  32452. </member>
  32453. <member name="M:NPOI.SS.Formula.Eval.AreaEval.ContainsRow(System.Int32)">
  32454. returns true if the specified row is in range
  32455. @param row
  32456. </member>
  32457. <member name="M:NPOI.SS.Formula.Eval.AreaEval.GetAbsoluteValue(System.Int32,System.Int32)">
  32458. @return the ValueEval from within this area at the specified row and col index. Never
  32459. <code>null</code> (possibly {@link BlankEval}). The specified indexes should be absolute
  32460. indexes in the sheet and not relative indexes within the area.
  32461. </member>
  32462. <member name="M:NPOI.SS.Formula.Eval.AreaEval.GetRelativeValue(System.Int32,System.Int32)">
  32463. @return the ValueEval from within this area at the specified relativeRowIndex and
  32464. relativeColumnIndex. Never <c>null</c> (possibly {@link BlankEval}). The
  32465. specified indexes should relative to the top left corner of this area.
  32466. </member>
  32467. <member name="M:NPOI.SS.Formula.Eval.AreaEval.Offset(System.Int32,System.Int32,System.Int32,System.Int32)">
  32468. Creates an {@link AreaEval} offset by a relative amount from from the upper left cell
  32469. of this area
  32470. </member>
  32471. <member name="P:NPOI.SS.Formula.Eval.AreaEval.FirstRow">
  32472. returns the 0-based index of the first row in
  32473. this area.
  32474. </member>
  32475. <member name="P:NPOI.SS.Formula.Eval.AreaEval.LastRow">
  32476. returns the 0-based index of the last row in
  32477. this area.
  32478. </member>
  32479. <member name="P:NPOI.SS.Formula.Eval.AreaEval.FirstColumn">
  32480. returns the 0-based index of the first col in
  32481. this area.
  32482. </member>
  32483. <member name="P:NPOI.SS.Formula.Eval.AreaEval.LastColumn">
  32484. returns the 0-based index of the last col in
  32485. this area.
  32486. </member>
  32487. <member name="T:NPOI.SS.Formula.Eval.AreaEvalBase">
  32488. @author Josh Micich
  32489. </member>
  32490. <member name="M:NPOI.SS.Formula.Eval.AreaEvalBase.IsSubTotal(System.Int32,System.Int32)">
  32491. @return whether cell at rowIndex and columnIndex is a subtotal.
  32492. By default return false which means 'don't care about subtotals'
  32493. </member>
  32494. <member name="T:NPOI.SS.Formula.Eval.BlankEval">
  32495. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt; This class is a
  32496. marker class. It is a special value for empty cells.
  32497. </member>
  32498. <member name="T:NPOI.SS.Formula.Eval.BoolEval">
  32499. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32500. </member>
  32501. <member name="T:NPOI.SS.Formula.Eval.NumericValueEval">
  32502. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32503. </member>
  32504. <member name="T:NPOI.SS.Formula.Eval.StringValueEval">
  32505. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32506. </member>
  32507. <member name="P:NPOI.SS.Formula.Eval.StringValueEval.StringValue">
  32508. @return never <code>null</code>, possibly empty string.
  32509. </member>
  32510. <member name="M:NPOI.SS.Formula.Eval.BoolEval.ValueOf(System.Boolean)">
  32511. Convenience method for the following:<br/>
  32512. <c>(b ? BoolEval.TRUE : BoolEval.FALSE)</c>
  32513. @return a <c>BoolEval</c> instance representing <c>b</c>.
  32514. </member>
  32515. <member name="T:NPOI.SS.Formula.Eval.ConcatEval">
  32516. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32517. </member>
  32518. <member name="T:NPOI.SS.Formula.Eval.ErrorEval">
  32519. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32520. </member>
  32521. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.NULL_INTERSECTION">
  32522. <b>#NULL!</b> - Intersection of two cell ranges is empty
  32523. </member>
  32524. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.DIV_ZERO">
  32525. <b>#DIV/0!</b> - Division by zero
  32526. </member>
  32527. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.VALUE_INVALID">
  32528. <b>#VALUE!</b> - Wrong type of operand
  32529. </member>
  32530. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.REF_INVALID">
  32531. <b>#REF!</b> - Illegal or deleted cell reference
  32532. </member>
  32533. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.NAME_INVALID">
  32534. <b>#NAME?</b> - Wrong function or range name
  32535. </member>
  32536. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.NUM_ERROR">
  32537. <b>#NUM!</b> - Value range overflow
  32538. </member>
  32539. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.NA">
  32540. <b>#N/A</b> - Argument or function not available
  32541. </member>
  32542. <member name="M:NPOI.SS.Formula.Eval.ErrorEval.ValueOf(System.Int32)">
  32543. Translates an Excel internal error code into the corresponding POI ErrorEval instance
  32544. @param errorCode
  32545. </member>
  32546. <member name="M:NPOI.SS.Formula.Eval.ErrorEval.GetText(System.Int32)">
  32547. Converts error codes to text. Handles non-standard error codes OK.
  32548. For debug/test purposes (and for formatting error messages).
  32549. @return the String representation of the specified Excel error code.
  32550. </member>
  32551. <member name="T:NPOI.SS.Formula.Eval.Eval">
  32552. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32553. </member>
  32554. <member name="T:NPOI.SS.Formula.Eval.EvaluationException">
  32555. This class is used to simplify error handling logic <i>within</i> operator and function
  32556. implementations. Note - <c>OperationEval.Evaluate()</c> and <c>Function.Evaluate()</c>
  32557. method signatures do not throw this exception so it cannot propagate outside.<p/>
  32558. Here is an example coded without <c>EvaluationException</c>, to show how it can help:
  32559. <pre>
  32560. public Eval Evaluate(Eval[] args, int srcRow, short srcCol) {
  32561. // ...
  32562. Eval arg0 = args[0];
  32563. if(arg0 is ErrorEval) {
  32564. return arg0;
  32565. }
  32566. if(!(arg0 is AreaEval)) {
  32567. return ErrorEval.VALUE_INVALID;
  32568. }
  32569. double temp = 0;
  32570. AreaEval area = (AreaEval)arg0;
  32571. ValueEval[] values = area.LittleEndianConstants.BYTE_SIZE;
  32572. for (int i = 0; i &lt; values.Length; i++) {
  32573. ValueEval ve = values[i];
  32574. if(ve is ErrorEval) {
  32575. return ve;
  32576. }
  32577. if(!(ve is NumericValueEval)) {
  32578. return ErrorEval.VALUE_INVALID;
  32579. }
  32580. temp += ((NumericValueEval)ve).NumberValue;
  32581. }
  32582. // ...
  32583. }
  32584. </pre>
  32585. In this example, if any error is encountered while Processing the arguments, an error is
  32586. returned immediately. This code is difficult to refactor due to all the points where errors
  32587. are returned.<br/>
  32588. Using <c>EvaluationException</c> allows the error returning code to be consolidated to one
  32589. place.<p/>
  32590. <pre>
  32591. public Eval Evaluate(Eval[] args, int srcRow, short srcCol) {
  32592. try {
  32593. // ...
  32594. AreaEval area = GetAreaArg(args[0]);
  32595. double temp = sumValues(area.LittleEndianConstants.BYTE_SIZE);
  32596. // ...
  32597. } catch (EvaluationException e) {
  32598. return e.GetErrorEval();
  32599. }
  32600. }
  32601. private static AreaEval GetAreaArg(Eval arg0){
  32602. if (arg0 is ErrorEval) {
  32603. throw new EvaluationException((ErrorEval) arg0);
  32604. }
  32605. if (arg0 is AreaEval) {
  32606. return (AreaEval) arg0;
  32607. }
  32608. throw EvaluationException.InvalidValue();
  32609. }
  32610. private double sumValues(ValueEval[] values){
  32611. double temp = 0;
  32612. for (int i = 0; i &lt; values.Length; i++) {
  32613. ValueEval ve = values[i];
  32614. if (ve is ErrorEval) {
  32615. throw new EvaluationException((ErrorEval) ve);
  32616. }
  32617. if (!(ve is NumericValueEval)) {
  32618. throw EvaluationException.InvalidValue();
  32619. }
  32620. temp += ((NumericValueEval) ve).NumberValue;
  32621. }
  32622. return temp;
  32623. }
  32624. </pre>
  32625. It is not mandatory to use EvaluationException, doing so might give the following advantages:<br/>
  32626. - Methods can more easily be extracted, allowing for re-use.<br/>
  32627. - Type management (typecasting etc) is simpler because error conditions have been Separated from
  32628. intermediate calculation values.<br/>
  32629. - Fewer local variables are required. Local variables can have stronger types.<br/>
  32630. - It is easier to mimic common Excel error handling behaviour (exit upon encountering first
  32631. error), because exceptions conveniently propagate up the call stack regardless of execution
  32632. points or the number of levels of nested calls.<p/>
  32633. <b>Note</b> - Only standard evaluation errors are represented by <c>EvaluationException</c> (
  32634. i.e. conditions expected to be encountered when evaluating arbitrary Excel formulas). Conditions
  32635. that could never occur in an Excel spReadsheet should result in runtime exceptions. Care should
  32636. be taken to not translate any POI internal error into an Excel evaluation error code.
  32637. @author Josh Micich
  32638. </member>
  32639. <member name="M:NPOI.SS.Formula.Eval.EvaluationException.InvalidValue">
  32640. <b>#VALUE!</b> - Wrong type of operand
  32641. </member>
  32642. <member name="M:NPOI.SS.Formula.Eval.EvaluationException.InvalidRef">
  32643. <b>#REF!</b> - Illegal or deleted cell reference
  32644. </member>
  32645. <member name="M:NPOI.SS.Formula.Eval.EvaluationException.NumberError">
  32646. <b>#NUM!</b> - Value range overflow
  32647. </member>
  32648. <member name="T:NPOI.SS.Formula.Eval.FunctionEval">
  32649. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32650. </member>
  32651. <member name="M:NPOI.SS.Formula.Eval.FunctionEval.RegisterFunction(System.String,NPOI.SS.Formula.Functions.Function)">
  32652. Register a new function in runtime.
  32653. @param name the function name
  32654. @param func the functoin to register
  32655. @throws ArgumentException if the function is unknown or already registered.
  32656. @since 3.8 beta6
  32657. </member>
  32658. <member name="M:NPOI.SS.Formula.Eval.FunctionEval.GetSupportedFunctionNames">
  32659. Returns a collection of function names implemented by POI.
  32660. @return an array of supported functions
  32661. @since 3.8 beta6
  32662. </member>
  32663. <member name="M:NPOI.SS.Formula.Eval.FunctionEval.GetNotSupportedFunctionNames">
  32664. Returns an array of function names NOT implemented by POI.
  32665. @return an array of not supported functions
  32666. @since 3.8 beta6
  32667. </member>
  32668. <member name="T:NPOI.SS.Formula.Eval.FunctionEval.FunctionID">
  32669. Some function IDs that require special treatment
  32670. </member>
  32671. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.IF">
  32672. 1
  32673. </member>
  32674. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.OFFSET">
  32675. 78
  32676. </member>
  32677. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.CHOOSE">
  32678. 100
  32679. </member>
  32680. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.INDIRECT">
  32681. 148
  32682. </member>
  32683. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.EXTERNAL_FUNC">
  32684. 255
  32685. </member>
  32686. <member name="T:NPOI.SS.Formula.Eval.IntersectionEval">
  32687. @author Josh Micich
  32688. </member>
  32689. <member name="M:NPOI.SS.Formula.Eval.IntersectionEval.ResolveRange(NPOI.SS.Formula.Eval.AreaEval,NPOI.SS.Formula.Eval.AreaEval)">
  32690. @return simple rectangular {@link AreaEval} which represents the intersection of areas
  32691. <c>aeA</c> and <c>aeB</c>. If the two areas do not intersect, the result is <code>null</code>.
  32692. </member>
  32693. <member name="T:NPOI.SS.Formula.Eval.FunctionNameEval">
  32694. @author Josh Micich
  32695. </member>
  32696. <member name="M:NPOI.SS.Formula.Eval.FunctionNameEval.#ctor(System.String)">
  32697. Creates a NameEval representing a function name
  32698. </member>
  32699. <member name="T:NPOI.SS.Formula.Eval.ExternalNameEval">
  32700. Evaluation of a Name defined in a Sheet or Workbook scope
  32701. </member>
  32702. <member name="T:NPOI.SS.Formula.Eval.NumberEval">
  32703. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32704. </member>
  32705. <member name="T:NPOI.SS.Formula.Eval.OperandResolver">
  32706. Provides functionality for evaluating arguments to functions and operators.
  32707. @author Josh Micich
  32708. </member>
  32709. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.GetSingleValue(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  32710. Retrieves a single value from a variety of different argument types according to standard
  32711. Excel rules. Does not perform any type conversion.
  32712. @param arg the Evaluated argument as passed to the function or operator.
  32713. @param srcCellRow used when arg is a single column AreaRef
  32714. @param srcCellCol used when arg is a single row AreaRef
  32715. @return a <c>NumberEval</c>, <c>StringEval</c>, <c>BoolEval</c> or <c>BlankEval</c>.
  32716. Never <c>null</c> or <c>ErrorEval</c>.
  32717. @throws EvaluationException(#VALUE!) if srcCellRow or srcCellCol do not properly index into
  32718. an AreaEval. If the actual value retrieved is an ErrorEval, a corresponding
  32719. EvaluationException is thrown.
  32720. </member>
  32721. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.ChooseSingleElementFromArea(NPOI.SS.Formula.Eval.AreaEval,System.Int32,System.Int32)">
  32722. Implements (some perhaps not well known) Excel functionality to select a single cell from an
  32723. area depending on the coordinates of the calling cell. Here is an example demonstrating
  32724. both selection from a single row area and a single column area in the same formula.
  32725. <table border="1" cellpAdding="1" cellspacing="1" summary="sample spReadsheet">
  32726. <tr><th> </th><th> A </th><th> B </th><th> C </th><th> D </th></tr>
  32727. <tr><th>1</th><td>15</td><td>20</td><td>25</td><td> </td></tr>
  32728. <tr><th>2</th><td> </td><td> </td><td> </td><td>200</td></tr>
  32729. <tr><th>3</th><td> </td><td> </td><td> </td><td>300</td></tr>
  32730. <tr><th>3</th><td> </td><td> </td><td> </td><td>400</td></tr>
  32731. </table>
  32732. If the formula "=1000+A1:B1+D2:D3" is put into the 9 cells from A2 to C4, the spReadsheet
  32733. will look like this:
  32734. <table border="1" cellpAdding="1" cellspacing="1" summary="sample spReadsheet">
  32735. <tr><th> </th><th> A </th><th> B </th><th> C </th><th> D </th></tr>
  32736. <tr><th>1</th><td>15</td><td>20</td><td>25</td><td> </td></tr>
  32737. <tr><th>2</th><td>1215</td><td>1220</td><td>#VALUE!</td><td>200</td></tr>
  32738. <tr><th>3</th><td>1315</td><td>1320</td><td>#VALUE!</td><td>300</td></tr>
  32739. <tr><th>4</th><td>#VALUE!</td><td>#VALUE!</td><td>#VALUE!</td><td>400</td></tr>
  32740. </table>
  32741. Note that the row area (A1:B1) does not include column C and the column area (D2:D3) does
  32742. not include row 4, so the values in C1(=25) and D4(=400) are not accessible to the formula
  32743. as written, but in the 4 cells A2:B3, the row and column selection works ok.<p/>
  32744. The same concept is extended to references across sheets, such that even multi-row,
  32745. multi-column areas can be useful.<p/>
  32746. Of course with carefully (or carelessly) chosen parameters, cyclic references can occur and
  32747. hence this method <b>can</b> throw a 'circular reference' EvaluationException. Note that
  32748. this method does not attempt to detect cycles. Every cell in the specified Area <c>ae</c>
  32749. has already been Evaluated prior to this method call. Any cell (or cell<b>s</b>) part of
  32750. <c>ae</c> that would incur a cyclic reference error if selected by this method, will
  32751. already have the value <c>ErrorEval.CIRCULAR_REF_ERROR</c> upon entry to this method. It
  32752. is assumed logic exists elsewhere to produce this behaviour.
  32753. @return whatever the selected cell's Evaluated value Is. Never <c>null</c>. Never
  32754. <c>ErrorEval</c>.
  32755. @if there is a problem with indexing into the area, or if the
  32756. Evaluated cell has an error.
  32757. </member>
  32758. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.ChooseSingleElementFromAreaInternal(NPOI.SS.Formula.Eval.AreaEval,System.Int32,System.Int32)">
  32759. @return possibly <c>ErrorEval</c>, and <c>null</c>
  32760. </member>
  32761. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.CoerceValueToInt(NPOI.SS.Formula.Eval.ValueEval)">
  32762. Applies some conversion rules if the supplied value is not already an integer.<br/>
  32763. Value is first Coerced to a <c>double</c> ( See <c>CoerceValueTodouble()</c> ).<p/>
  32764. Excel typically Converts doubles to integers by truncating toward negative infinity.<br/>
  32765. The equivalent java code Is:<br/>
  32766. <c>return (int)Math.floor(d);</c><br/>
  32767. <b>not</b>:<br/>
  32768. <c>return (int)d; // wrong - rounds toward zero</c>
  32769. </member>
  32770. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.CoerceValueToDouble(NPOI.SS.Formula.Eval.ValueEval)">
  32771. Applies some conversion rules if the supplied value is not already a number.
  32772. Note - <c>BlankEval</c> is not supported and must be handled by the caller.
  32773. @param ev must be a <c>NumberEval</c>, <c>StringEval</c> or <c>BoolEval</c>
  32774. @return actual, Parsed or interpreted double value (respectively).
  32775. @throws EvaluationException(#VALUE!) only if a StringEval is supplied and cannot be Parsed
  32776. as a double (See <c>Parsedouble()</c> for allowable formats).
  32777. @throws Exception if the supplied parameter is not <c>NumberEval</c>,
  32778. <c>StringEval</c> or <c>BoolEval</c>
  32779. </member>
  32780. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.ParseDouble(System.String)">
  32781. Converts a string to a double using standard rules that Excel would use.<br/>
  32782. Tolerates currency prefixes, commas, leading and trailing spaces.<p/>
  32783. Some examples:<br/>
  32784. " 123 " -&gt; 123.0<br/>
  32785. ".123" -&gt; 0.123<br/>
  32786. These not supported yet:<br/>
  32787. " $ 1,000.00 " -&gt; 1000.0<br/>
  32788. "$1.25E4" -&gt; 12500.0<br/>
  32789. "5**2" -&gt; 500<br/>
  32790. "250%" -&gt; 2.5<br/>
  32791. @param text
  32792. @return <c>null</c> if the specified text cannot be Parsed as a number
  32793. </member>
  32794. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.CoerceValueToString(NPOI.SS.Formula.Eval.ValueEval)">
  32795. @param ve must be a <c>NumberEval</c>, <c>StringEval</c>, <c>BoolEval</c>, or <c>BlankEval</c>
  32796. @return the Converted string value. never <c>null</c>
  32797. </member>
  32798. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.CoerceValueToBoolean(NPOI.SS.Formula.Eval.ValueEval,System.Boolean)">
  32799. @return <c>null</c> to represent blank values
  32800. @throws EvaluationException if ve is an ErrorEval, or if a string value cannot be converted
  32801. </member>
  32802. <member name="T:NPOI.SS.Formula.Eval.OperationEval">
  32803. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32804. </member>
  32805. <member name="T:NPOI.SS.Formula.Eval.PercentEval">
  32806. Implementation of Excel formula token '%'. <p/>
  32807. @author Josh Micich
  32808. </member>
  32809. <member name="T:NPOI.SS.Formula.Eval.RangeEval">
  32810. @author Josh Micich
  32811. </member>
  32812. <member name="T:NPOI.SS.Formula.Eval.RefEval">
  32813. @author Amol S Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32814. RefEval is the base interface for Ref2D and Ref3DEval. Basically a RefEval
  32815. impl should contain reference to the original ReferencePtg or Ref3DPtg as
  32816. well as the "value" resulting from the evaluation of the cell
  32817. reference. Thus if the HSSFCell has type CELL_TYPE_NUMERIC, the contained
  32818. value object should be of type NumberEval; if cell type is CELL_TYPE_STRING,
  32819. contained value object should be of type StringEval
  32820. </member>
  32821. <member name="M:NPOI.SS.Formula.Eval.RefEval.GetInnerValueEval(System.Int32)">
  32822. The (possibly Evaluated) ValueEval contained
  32823. in this RefEval. eg. if cell A1 Contains "test"
  32824. then in a formula referring to cell A1
  32825. the RefEval representing
  32826. A1 will return as the InnerValueEval the
  32827. object of concrete type StringEval
  32828. </member>
  32829. <member name="M:NPOI.SS.Formula.Eval.RefEval.Offset(System.Int32,System.Int32,System.Int32,System.Int32)">
  32830. Creates an {@link AreaEval} offset by a relative amount from this RefEval
  32831. </member>
  32832. <member name="P:NPOI.SS.Formula.Eval.RefEval.Column">
  32833. returns the zero based column index.
  32834. </member>
  32835. <member name="P:NPOI.SS.Formula.Eval.RefEval.Row">
  32836. returns the zero based row index.
  32837. </member>
  32838. <member name="P:NPOI.SS.Formula.Eval.RefEval.FirstSheetIndex">
  32839. returns the first sheet index this applies to
  32840. </member>
  32841. <member name="P:NPOI.SS.Formula.Eval.RefEval.LastSheetIndex">
  32842. returns the last sheet index this applies to, which
  32843. will be the same as the first for a 2D and many 3D references
  32844. </member>
  32845. <member name="P:NPOI.SS.Formula.Eval.RefEval.NumberOfSheets">
  32846. returns the number of sheets this applies to
  32847. </member>
  32848. <member name="T:NPOI.SS.Formula.Eval.EqualEval">
  32849. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32850. </member>
  32851. <member name="T:NPOI.SS.Formula.Eval.RelationalOperationEval">
  32852. @author Amol S. Deshmukh &lt; amolweb at ya hoo Dot com &gt;
  32853. </member>
  32854. <member name="T:NPOI.SS.Formula.Eval.GreaterEqualEval">
  32855. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32856. </member>
  32857. <member name="T:NPOI.SS.Formula.Eval.GreaterThanEval">
  32858. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32859. </member>
  32860. <member name="T:NPOI.SS.Formula.Eval.LessEqualEval">
  32861. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32862. </member>
  32863. <member name="T:NPOI.SS.Formula.Eval.LessThanEval">
  32864. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32865. </member>
  32866. <member name="T:NPOI.SS.Formula.Eval.NotEqualEval">
  32867. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32868. </member>
  32869. <member name="T:NPOI.SS.Formula.Eval.StringEval">
  32870. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32871. </member>
  32872. <member name="T:NPOI.SS.Formula.Eval.AddEval">
  32873. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32874. This is a documentation of the observed behaviour of
  32875. the '+' operator in Excel:
  32876. - 1+TRUE = 2
  32877. - 1+FALSE = 1
  32878. - 1+"true" = #VALUE!
  32879. - 1+"1" = 2
  32880. - 1+A1 = #VALUE if A1 Contains "1"
  32881. - 1+A1 = 2 if A1 Contains ="1"
  32882. - 1+A1 = 2 if A1 Contains TRUE or =TRUE
  32883. - 1+A1 = #VALUE! if A1 Contains "TRUE" or ="TRUE"
  32884. </member>
  32885. <member name="T:NPOI.SS.Formula.Eval.DivideEval">
  32886. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32887. </member>
  32888. <member name="T:NPOI.SS.Formula.Eval.MultiplyEval">
  32889. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32890. </member>
  32891. <member name="T:NPOI.SS.Formula.Eval.PowerEval">
  32892. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32893. </member>
  32894. <member name="T:NPOI.SS.Formula.Eval.SubtractEval">
  32895. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32896. </member>
  32897. <member name="T:NPOI.SS.Formula.Eval.UnaryMinusEval">
  32898. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32899. </member>
  32900. <member name="T:NPOI.SS.Formula.Eval.UnaryPlusEval">
  32901. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32902. </member>
  32903. <member name="T:NPOI.SS.Formula.IExternSheetReferenceToken">
  32904. Should be implemented by any {@link Ptg} subclass that needs Has an extern sheet index <br/>
  32905. For POI internal use only
  32906. @author Josh Micich
  32907. </member>
  32908. <member name="T:NPOI.SS.Formula.Formula">
  32909. Encapsulates an encoded formula token array.
  32910. @author Josh Micich
  32911. </member>
  32912. <member name="F:NPOI.SS.Formula.Formula._byteEncoding">
  32913. immutable
  32914. </member>
  32915. <member name="M:NPOI.SS.Formula.Formula.Read(System.Int32,NPOI.Util.ILittleEndianInput)">
  32916. Convenience method for {@link #read(int, LittleEndianInput, int)}
  32917. </member>
  32918. <member name="M:NPOI.SS.Formula.Formula.Read(System.Int32,NPOI.Util.ILittleEndianInput,System.Int32)">
  32919. When there are no array constants present, <c>encodedTokenLen</c>==<c>totalEncodedLen</c>
  32920. @param encodedTokenLen number of bytes in the stream taken by the plain formula tokens
  32921. @param totalEncodedLen the total number of bytes in the formula (includes trailing encoding
  32922. for array constants, but does not include 2 bytes for initial <c>ushort encodedTokenLen</c> field.
  32923. @return A new formula object as read from the stream. Possibly empty, never <code>null</code>.
  32924. </member>
  32925. <member name="M:NPOI.SS.Formula.Formula.Serialize(NPOI.Util.ILittleEndianOutput)">
  32926. Writes The formula encoding is includes:
  32927. <ul>
  32928. <li>ushort tokenDataLen</li>
  32929. <li>tokenData</li>
  32930. <li>arrayConstantData (if present)</li>
  32931. </ul>
  32932. </member>
  32933. <member name="M:NPOI.SS.Formula.Formula.Create(NPOI.SS.Formula.PTG.Ptg[])">
  32934. Creates a {@link Formula} object from a supplied {@link Ptg} array.
  32935. Handles <code>null</code>s OK.
  32936. @param ptgs may be <code>null</code>
  32937. @return Never <code>null</code> (Possibly empty if the supplied <c>ptgs</c> is <code>null</code>)
  32938. </member>
  32939. <member name="M:NPOI.SS.Formula.Formula.GetTokens(NPOI.SS.Formula.Formula)">
  32940. Gets the {@link Ptg} array from the supplied {@link Formula}.
  32941. Handles <code>null</code>s OK.
  32942. @param formula may be <code>null</code>
  32943. @return possibly <code>null</code> (if the supplied <c>formula</c> is <code>null</code>)
  32944. </member>
  32945. <member name="P:NPOI.SS.Formula.Formula.EncodedSize">
  32946. @return total formula encoding length. The formula encoding includes:
  32947. <ul>
  32948. <li>ushort tokenDataLen</li>
  32949. <li>tokenData</li>
  32950. <li>arrayConstantData (optional)</li>
  32951. </ul>
  32952. Note - this value is different to <c>tokenDataLength</c>
  32953. </member>
  32954. <member name="P:NPOI.SS.Formula.Formula.EncodedTokenSize">
  32955. This method is often used when the formula length does not appear immediately before
  32956. the encoded token data.
  32957. @return the encoded length of the plain formula tokens. This does <em>not</em> include
  32958. the leading ushort field, nor any trailing array constant data.
  32959. </member>
  32960. <member name="P:NPOI.SS.Formula.Formula.ExpReference">
  32961. Gets the locator for the corresponding {@link SharedFormulaRecord}, {@link ArrayRecord} or
  32962. {@link TableRecord} if this formula belongs to such a grouping. The {@link CellReference}
  32963. returned by this method will match the top left corner of the range of that grouping.
  32964. The return value is usually not the same as the location of the cell containing this formula.
  32965. @return the firstRow &amp; firstColumn of an array formula or shared formula that this formula
  32966. belongs to. <code>null</code> if this formula is not part of an array or shared formula.
  32967. </member>
  32968. <member name="T:NPOI.SS.Formula.FormulaCellCache">
  32969. @author Josh Micich
  32970. </member>
  32971. <member name="M:NPOI.SS.Formula.FormulaCellCache.Get(NPOI.SS.Formula.IEvaluationCell)">
  32972. @return <c>null</c> if not found
  32973. </member>
  32974. <member name="T:NPOI.SS.Formula.FormulaCellCacheEntry">
  32975. Stores the cached result of a formula evaluation, along with the Set of sensititive input cells
  32976. @author Josh Micich
  32977. </member>
  32978. <member name="F:NPOI.SS.Formula.FormulaCellCacheEntry._sensitiveInputCells">
  32979. Cells 'used' in the current evaluation of the formula corresponding To this cache entry
  32980. If any of the following cells Change, this cache entry needs To be Cleared
  32981. </member>
  32982. <member name="T:NPOI.SS.Formula.FormulaCellCacheEntrySet">
  32983. A custom implementation of {@link java.util.HashSet} in order To reduce memory consumption.
  32984. Profiling tests (Oct 2008) have shown that each element {@link FormulaCellCacheEntry} takes
  32985. around 32 bytes To store in a HashSet, but around 6 bytes To store here. For Spreadsheets with
  32986. thousands of formula cells with multiple interdependencies, the savings can be very significant.
  32987. @author Josh Micich
  32988. </member>
  32989. <member name="T:NPOI.SS.Formula.FormulaParseException">
  32990. <summary>
  32991. Specific exception thrown when a supplied formula does not Parse properly.
  32992. Primarily used by test cases when testing for specific parsing exceptions.
  32993. </summary>
  32994. </member>
  32995. <member name="M:NPOI.SS.Formula.FormulaParseException.#ctor(System.String)">
  32996. <summary>
  32997. This class was given package scope until it would become Clear that it is useful to general client code.
  32998. </summary>
  32999. <param name="msg"></param>
  33000. </member>
  33001. <member name="F:NPOI.SS.Formula.FormulaParser.look">
  33002. Lookahead Character.
  33003. Gets value '\0' when the input string is exhausted
  33004. </member>
  33005. <member name="M:NPOI.SS.Formula.FormulaParser.#ctor(System.String,NPOI.SS.Formula.IFormulaParsingWorkbook,System.Int32)">
  33006. Create the formula Parser, with the string that is To be
  33007. Parsed against the supplied workbook.
  33008. A later call the Parse() method To return ptg list in
  33009. rpn order, then call the GetRPNPtg() To retrive the
  33010. Parse results.
  33011. This class is recommended only for single threaded use.
  33012. If you only have a usermodel.HSSFWorkbook, and not a
  33013. model.Workbook, then use the convenience method on
  33014. usermodel.HSSFFormulaEvaluator
  33015. </member>
  33016. <member name="M:NPOI.SS.Formula.FormulaParser.Parse(System.String,NPOI.SS.Formula.IFormulaParsingWorkbook,NPOI.SS.Formula.FormulaType,System.Int32)">
  33017. Parse a formula into a array of tokens
  33018. @param formula the formula to parse
  33019. @param workbook the parent workbook
  33020. @param formulaType the type of the formula, see {@link FormulaType}
  33021. @param sheetIndex the 0-based index of the sheet this formula belongs to.
  33022. The sheet index is required to resolve sheet-level names. <code>-1</code> means that
  33023. the scope of the name will be ignored and the parser will match names only by name
  33024. @return array of parsed tokens
  33025. @throws FormulaParseException if the formula is unparsable
  33026. </member>
  33027. <member name="M:NPOI.SS.Formula.FormulaParser.GetChar">
  33028. Read New Character From Input Stream
  33029. </member>
  33030. <member name="M:NPOI.SS.Formula.FormulaParser.expected(System.String)">
  33031. Report What Was Expected
  33032. </member>
  33033. <member name="M:NPOI.SS.Formula.FormulaParser.IsAlpha(System.Char)">
  33034. Recognize an Alpha Character
  33035. </member>
  33036. <member name="M:NPOI.SS.Formula.FormulaParser.IsDigit(System.Char)">
  33037. Recognize a Decimal Digit
  33038. </member>
  33039. <member name="M:NPOI.SS.Formula.FormulaParser.IsAlNum(System.Char)">
  33040. Recognize an Alphanumeric
  33041. </member>
  33042. <member name="M:NPOI.SS.Formula.FormulaParser.IsWhite(System.Char)">
  33043. Recognize White Space
  33044. </member>
  33045. <member name="M:NPOI.SS.Formula.FormulaParser.SkipWhite">
  33046. Skip Over Leading White Space
  33047. </member>
  33048. <member name="M:NPOI.SS.Formula.FormulaParser.Match(System.Char)">
  33049. Consumes the next input character if it is equal To the one specified otherwise throws an
  33050. unchecked exception. This method does <b>not</b> consume whitespace (before or after the
  33051. matched character).
  33052. </member>
  33053. <member name="M:NPOI.SS.Formula.FormulaParser.GetNum">
  33054. Get a Number
  33055. </member>
  33056. <member name="M:NPOI.SS.Formula.FormulaParser.NeedsMemFunc(NPOI.SS.Formula.ParseNode)">
  33057. From OOO doc: "Whenever one operand of the reference subexpression is a function,
  33058. a defined name, a 3D reference, or an external reference (and no error occurs),
  33059. a tMemFunc token is used"
  33060. </member>
  33061. <member name="M:NPOI.SS.Formula.FormulaParser.IsValidDefinedNameChar(System.Char)">
  33062. @return <c>true</c> if the specified character may be used in a defined name
  33063. </member>
  33064. <member name="M:NPOI.SS.Formula.FormulaParser.CheckValidRangeOperand(System.String,System.Int32,NPOI.SS.Formula.ParseNode)">
  33065. @param currentParsePosition used to format a potential error message
  33066. </member>
  33067. <member name="M:NPOI.SS.Formula.FormulaParser.IsValidRangeOperand(NPOI.SS.Formula.ParseNode)">
  33068. @return false if sub-expression represented the specified ParseNode definitely
  33069. cannot appear on either side of the range (':') operator
  33070. </member>
  33071. <member name="M:NPOI.SS.Formula.FormulaParser.ParseRangeable">
  33072. Parses area refs (things which could be the operand of ':') and simple factors
  33073. Examples
  33074. <pre>
  33075. A$1
  33076. $A$1 : $B1
  33077. A1 ....... C2
  33078. Sheet1 !$A1
  33079. a..b!A1
  33080. 'my sheet'!A1
  33081. .my.sheet!A1
  33082. 'my sheet':'my alt sheet'!A1
  33083. .my.sheet1:.my.sheet2!$B$2
  33084. my.named..range.
  33085. 'my sheet'!my.named.range
  33086. .my.sheet!my.named.range
  33087. foo.bar(123.456, "abc")
  33088. 123.456
  33089. "abc"
  33090. true
  33091. [Foo.xls]!$A$1
  33092. [Foo.xls]'my sheet'!$A$1
  33093. [Foo.xls]!my.named.range
  33094. </pre>
  33095. </member>
  33096. <member name="M:NPOI.SS.Formula.FormulaParser.ParseNonRange(System.Int32)">
  33097. Parses simple factors that are not primitive ranges or range components
  33098. i.e. '!', ':'(and equiv '...') do not appear
  33099. Examples
  33100. <pre>
  33101. my.named...range.
  33102. foo.bar(123.456, "abc")
  33103. 123.456
  33104. "abc"
  33105. true
  33106. </pre>
  33107. </member>
  33108. <member name="M:NPOI.SS.Formula.FormulaParser.CreateAreaRefParseNode(NPOI.SS.Formula.SheetIdentifier,NPOI.SS.Formula.FormulaParser.SimpleRangePart,NPOI.SS.Formula.FormulaParser.SimpleRangePart)">
  33109. @param sheetIden may be <code>null</code>
  33110. @param part1
  33111. @param part2 may be <code>null</code>
  33112. </member>
  33113. <member name="M:NPOI.SS.Formula.FormulaParser.ParseSimpleRangePart">
  33114. Parses out a potential LHS or RHS of a ':' intended to produce a plain AreaRef. Normally these are
  33115. proper cell references but they could also be row or column refs like "$AC" or "10"
  33116. @return <code>null</code> (and leaves {@link #_pointer} unchanged if a proper range part does not parse out
  33117. </member>
  33118. <member name="M:NPOI.SS.Formula.FormulaParser.ReduceRangeExpression(NPOI.SS.Formula.PTG.Ptg,NPOI.SS.Formula.PTG.Ptg)">
  33119. "A1", "B3" -> "A1:B3"
  33120. "sheet1!A1", "B3" -> "sheet1!A1:B3"
  33121. @return <c>null</c> if the range expression cannot / shouldn't be reduced.
  33122. </member>
  33123. <member name="M:NPOI.SS.Formula.FormulaParser.ParseSheetName">
  33124. Note - caller should reset {@link #_pointer} upon <code>null</code> result
  33125. @return The sheet name as an identifier <code>null</code> if '!' is not found in the right place
  33126. </member>
  33127. <member name="M:NPOI.SS.Formula.FormulaParser.ParseSheetRange(System.String,NPOI.SS.Formula.NameIdentifier)">
  33128. If we have something that looks like [book]Sheet1: or
  33129. Sheet1, see if it's actually a range eg Sheet1:Sheet2!
  33130. </member>
  33131. <member name="M:NPOI.SS.Formula.FormulaParser.IsUnquotedSheetNameChar(System.Char)">
  33132. very similar to {@link SheetNameFormatter#isSpecialChar(char)}
  33133. </member>
  33134. <member name="M:NPOI.SS.Formula.FormulaParser.IsValidCellReference(System.String)">
  33135. @return <c>true</c> if the specified name is a valid cell reference
  33136. </member>
  33137. <member name="M:NPOI.SS.Formula.FormulaParser.Function(System.String)">
  33138. Note - Excel Function names are 'case aware but not case sensitive'. This method may end
  33139. up creating a defined name record in the workbook if the specified name is not an internal
  33140. Excel Function, and Has not been encountered before.
  33141. @param name case preserved Function name (as it was entered/appeared in the formula).
  33142. </member>
  33143. <member name="M:NPOI.SS.Formula.FormulaParser.GetFunction(System.String,NPOI.SS.Formula.PTG.Ptg,NPOI.SS.Formula.ParseNode[])">
  33144. * Generates the variable Function ptg for the formula.
  33145. *
  33146. * For IF Formulas, Additional PTGs are Added To the Tokens
  33147. * @param name a {@link NamePtg} or {@link NameXPtg} or <code>null</code>
  33148. * @return Ptg a null is returned if we're in an IF formula, it needs extreme manipulation and is handled in this Function
  33149. </member>
  33150. <member name="M:NPOI.SS.Formula.FormulaParser.Arguments">
  33151. Get arguments To a Function
  33152. </member>
  33153. <member name="M:NPOI.SS.Formula.FormulaParser.PowerFactor">
  33154. Parse and Translate a Math Factor
  33155. </member>
  33156. <member name="M:NPOI.SS.Formula.FormulaParser.ParseSimpleFactor">
  33157. factors (without ^ or % )
  33158. </member>
  33159. <member name="M:NPOI.SS.Formula.FormulaParser.GetNumberPtgFromString(System.String,System.String,System.String)">
  33160. Get a PTG for an integer from its string representation.
  33161. return Int or Number Ptg based on size of input
  33162. </member>
  33163. <member name="M:NPOI.SS.Formula.FormulaParser.Term">
  33164. Parse and Translate a Math Term
  33165. </member>
  33166. <member name="M:NPOI.SS.Formula.FormulaParser.AdditiveExpression">
  33167. Parse and Translate an Expression
  33168. </member>
  33169. <member name="M:NPOI.SS.Formula.FormulaParser.Parse">
  33170. API call To execute the parsing of the formula
  33171. </member>
  33172. <member name="T:NPOI.SS.Formula.FormulaParser.SimpleRangePart">
  33173. A1, $A1, A$1, $A$1, A, 1
  33174. </member>
  33175. <member name="M:NPOI.SS.Formula.FormulaParser.SimpleRangePart.IsCompatibleForArea(NPOI.SS.Formula.FormulaParser.SimpleRangePart)">
  33176. @return <c>true</c> if the two range parts can be combined in an
  33177. {@link AreaPtg} ( Note - the explicit range operator (:) may still be valid
  33178. when this method returns <c>false</c> )
  33179. </member>
  33180. <member name="T:NPOI.SS.Formula.FormulaRenderer">
  33181. Common logic for rendering formulas.<br/>
  33182. For POI internal use only
  33183. @author Josh Micich
  33184. </member>
  33185. <member name="M:NPOI.SS.Formula.FormulaRenderer.ToFormulaString(NPOI.SS.Formula.IFormulaRenderingWorkbook,NPOI.SS.Formula.PTG.Ptg[])">
  33186. Static method To convert an array of {@link Ptg}s in RPN order
  33187. To a human readable string format in infix mode.
  33188. @param book used for defined names and 3D references
  33189. @param ptgs must not be <c>null</c>
  33190. @return a human readable String
  33191. </member>
  33192. <member name="T:NPOI.SS.Formula.FormulaType">
  33193. Enumeration of various formula types.<br/>
  33194. For POI internal use only
  33195. @author Josh Micich
  33196. </member>
  33197. <member name="T:NPOI.SS.Formula.FormulaUsedBlankCellSet">
  33198. Optimisation - compacts many blank cell references used by a single formula.
  33199. @author Josh Micich
  33200. </member>
  33201. <member name="T:NPOI.SS.Formula.Functions.Address">
  33202. Creates a text reference as text, given specified row and column numbers.
  33203. @author Aniket Banerjee (banerjee@google.com)
  33204. </member>
  33205. <member name="T:NPOI.SS.Formula.Functions.AggregateFunction">
  33206. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33207. </member>
  33208. <member name="P:NPOI.SS.Formula.Functions.SubtotalInstance.IsSubtotalCounted">
  33209. ignore nested subtotals.
  33210. </member>
  33211. <member name="T:NPOI.SS.Formula.Functions.Percentile">
  33212. Returns the k-th percentile of values in a range. You can use this function to establish a threshold of
  33213. acceptance. For example, you can decide to examine candidates who score above the 90th percentile.
  33214. PERCENTILE(array,k)
  33215. Array is the array or range of data that defines relative standing.
  33216. K is the percentile value in the range 0..1, inclusive.
  33217. <strong>Remarks</strong>
  33218. <ul>
  33219. <li>if array is empty or Contains more than 8,191 data points, PERCENTILE returns the #NUM! error value.</li>
  33220. <li>If k is nonnumeric, PERCENTILE returns the #VALUE! error value.</li>
  33221. <li>If k is &lt; 0 or if k &gt; 1, PERCENTILE returns the #NUM! error value.</li>
  33222. <li>If k is not a multiple of 1/(n - 1), PERCENTILE interpolates to determine the value at the k-th percentile.</li>
  33223. </ul>
  33224. </member>
  33225. <member name="T:NPOI.SS.Formula.Functions.BooleanFunction">
  33226. Here are the general rules concerning Boolean functions:
  33227. <ol>
  33228. <li> Blanks are ignored (not either true or false) </li>
  33229. <li> Strings are ignored if part of an area ref or cell ref, otherwise they must be 'true' or 'false'</li>
  33230. <li> Numbers: 0 is false. Any other number is TRUE </li>
  33231. <li> Areas: *all* cells in area are evaluated according to the above rules</li>
  33232. </ol>
  33233. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33234. </member>
  33235. <member name="T:NPOI.SS.Formula.Functions.False">
  33236. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33237. </member>
  33238. <member name="T:NPOI.SS.Formula.Functions.Fixed0ArgFunction">
  33239. Convenience base class for functions that only take zero arguments.
  33240. @author Josh Micich
  33241. </member>
  33242. <member name="T:NPOI.SS.Formula.Functions.Function0Arg">
  33243. Implemented by all functions that can be called with zero arguments
  33244. @author Josh Micich
  33245. </member>
  33246. <member name="M:NPOI.SS.Formula.Functions.Function0Arg.Evaluate(System.Int32,System.Int32)">
  33247. see {@link Function#Evaluate(ValueEval[], int, int)}
  33248. </member>
  33249. <member name="T:NPOI.SS.Formula.Functions.True">
  33250. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33251. </member>
  33252. <member name="T:NPOI.SS.Formula.Functions.CalendarFieldFunction">
  33253. Implementation of Excel functions Date parsing functions:
  33254. Date - DAY, MONTH and YEAR
  33255. Time - HOUR, MINUTE and SECOND
  33256. @author Others (not mentioned in code)
  33257. @author Thies Wellpott
  33258. </member>
  33259. <member name="T:NPOI.SS.Formula.Functions.Ceiling">
  33260. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33261. </member>
  33262. <member name="T:NPOI.SS.Formula.Functions.Choose">
  33263. @author Josh Micich
  33264. </member>
  33265. <member name="T:NPOI.SS.Formula.Functions.Columns">
  33266. Implementation for Excel COLUMNS function.
  33267. @author Josh Micich
  33268. </member>
  33269. <member name="T:NPOI.SS.Formula.Functions.Combin">
  33270. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33271. </member>
  33272. <member name="T:NPOI.SS.Formula.Functions.Count">
  33273. Counts the number of cells that contain numeric data within
  33274. the list of arguments.
  33275. Excel Syntax
  33276. COUNT(value1,value2,...)
  33277. Value1, value2, ... are 1 to 30 arguments representing the values or ranges to be Counted.
  33278. TODO: Check this properly Matches excel on edge cases
  33279. like formula cells, error cells etc
  33280. </member>
  33281. <member name="M:NPOI.SS.Formula.Functions.Count.SubtotalInstance">
  33282. Create an instance of Count to use in {@link Subtotal}
  33283. <p>
  33284. If there are other subtotals within argument refs (or nested subtotals),
  33285. these nested subtotals are ignored to avoid double counting.
  33286. </p>
  33287. @see Subtotal
  33288. </member>
  33289. <member name="T:NPOI.SS.Formula.Functions.IMatchPredicate">
  33290. Common interface for the matching criteria.
  33291. </member>
  33292. <member name="T:NPOI.SS.Formula.Functions.Counta">
  33293. Counts the number of cells that contain data within the list of arguments.
  33294. Excel Syntax
  33295. COUNTA(value1,value2,...)
  33296. Value1, value2, ... are 1 to 30 arguments representing the values or ranges to be Counted.
  33297. @author Josh Micich
  33298. </member>
  33299. <member name="M:NPOI.SS.Formula.Functions.Counta.SubtotalPredicate.Matches(NPOI.SS.Formula.TwoDEval,System.Int32,System.Int32)">
  33300. don't count cells that are subtotals
  33301. </member>
  33302. <member name="T:NPOI.SS.Formula.Functions.Countblank">
  33303. Implementation for the function COUNTBLANK
  33304. <p>
  33305. Syntax: COUNTBLANK ( range )
  33306. <table border="0" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  33307. <tr><th>range </th><td>is the range of cells to count blanks</td></tr>
  33308. </table>
  33309. </p>
  33310. @author Mads Mohr Christensen
  33311. </member>
  33312. <member name="T:NPOI.SS.Formula.Functions.Countif">
  33313. Implementation for the function COUNTIF<p/>
  33314. Syntax: COUNTIF ( range, criteria )
  33315. <table border="0" cellpAdding="1" cellspacing="0" summary="Parameter descriptions">
  33316. <tr><th>range </th><td>is the range of cells to be Counted based on the criteria</td></tr>
  33317. <tr><th>criteria</th><td>is used to determine which cells to Count</td></tr>
  33318. </table>
  33319. <p/>
  33320. @author Josh Micich
  33321. </member>
  33322. <member name="M:NPOI.SS.Formula.Functions.Countif.CountMatchingCellsInArea(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Functions.IMatchPredicate)">
  33323. @return the number of evaluated cells in the range that match the specified criteria
  33324. </member>
  33325. <member name="M:NPOI.SS.Formula.Functions.Countif.EvaluateCriteriaArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  33326. @return the de-referenced criteria arg (possibly {@link ErrorEval})
  33327. </member>
  33328. <member name="M:NPOI.SS.Formula.Functions.Countif.CreateGeneralMatchPredicate(NPOI.SS.Formula.Eval.StringEval)">
  33329. When the second argument is a string, many things are possible
  33330. </member>
  33331. <member name="M:NPOI.SS.Formula.Functions.Countif.CreateCriteriaPredicate(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  33332. Creates a criteria predicate object for the supplied criteria arg
  33333. @return <code>null</code> if the arg evaluates to blank.
  33334. </member>
  33335. <member name="M:NPOI.SS.Formula.Functions.Countif.ParseBoolean(System.String)">
  33336. bool literals ('TRUE', 'FALSE') treated similarly but NOT same as numbers.
  33337. </member>
  33338. <member name="P:NPOI.SS.Formula.Functions.Countif.CmpOp.Length">
  33339. @return number of characters used to represent this operator
  33340. </member>
  33341. <member name="M:NPOI.SS.Formula.Functions.Countif.StringMatcher.GetWildCardPattern(System.String)">
  33342. <summary>
  33343. Translates Excel countif wildcard strings into .NET regex strings
  33344. </summary>
  33345. <param name="value">Excel wildcard expression</param>
  33346. <returns>return null if the specified value contains no special wildcard characters.</returns>
  33347. </member>
  33348. <member name="T:NPOI.SS.Formula.Functions.CountUtils">
  33349. Common logic for COUNT, COUNTA and COUNTIF
  33350. @author Josh Micich
  33351. </member>
  33352. <member name="M:NPOI.SS.Formula.Functions.CountUtils.CountMatchingCellsInRef(NPOI.SS.Formula.Eval.RefEval,NPOI.SS.Formula.Functions.IMatchPredicate)">
  33353. @return the number of evaluated cells in the range that match the specified criteria
  33354. </member>
  33355. <member name="M:NPOI.SS.Formula.Functions.CountUtils.CountMatchingCellsInArea(NPOI.SS.Formula.ThreeDEval,NPOI.SS.Formula.Functions.IMatchPredicate)">
  33356. @return the number of evaluated cells in the range that match the specified criteria
  33357. </member>
  33358. <member name="T:NPOI.SS.Formula.Functions.DateFunc">
  33359. @author Pavel Krupets (pkrupets at palmtreebusiness dot com)
  33360. </member>
  33361. <member name="T:NPOI.SS.Formula.Functions.Fixed3ArgFunction">
  33362. Convenience base class for functions that must take exactly three arguments.
  33363. @author Josh Micich
  33364. </member>
  33365. <member name="M:NPOI.SS.Formula.Functions.DateFunc.Evaluate(System.Int32,System.Int32,System.Int32)">
  33366. * Note - works with Java Calendar months, not Excel months
  33367. * Java Calendar month = Excel month + 1
  33368. </member>
  33369. <member name="T:NPOI.SS.Formula.Functions.Degrees">
  33370. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33371. </member>
  33372. <member name="T:NPOI.SS.Formula.Functions.Dollar">
  33373. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33374. </member>
  33375. <member name="T:NPOI.SS.Formula.Functions.Even">
  33376. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33377. </member>
  33378. <member name="T:NPOI.SS.Formula.Functions.Exp">
  33379. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33380. </member>
  33381. <member name="T:NPOI.SS.Formula.Functions.Fact">
  33382. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33383. </member>
  33384. <member name="T:NPOI.SS.Formula.Functions.FinanceFunction">
  33385. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33386. Super class for all Evals for financial function evaluation.
  33387. </member>
  33388. <member name="T:NPOI.SS.Formula.Functions.Function4Arg">
  33389. Implemented by all functions that can be called with four arguments
  33390. @author Josh Micich
  33391. </member>
  33392. <member name="M:NPOI.SS.Formula.Functions.Function4Arg.Evaluate(System.Int32,System.Int32,NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.ValueEval)">
  33393. see {@link Function#Evaluate(ValueEval[], int, int)}
  33394. </member>
  33395. <member name="T:NPOI.SS.Formula.Functions.FinanceLib">
  33396. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33397. This class Is a functon library for common fiscal functions.
  33398. <b>Glossary of terms/abbreviations:</b>
  33399. <br/>
  33400. <ul>
  33401. <li><em>FV:</em> Future Value</li>
  33402. <li><em>PV:</em> Present Value</li>
  33403. <li><em>NPV:</em> Net Present Value</li>
  33404. <li><em>PMT:</em> (Periodic) Payment</li>
  33405. </ul>
  33406. For more info on the terms/abbreviations please use the references below
  33407. (hyperlinks are subject to Change):
  33408. <br/>Online References:
  33409. <ol>
  33410. <li>GNU Emacs Calc 2.02 Manual: http://theory.uwinnipeg.ca/gnu/calc/calc_203.html</li>
  33411. <li>Yahoo Financial Glossary: http://biz.yahoo.com/f/g/nn.html#y</li>
  33412. <li>MS Excel function reference: http://office.microsoft.com/en-us/assistance/CH062528251033.aspx</li>
  33413. </ol>
  33414. <h3>Implementation Notes:</h3>
  33415. Symbols used in the formulae that follow:<br/>
  33416. <ul>
  33417. <li>p: present value</li>
  33418. <li>f: future value</li>
  33419. <li>n: number of periods</li>
  33420. <li>y: payment (in each period)</li>
  33421. <li>r: rate</li>
  33422. <li>^: the power operator (NOT the java bitwise XOR operator!)</li>
  33423. </ul>
  33424. [From MS Excel function reference] Following are some of the key formulas
  33425. that are used in this implementation:
  33426. <pre>
  33427. p(1+r)^n + y(1+rt)((1+r)^n-1)/r + f=0 ...{when r!=0}
  33428. ny + p + f=0 ...{when r=0}
  33429. </pre>
  33430. </member>
  33431. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.fv(System.Double,System.Double,System.Double,System.Double,System.Boolean)">
  33432. Future value of an amount given the number of payments, rate, amount
  33433. of individual payment, present value and bool value indicating whether
  33434. payments are due at the beginning of period
  33435. (false => payments are due at end of period)
  33436. @param r rate
  33437. @param n num of periods
  33438. @param y pmt per period
  33439. @param p future value
  33440. @param t type (true=pmt at end of period, false=pmt at begining of period)
  33441. </member>
  33442. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.pv(System.Double,System.Double,System.Double,System.Double,System.Boolean)">
  33443. Present value of an amount given the number of future payments, rate, amount
  33444. of individual payment, future value and bool value indicating whether
  33445. payments are due at the beginning of period
  33446. (false => payments are due at end of period)
  33447. @param r
  33448. @param n
  33449. @param y
  33450. @param f
  33451. @param t
  33452. </member>
  33453. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.npv(System.Double,System.Double[])">
  33454. calculates the Net Present Value of a principal amount
  33455. given the disCount rate and a sequence of cash flows
  33456. (supplied as an array). If the amounts are income the value should
  33457. be positive, else if they are payments and not income, the
  33458. value should be negative.
  33459. @param r
  33460. @param cfs cashflow amounts
  33461. </member>
  33462. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.pmt(System.Double,System.Double,System.Double,System.Double,System.Boolean)">
  33463. @param r
  33464. @param n
  33465. @param p
  33466. @param f
  33467. @param t
  33468. </member>
  33469. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.nper(System.Double,System.Double,System.Double,System.Double,System.Boolean)">
  33470. @param r
  33471. @param y
  33472. @param p
  33473. @param f
  33474. @param t
  33475. </member>
  33476. <member name="T:NPOI.SS.Formula.Functions.Fixed4ArgFunction">
  33477. Convenience base class for functions that must take exactly four arguments.
  33478. @author Josh Micich
  33479. </member>
  33480. <member name="T:NPOI.SS.Formula.Functions.Floor">
  33481. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33482. </member>
  33483. <member name="T:NPOI.SS.Formula.Functions.Hlookup">
  33484. Implementation of the HLOOKUP() function.<p/>
  33485. HLOOKUP Finds a column in a lookup table by the first row value and returns the value from another row.<br/>
  33486. <b>Syntax</b>:<br/>
  33487. <b>HLOOKUP</b>(<b>lookup_value</b>, <b>table_array</b>, <b>row_index_num</b>, range_lookup)<p/>
  33488. <b>lookup_value</b> The value to be found in the first column of the table array.<br/>
  33489. <b>table_array</b> An area reference for the lookup data. <br/>
  33490. <b>row_index_num</b> a 1 based index specifying which row value of the lookup data will be returned.<br/>
  33491. <b>range_lookup</b> If TRUE (default), HLOOKUP Finds the largest value less than or equal to
  33492. the lookup_value. If FALSE, only exact Matches will be considered<br/>
  33493. @author Josh Micich
  33494. </member>
  33495. <member name="M:NPOI.SS.Formula.Functions.Hlookup.CreateResultColumnVector(NPOI.SS.Formula.Eval.AreaEval,System.Int32)">
  33496. Returns one column from an <c>AreaEval</c>
  33497. @(#VALUE!) if colIndex Is negative, (#REF!) if colIndex Is too high
  33498. </member>
  33499. <member name="T:NPOI.SS.Formula.Functions.If">
  33500. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33501. </member>
  33502. <member name="T:NPOI.SS.Formula.Functions.Index">
  33503. Implementation for the Excel function INDEX
  33504. Syntax : <br/>
  33505. INDEX ( reference, row_num[, column_num [, area_num]])<br/>
  33506. INDEX ( array, row_num[, column_num])
  33507. <table border="0" cellpAdding="1" cellspacing="0" summary="Parameter descriptions">
  33508. <tr><th>reference</th><td>typically an area reference, possibly a union of areas</td></tr>
  33509. <tr><th>array</th><td>a literal array value (currently not supported)</td></tr>
  33510. <tr><th>row_num</th><td>selects the row within the array or area reference</td></tr>
  33511. <tr><th>column_num</th><td>selects column within the array or area reference. default Is 1</td></tr>
  33512. <tr><th>area_num</th><td>used when reference Is a union of areas</td></tr>
  33513. </table>
  33514. @author Josh Micich
  33515. </member>
  33516. <member name="M:NPOI.SS.Formula.Functions.Index.GetValueFromArea(NPOI.SS.Formula.Eval.AreaEval,System.Int32,System.Int32,System.Boolean,System.Int32,System.Int32)">
  33517. @param colArgWasPassed <c>false</c> if the INDEX argument lIst had just 2 items
  33518. (exactly 1 comma). If anything Is passed for the <c>column_num</c> argument
  33519. (including {@link BlankEval} or {@link MIssingArgEval}) this parameter will be
  33520. <c>true</c>. ThIs parameter is needed because error codes are slightly
  33521. different when only 2 args are passed.
  33522. </member>
  33523. <member name="M:NPOI.SS.Formula.Functions.Index.ResolveIndexArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  33524. @param arg a 1-based index.
  33525. @return the Resolved 1-based index. Zero if the arg was missing or blank
  33526. @throws EvaluationException if the arg Is an error value evaluates to a negative numeric value
  33527. </member>
  33528. <member name="T:NPOI.SS.Formula.Functions.Indirect">
  33529. Implementation for Excel function INDIRECT<p/>
  33530. INDIRECT() returns the cell or area reference denoted by the text argument.<p/>
  33531. <b>Syntax</b>:<br/>
  33532. <b>INDIRECT</b>(<b>ref_text</b>,isA1Style)<p/>
  33533. <b>ref_text</b> a string representation of the desired reference as it would normally be written
  33534. in a cell formula.<br/>
  33535. <b>isA1Style</b> (default TRUE) specifies whether the ref_text should be interpreted as A1-style
  33536. or R1C1-style.
  33537. @author Josh Micich
  33538. </member>
  33539. <member name="M:NPOI.SS.Formula.Functions.Indirect.ParseWorkbookAndSheetName(System.String)">
  33540. @return array of length 2: {workbookName, sheetName,}. Second element will always be
  33541. present. First element may be null if sheetName is unqualified.
  33542. Returns <code>null</code> if text cannot be parsed.
  33543. </member>
  33544. <member name="M:NPOI.SS.Formula.Functions.Indirect.UnescapeString(System.String)">
  33545. @return <code>null</code> if there is a syntax error in any escape sequence
  33546. (the typical syntax error is a single quote character not followed by another).
  33547. </member>
  33548. <member name="T:NPOI.SS.Formula.Functions.Int">
  33549. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33550. </member>
  33551. <member name="T:NPOI.SS.Formula.Functions.Irr">
  33552. Calculates the internal rate of return.
  33553. Syntax is IRR(values) or IRR(values,guess)
  33554. @author Marcel May
  33555. @author Yegor Kozlov
  33556. @see <a href="http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution">Wikipedia on IRR</a>
  33557. @see <a href="http://office.microsoft.com/en-us/excel-help/irr-HP005209146.aspx">Excel IRR</a>
  33558. </member>
  33559. <member name="M:NPOI.SS.Formula.Functions.Irr.irr(System.Double[])">
  33560. Computes the internal rate of return using an estimated irr of 10 percent.
  33561. @param income the income values.
  33562. @return the irr.
  33563. </member>
  33564. <member name="M:NPOI.SS.Formula.Functions.Irr.irr(System.Double[],System.Double)">
  33565. Calculates IRR using the Newton-Raphson Method.
  33566. <p>
  33567. Starting with the guess, the method cycles through the calculation until the result
  33568. is accurate within 0.00001 percent. If IRR can't find a result that works
  33569. after 20 tries, the Double.NaN is returned.
  33570. </p>
  33571. <p>
  33572. The implementation is inspired by the NewtonSolver from the Apache Commons-Math library,
  33573. @see <a href="http://commons.apache.org">http://commons.apache.org</a>
  33574. </p>
  33575. @param values the income values.
  33576. @param guess the initial guess of irr.
  33577. @return the irr value. The method returns <code>Double.NaN</code>
  33578. if the maximum iteration count is exceeded
  33579. @see <a href="http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution">
  33580. http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution</a>
  33581. @see <a href="http://en.wikipedia.org/wiki/Newton%27s_method">
  33582. http://en.wikipedia.org/wiki/Newton%27s_method</a>
  33583. </member>
  33584. <member name="T:NPOI.SS.Formula.Functions.Isblank">
  33585. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33586. </member>
  33587. <member name="T:NPOI.SS.Formula.Functions.Iserror">
  33588. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33589. </member>
  33590. <member name="T:NPOI.SS.Formula.Functions.Islogical">
  33591. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33592. </member>
  33593. <member name="T:NPOI.SS.Formula.Functions.Isna">
  33594. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33595. </member>
  33596. <member name="T:NPOI.SS.Formula.Functions.Isnontext">
  33597. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33598. </member>
  33599. <member name="T:NPOI.SS.Formula.Functions.Isnumber">
  33600. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33601. </member>
  33602. <member name="T:NPOI.SS.Formula.Functions.Isref">
  33603. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33604. </member>
  33605. <member name="T:NPOI.SS.Formula.Functions.Istext">
  33606. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33607. </member>
  33608. <member name="T:NPOI.SS.Formula.Functions.Lookup">
  33609. Implementation of Excel function LOOKUP.<p/>
  33610. LOOKUP Finds an index row in a lookup table by the first column value and returns the value from another column.
  33611. <b>Syntax</b>:<br/>
  33612. <b>VLOOKUP</b>(<b>lookup_value</b>, <b>lookup_vector</b>, result_vector)<p/>
  33613. <b>lookup_value</b> The value to be found in the lookup vector.<br/>
  33614. <b>lookup_vector</b> An area reference for the lookup data. <br/>
  33615. <b>result_vector</b> Single row or single column area reference from which the result value Is chosen.<br/>
  33616. @author Josh Micich
  33617. </member>
  33618. <member name="T:NPOI.SS.Formula.Functions.LookupUtils">
  33619. Common functionality used by VLOOKUP, HLOOKUP, LOOKUP and MATCH
  33620. @author Josh Micich
  33621. </member>
  33622. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.CreateVector(NPOI.SS.Formula.TwoDEval)">
  33623. @return <c>null</c> if the supplied area is neither a single row nor a single colum
  33624. </member>
  33625. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.ResolveRowOrColIndexArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  33626. Processes the third argument to VLOOKUP, or HLOOKUP (<b>col_index_num</b>
  33627. or <b>row_index_num</b> respectively).<br/>
  33628. Sample behaviour:
  33629. <table border="0" cellpAdding="1" cellspacing="2" summary="Sample behaviour">
  33630. <tr><th>Input Return</th><th>Value </th><th>Thrown Error</th></tr>
  33631. <tr><td>5</td><td>4</td><td> </td></tr>
  33632. <tr><td>2.9</td><td>2</td><td> </td></tr>
  33633. <tr><td>"5"</td><td>4</td><td> </td></tr>
  33634. <tr><td>"2.18e1"</td><td>21</td><td> </td></tr>
  33635. <tr><td>"-$2"</td><td>-3</td><td>*</td></tr>
  33636. <tr><td>FALSE</td><td>-1</td><td>*</td></tr>
  33637. <tr><td>TRUE</td><td>0</td><td> </td></tr>
  33638. <tr><td>"TRUE"</td><td> </td><td>#REF!</td></tr>
  33639. <tr><td>"abc"</td><td> </td><td>#REF!</td></tr>
  33640. <tr><td>""</td><td> </td><td>#REF!</td></tr>
  33641. <tr><td>&lt;blank&gt;</td><td> </td><td>#VALUE!</td></tr>
  33642. </table><br/>
  33643. * Note - out of range errors (both too high and too low) are handled by the caller.
  33644. @return column or row index as a zero-based value
  33645. </member>
  33646. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.ResolveTableArrayArg(NPOI.SS.Formula.Eval.ValueEval)">
  33647. The second argument (table_array) should be an area ref, but can actually be a cell ref, in
  33648. which case it Is interpreted as a 1x1 area ref. Other scalar values cause #VALUE! error.
  33649. </member>
  33650. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.ResolveRangeLookupArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  33651. Resolves the last (optional) parameter (<b>range_lookup</b>) to the VLOOKUP and HLOOKUP functions.
  33652. @param rangeLookupArg
  33653. @param srcCellRow
  33654. @param srcCellCol
  33655. @return
  33656. @throws EvaluationException
  33657. </member>
  33658. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.LookupIndexOfExactValue(NPOI.SS.Formula.Functions.LookupValueComparer,NPOI.SS.Formula.Functions.ValueVector)">
  33659. Finds first (lowest index) exact occurrence of specified value.
  33660. @param lookupComparer the value to be found in column or row vector
  33661. @param vector the values to be searched. For VLOOKUP this Is the first column of the
  33662. tableArray. For HLOOKUP this Is the first row of the tableArray.
  33663. @return zero based index into the vector, -1 if value cannot be found
  33664. </member>
  33665. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.PerformBinarySearch(NPOI.SS.Formula.Functions.ValueVector,NPOI.SS.Formula.Functions.LookupValueComparer)">
  33666. Excel has funny behaviour when the some elements in the search vector are the wrong type.
  33667. </member>
  33668. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.HandleMidValueTypeMismatch(NPOI.SS.Formula.Functions.LookupValueComparer,NPOI.SS.Formula.Functions.ValueVector,NPOI.SS.Formula.Functions.BinarySearchIndexes,System.Int32)">
  33669. Excel seems to handle mismatched types initially by just stepping 'mid' ix forward to the
  33670. first compatible value.
  33671. @param midIx 'mid' index (value which has the wrong type)
  33672. @return usually -1, signifying that the BinarySearchIndex has been narrowed to the new mid
  33673. index. Zero or greater signifies that an exact match for the lookup value was found
  33674. </member>
  33675. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.FindLastIndexInRunOfEqualValues(NPOI.SS.Formula.Functions.LookupValueComparer,NPOI.SS.Formula.Functions.ValueVector,System.Int32,System.Int32)">
  33676. Once the binary search has found a single match, (V/H)LOOKUP steps one by one over subsequent
  33677. values to choose the last matching item.
  33678. </member>
  33679. <member name="M:NPOI.SS.Formula.Functions.LookupValueComparer.CompareTo(NPOI.SS.Formula.Eval.ValueEval)">
  33680. @return one of 4 instances or <c>CompareResult</c>: <c>LESS_THAN</c>, <c>EQUAL</c>,
  33681. <c>GREATER_THAN</c> or <c>TYPE_MISMATCH</c>
  33682. </member>
  33683. <member name="M:NPOI.SS.Formula.Functions.LookupValueComparerBase.GetValueAsString">
  33684. used only for debug purposes
  33685. </member>
  33686. <member name="T:NPOI.SS.Formula.Functions.CompareResult">
  33687. Enumeration to support <b>4</b> valued comparison results.<p/>
  33688. Excel lookup functions have complex behaviour in the case where the lookup array has mixed
  33689. types, and/or Is Unordered. Contrary to suggestions in some Excel documentation, there
  33690. does not appear to be a Universal ordering across types. The binary search algorithm used
  33691. Changes behaviour when the Evaluated 'mid' value has a different type to the lookup value.<p/>
  33692. A simple int might have done the same job, but there Is risk in confusion with the well
  33693. known <c>Comparable.CompareTo()</c> and <c>Comparator.Compare()</c> which both use
  33694. a ubiquitous 3 value result encoding.
  33695. </member>
  33696. <member name="T:NPOI.SS.Formula.Functions.BinarySearchIndexes">
  33697. Encapsulates some standard binary search functionality so the Unusual Excel behaviour can
  33698. be clearly distinguished.
  33699. </member>
  33700. <member name="M:NPOI.SS.Formula.Functions.BinarySearchIndexes.GetMidIx">
  33701. @return -1 if the search range Is empty
  33702. </member>
  33703. <member name="T:NPOI.SS.Formula.Functions.Match">
  33704. Implementation for the MATCH() Excel function.<p/>
  33705. <b>Syntax:</b><br/>
  33706. <b>MATCH</b>(<b>lookup_value</b>, <b>lookup_array</b>, match_type)<p/>
  33707. Returns a 1-based index specifying at what position in the <b>lookup_array</b> the specified
  33708. <b>lookup_value</b> Is found.<p/>
  33709. Specific matching behaviour can be modified with the optional <b>match_type</b> parameter.
  33710. <table border="0" cellpAdding="1" cellspacing="0" summary="match_type parameter description">
  33711. <tr><th>Value</th><th>Matching Behaviour</th></tr>
  33712. <tr><td>1</td><td>(default) Find the largest value that Is less than or equal to lookup_value.
  33713. The lookup_array must be in ascending <i>order</i>*.</td></tr>
  33714. <tr><td>0</td><td>Find the first value that Is exactly equal to lookup_value.
  33715. The lookup_array can be in any order.</td></tr>
  33716. <tr><td>-1</td><td>Find the smallest value that Is greater than or equal to lookup_value.
  33717. The lookup_array must be in descending <i>order</i>*.</td></tr>
  33718. </table>
  33719. * Note regarding <i>order</i> - For the <b>match_type</b> cases that require the lookup_array to
  33720. be ordered, MATCH() can produce incorrect results if this requirement Is not met. Observed
  33721. behaviour in Excel Is to return the lowest index value for which every item after that index
  33722. breaks the match rule.<br/>
  33723. The (ascending) sort order expected by MATCH() Is:<br/>
  33724. numbers (low to high), strings (A to Z), bool (FALSE to TRUE)<br/>
  33725. MATCH() ignores all elements in the lookup_array with a different type to the lookup_value.
  33726. Type conversion of the lookup_array elements Is never performed.
  33727. @author Josh Micich
  33728. </member>
  33729. <member name="M:NPOI.SS.Formula.Functions.Match.FindIndexOfValue(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Functions.ValueVector,System.Boolean,System.Boolean)">
  33730. @return zero based index
  33731. </member>
  33732. <member name="T:NPOI.SS.Formula.Functions.MathX">
  33733. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33734. This class Is an extension to the standard math library
  33735. provided by java.lang.Math class. It follows the Math class
  33736. in that it has a private constructor and all static methods.
  33737. </member>
  33738. <member name="M:NPOI.SS.Formula.Functions.MathX.Round(System.Double,System.Int32)">
  33739. Returns a value rounded to p digits after decimal.
  33740. If p Is negative, then the number Is rounded to
  33741. places to the left of the decimal point. eg.
  33742. 10.23 rounded to -1 will give: 10. If p Is zero,
  33743. the returned value Is rounded to the nearest integral
  33744. value.
  33745. If n Is negative, the resulting value Is obtained
  33746. as the round value of absolute value of n multiplied
  33747. by the sign value of n (@see MathX.sign(double d)).
  33748. Thus, -0.6666666 rounded to p=0 will give -1 not 0.
  33749. If n Is NaN, returned value Is NaN.
  33750. @param n
  33751. @param p
  33752. </member>
  33753. <member name="M:NPOI.SS.Formula.Functions.MathX.RoundUp(System.Double,System.Int32)">
  33754. Returns a value rounded-up to p digits after decimal.
  33755. If p Is negative, then the number Is rounded to
  33756. places to the left of the decimal point. eg.
  33757. 10.23 rounded to -1 will give: 20. If p Is zero,
  33758. the returned value Is rounded to the nearest integral
  33759. value.
  33760. If n Is negative, the resulting value Is obtained
  33761. as the round-up value of absolute value of n multiplied
  33762. by the sign value of n (@see MathX.sign(double d)).
  33763. Thus, -0.2 rounded-up to p=0 will give -1 not 0.
  33764. If n Is NaN, returned value Is NaN.
  33765. @param n
  33766. @param p
  33767. </member>
  33768. <member name="M:NPOI.SS.Formula.Functions.MathX.RoundDown(System.Double,System.Int32)">
  33769. Returns a value rounded to p digits after decimal.
  33770. If p Is negative, then the number Is rounded to
  33771. places to the left of the decimal point. eg.
  33772. 10.23 rounded to -1 will give: 10. If p Is zero,
  33773. the returned value Is rounded to the nearest integral
  33774. value.
  33775. If n Is negative, the resulting value Is obtained
  33776. as the round-up value of absolute value of n multiplied
  33777. by the sign value of n (@see MathX.sign(double d)).
  33778. Thus, -0.8 rounded-down to p=0 will give 0 not -1.
  33779. If n Is NaN, returned value Is NaN.
  33780. @param n
  33781. @param p
  33782. </member>
  33783. <member name="M:NPOI.SS.Formula.Functions.MathX.Average(System.Double[])">
  33784. average of all values
  33785. @param values
  33786. </member>
  33787. <member name="M:NPOI.SS.Formula.Functions.MathX.Sum(System.Double[])">
  33788. sum of all values
  33789. @param values
  33790. </member>
  33791. <member name="M:NPOI.SS.Formula.Functions.MathX.Sumsq(System.Double[])">
  33792. sum of squares of all values
  33793. @param values
  33794. </member>
  33795. <member name="M:NPOI.SS.Formula.Functions.MathX.Product(System.Double[])">
  33796. product of all values
  33797. @param values
  33798. </member>
  33799. <member name="M:NPOI.SS.Formula.Functions.MathX.Min(System.Double[])">
  33800. min of all values. If supplied array Is zero Length,
  33801. double.POSITIVE_INFINITY Is returned.
  33802. @param values
  33803. </member>
  33804. <member name="M:NPOI.SS.Formula.Functions.MathX.Max(System.Double[])">
  33805. min of all values. If supplied array Is zero Length,
  33806. double.NEGATIVE_INFINITY Is returned.
  33807. @param values
  33808. </member>
  33809. <member name="M:NPOI.SS.Formula.Functions.MathX.Floor(System.Double,System.Double)">
  33810. Note: this function Is different from java.lang.Math.floor(..).
  33811. When n and s are "valid" arguments, the returned value Is: Math.floor(n/s) * s;
  33812. <br/>
  33813. n and s are invalid if any of following conditions are true:
  33814. <ul>
  33815. <li>s Is zero</li>
  33816. <li>n Is negative and s Is positive</li>
  33817. <li>n Is positive and s Is negative</li>
  33818. </ul>
  33819. In all such cases, double.NaN Is returned.
  33820. @param n
  33821. @param s
  33822. </member>
  33823. <member name="M:NPOI.SS.Formula.Functions.MathX.Ceiling(System.Double,System.Double)">
  33824. Note: this function Is different from java.lang.Math.ceil(..).
  33825. When n and s are "valid" arguments, the returned value Is: Math.ceiling(n/s) * s;
  33826. <br/>
  33827. n and s are invalid if any of following conditions are true:
  33828. <ul>
  33829. <li>s Is zero</li>
  33830. <li>n Is negative and s Is positive</li>
  33831. <li>n Is positive and s Is negative</li>
  33832. </ul>
  33833. In all such cases, double.NaN Is returned.
  33834. @param n
  33835. @param s
  33836. </member>
  33837. <member name="M:NPOI.SS.Formula.Functions.MathX.Factorial(System.Int32)">
  33838. <br/> for all n >= 1; factorial n = n * (n-1) * (n-2) * ... * 1
  33839. <br/> else if n == 0; factorial n = 1
  33840. <br/> else if n &lt; 0; factorial n = double.NaN
  33841. <br/> Loss of precision can occur if n Is large enough.
  33842. If n Is large so that the resulting value would be greater
  33843. than double.MAX_VALUE; double.POSITIVE_INFINITY Is returned.
  33844. If n &lt; 0, double.NaN Is returned.
  33845. @param n
  33846. </member>
  33847. <member name="M:NPOI.SS.Formula.Functions.MathX.Mod(System.Double,System.Double)">
  33848. returns the remainder resulting from operation:
  33849. n / d.
  33850. <br/> The result has the sign of the divisor.
  33851. <br/> Examples:
  33852. <ul>
  33853. <li>mod(3.4, 2) = 1.4</li>
  33854. <li>mod(-3.4, 2) = 0.6</li>
  33855. <li>mod(-3.4, -2) = -1.4</li>
  33856. <li>mod(3.4, -2) = -0.6</li>
  33857. </ul>
  33858. If d == 0, result Is NaN
  33859. @param n
  33860. @param d
  33861. </member>
  33862. <member name="M:NPOI.SS.Formula.Functions.MathX.Acosh(System.Double)">
  33863. inverse hyperbolic cosine
  33864. @param d
  33865. </member>
  33866. <member name="M:NPOI.SS.Formula.Functions.MathX.Asinh(System.Double)">
  33867. inverse hyperbolic sine
  33868. @param d
  33869. </member>
  33870. <member name="M:NPOI.SS.Formula.Functions.MathX.Atanh(System.Double)">
  33871. inverse hyperbolic tangent
  33872. @param d
  33873. </member>
  33874. <member name="M:NPOI.SS.Formula.Functions.MathX.Cosh(System.Double)">
  33875. hyperbolic cosine
  33876. @param d
  33877. </member>
  33878. <member name="M:NPOI.SS.Formula.Functions.MathX.Sinh(System.Double)">
  33879. hyperbolic sine
  33880. @param d
  33881. </member>
  33882. <member name="M:NPOI.SS.Formula.Functions.MathX.Tanh(System.Double)">
  33883. hyperbolic tangent
  33884. @param d
  33885. </member>
  33886. <member name="M:NPOI.SS.Formula.Functions.MathX.SumProduct(System.Double[][])">
  33887. returns the sum of product of corresponding double value in each
  33888. subarray. It Is the responsibility of the caller to Ensure that
  33889. all the subarrays are of equal Length. If the subarrays are
  33890. not of equal Length, the return value can be Unpredictable.
  33891. @param arrays
  33892. </member>
  33893. <member name="M:NPOI.SS.Formula.Functions.MathX.Sumx2my2(System.Double[],System.Double[])">
  33894. returns the sum of difference of squares of corresponding double
  33895. value in each subarray: ie. sigma (xarr[i]^2-yarr[i]^2)
  33896. <br/>
  33897. It Is the responsibility of the caller
  33898. to Ensure that the two subarrays are of equal Length. If the
  33899. subarrays are not of equal Length, the return value can be
  33900. Unpredictable.
  33901. @param xarr
  33902. @param yarr
  33903. </member>
  33904. <member name="M:NPOI.SS.Formula.Functions.MathX.Sumx2py2(System.Double[],System.Double[])">
  33905. returns the sum of sum of squares of corresponding double
  33906. value in each subarray: ie. sigma (xarr[i]^2 + yarr[i]^2)
  33907. <br/>
  33908. It Is the responsibility of the caller
  33909. to Ensure that the two subarrays are of equal Length. If the
  33910. subarrays are not of equal Length, the return value can be
  33911. Unpredictable.
  33912. @param xarr
  33913. @param yarr
  33914. </member>
  33915. <member name="M:NPOI.SS.Formula.Functions.MathX.Sumxmy2(System.Double[],System.Double[])">
  33916. returns the sum of squares of difference of corresponding double
  33917. value in each subarray: ie. sigma ( (xarr[i]-yarr[i])^2 )
  33918. <br/>
  33919. It Is the responsibility of the caller
  33920. to Ensure that the two subarrays are of equal Length. If the
  33921. subarrays are not of equal Length, the return value can be
  33922. Unpredictable.
  33923. @param xarr
  33924. @param yarr
  33925. </member>
  33926. <member name="M:NPOI.SS.Formula.Functions.MathX.NChooseK(System.Int32,System.Int32)">
  33927. returns the total number of combinations possible when
  33928. k items are chosen out of total of n items. If the number
  33929. Is too large, loss of precision may occur (since returned
  33930. value Is double). If the returned value Is larger than
  33931. double.MAX_VALUE, double.POSITIVE_INFINITY Is returned.
  33932. If either of the parameters Is negative, double.NaN Is returned.
  33933. @param n
  33934. @param k
  33935. </member>
  33936. <member name="T:NPOI.SS.Formula.Functions.MinaMaxa">
  33937. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33938. </member>
  33939. <member name="T:NPOI.SS.Formula.Functions.Mod">
  33940. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33941. </member>
  33942. <member name="T:NPOI.SS.Formula.Functions.Mode">
  33943. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33944. </member>
  33945. <member name="M:NPOI.SS.Formula.Functions.Mode.Evaluate(System.Double[])">
  33946. if v is zero length or contains no duplicates, return value is
  33947. Double.NaN. Else returns the value that occurs most times and if there is
  33948. a tie, returns the first such value.
  33949. @param v
  33950. </member>
  33951. <member name="T:NPOI.SS.Formula.Functions.Na">
  33952. Implementation of Excel function NA()
  33953. @author Josh Micich
  33954. </member>
  33955. <member name="T:NPOI.SS.Formula.Functions.NotImplementedFunction">
  33956. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33957. This Is the default implementation of a Function class.
  33958. The default behaviour Is to return a non-standard ErrorEval
  33959. "ErrorEval.FUNCTION_NOT_IMPLEMENTED". This error should alert
  33960. the user that the formula contained a function that Is not
  33961. yet implemented.
  33962. </member>
  33963. <member name="T:NPOI.SS.Formula.Functions.Now">
  33964. Implementation of Excel NOW() Function
  33965. @author Frank Taffelt
  33966. </member>
  33967. <member name="T:NPOI.SS.Formula.Functions.Abs">
  33968. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33969. </member>
  33970. <member name="T:NPOI.SS.Formula.Functions.Acos">
  33971. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33972. </member>
  33973. <member name="T:NPOI.SS.Formula.Functions.Acosh">
  33974. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33975. Support for hyperbolic trig functions was Added as a part of
  33976. Java distribution only in JDK1.5. This class uses custom
  33977. naive implementation based on formulas at:
  33978. http://www.math2.org/math/trig/hyperbolics.htm
  33979. These formulas seem to agree with excel's implementation.
  33980. </member>
  33981. <member name="T:NPOI.SS.Formula.Functions.Asin">
  33982. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33983. </member>
  33984. <member name="T:NPOI.SS.Formula.Functions.Asinh">
  33985. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33986. Support for hyperbolic trig functions was Added as a part of
  33987. Java distribution only in JDK1.5. This class uses custom
  33988. naive implementation based on formulas at:
  33989. http://www.math2.org/math/trig/hyperbolics.htm
  33990. These formulas seem to agree with excel's implementation.
  33991. </member>
  33992. <member name="T:NPOI.SS.Formula.Functions.Atan">
  33993. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33994. </member>
  33995. <member name="T:NPOI.SS.Formula.Functions.Atan2">
  33996. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33997. </member>
  33998. <member name="T:NPOI.SS.Formula.Functions.Atanh">
  33999. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34000. Support for hyperbolic trig functions was Added as a part of
  34001. Java distribution only in JDK1.5. This class uses custom
  34002. naive implementation based on formulas at:
  34003. http://www.math2.org/math/trig/hyperbolics.htm
  34004. These formulas seem to agree with excel's implementation.
  34005. </member>
  34006. <member name="T:NPOI.SS.Formula.Functions.Cos">
  34007. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34008. </member>
  34009. <member name="T:NPOI.SS.Formula.Functions.Cosh">
  34010. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34011. </member>
  34012. <member name="T:NPOI.SS.Formula.Functions.Ln">
  34013. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34014. </member>
  34015. <member name="T:NPOI.SS.Formula.Functions.Log">
  34016. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34017. Log: LOG(number,[base])
  34018. </member>
  34019. <member name="T:NPOI.SS.Formula.Functions.Log10">
  34020. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34021. </member>
  34022. <member name="T:NPOI.SS.Formula.Functions.Pi">
  34023. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34024. </member>
  34025. <member name="M:NPOI.SS.Formula.Functions.Poisson.IsDefaultResult(System.Double,System.Double)">
  34026. This checks is x = 0 and the mean = 0.
  34027. Excel currently returns the value 1 where as the
  34028. maths common implementation will error.
  34029. @param x The number.
  34030. @param mean The mean.
  34031. @return If a default value should be returned.
  34032. </member>
  34033. <member name="F:NPOI.SS.Formula.Functions.Poisson.FACTORIALS">
  34034. All long-representable factorials
  34035. </member>
  34036. <member name="T:NPOI.SS.Formula.Functions.Rand">
  34037. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34038. </member>
  34039. <member name="T:NPOI.SS.Formula.Functions.Sin">
  34040. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34041. </member>
  34042. <member name="T:NPOI.SS.Formula.Functions.Sinh">
  34043. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34044. </member>
  34045. <member name="T:NPOI.SS.Formula.Functions.Sqrt">
  34046. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34047. </member>
  34048. <member name="T:NPOI.SS.Formula.Functions.Tan">
  34049. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34050. </member>
  34051. <member name="T:NPOI.SS.Formula.Functions.Tanh">
  34052. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34053. </member>
  34054. <member name="T:NPOI.SS.Formula.Functions.Odd">
  34055. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34056. </member>
  34057. <member name="T:NPOI.SS.Formula.Functions.Offset">
  34058. Implementation for Excel function OFFSet()<p/>
  34059. OFFSet returns an area reference that Is a specified number of rows and columns from a
  34060. reference cell or area.<p/>
  34061. <b>Syntax</b>:<br/>
  34062. <b>OFFSet</b>(<b>reference</b>, <b>rows</b>, <b>cols</b>, height, width)<p/>
  34063. <b>reference</b> Is the base reference.<br/>
  34064. <b>rows</b> Is the number of rows up or down from the base reference.<br/>
  34065. <b>cols</b> Is the number of columns left or right from the base reference.<br/>
  34066. <b>height</b> (default same height as base reference) Is the row Count for the returned area reference.<br/>
  34067. <b>width</b> (default same width as base reference) Is the column Count for the returned area reference.<br/>
  34068. @author Josh Micich
  34069. </member>
  34070. <member name="M:NPOI.SS.Formula.Functions.Offset.EvaluateIntArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  34071. OFFSet's numeric arguments (2..5) have similar Processing rules
  34072. </member>
  34073. <member name="M:NPOI.SS.Formula.Functions.Offset.ConvertDoubleToInt(System.Double)">
  34074. Fractional values are silently truncated by Excel.
  34075. Truncation Is toward negative infinity.
  34076. </member>
  34077. <member name="T:NPOI.SS.Formula.Functions.Offset.EvalEx">
  34078. Exceptions are used within this class to help simplify flow control when error conditions
  34079. are enCountered
  34080. </member>
  34081. <member name="T:NPOI.SS.Formula.Functions.Offset.LinearOffsetRange">
  34082. A one dimensional base + offset. Represents either a row range or a column range.
  34083. Two instances of this class toGether specify an area range.
  34084. </member>
  34085. <member name="M:NPOI.SS.Formula.Functions.Offset.LinearOffsetRange.NormaliseAndTranslate(System.Int32)">
  34086. Moves the range by the specified translation amount.<p/>
  34087. This method also 'normalises' the range: Excel specifies that the width and height
  34088. parameters (Length field here) cannot be negative. However, OFFSet() does produce
  34089. sensible results in these cases. That behavior Is replicated here. <p/>
  34090. @param translationAmount may be zero negative or positive
  34091. @return the equivalent <c>LinearOffsetRange</c> with a positive Length, moved by the
  34092. specified translationAmount.
  34093. </member>
  34094. <member name="T:NPOI.SS.Formula.Functions.Offset.BaseRef">
  34095. Encapsulates either an area or cell reference which may be 2d or 3d.
  34096. </member>
  34097. <member name="T:NPOI.SS.Formula.Functions.Pmt">
  34098. Implementation for the PMT() Excel function.<p/>
  34099. <b>Syntax:</b><br/>
  34100. <b>PMT</b>(<b>rate</b>, <b>nper</b>, <b>pv</b>, fv, type)<p/>
  34101. Returns the constant repayment amount required for a loan assuming a constant interest rate.<p/>
  34102. <b>rate</b> the loan interest rate.<br/>
  34103. <b>nper</b> the number of loan repayments.<br/>
  34104. <b>pv</b> the present value of the future payments (or principle).<br/>
  34105. <b>fv</b> the future value (default zero) surplus cash at the end of the loan lifetime.<br/>
  34106. <b>type</b> whether payments are due at the beginning(1) or end(0 - default) of each payment period.<br/>
  34107. </member>
  34108. <member name="T:NPOI.SS.Formula.Functions.Power">
  34109. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34110. </member>
  34111. <member name="T:NPOI.SS.Formula.Functions.Radians">
  34112. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34113. </member>
  34114. <member name="T:NPOI.SS.Formula.Functions.Rows">
  34115. Implementation for Excel ROWS function.
  34116. @author Josh Micich
  34117. </member>
  34118. <member name="T:NPOI.SS.Formula.Functions.StatsLib">
  34119. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34120. Library for common statistics functions
  34121. </member>
  34122. <member name="M:NPOI.SS.Formula.Functions.StatsLib.avedev(System.Double[])">
  34123. returns the mean of deviations from mean.
  34124. @param v
  34125. </member>
  34126. <member name="M:NPOI.SS.Formula.Functions.StatsLib.mode(System.Double[])">
  34127. if v Is zero Length or Contains no duplicates, return value
  34128. Is double.NaN. Else returns the value that occurs most times
  34129. and if there Is a tie, returns the first such value.
  34130. @param v
  34131. </member>
  34132. <member name="T:NPOI.SS.Formula.Functions.Subtotal">
  34133. Implementation for the Excel function SUBTOTAL<p>
  34134. <b>Syntax :</b> <br/>
  34135. SUBTOTAL ( <b>functionCode</b>, <b>ref1</b>, ref2 ... ) <br/>
  34136. <table border="1" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  34137. <tr><td><b>functionCode</b></td><td>(1-11) Selects the underlying aggregate function to be used (see table below)</td></tr>
  34138. <tr><td><b>ref1</b>, ref2 ...</td><td>Arguments to be passed to the underlying aggregate function</td></tr>
  34139. </table><br/>
  34140. </p>
  34141. <table border="1" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  34142. <tr><th>functionCode</th><th>Aggregate Function</th></tr>
  34143. <tr align='center'><td>1</td><td>AVERAGE</td></tr>
  34144. <tr align='center'><td>2</td><td>COUNT</td></tr>
  34145. <tr align='center'><td>3</td><td>COUNTA</td></tr>
  34146. <tr align='center'><td>4</td><td>MAX</td></tr>
  34147. <tr align='center'><td>5</td><td>MIN</td></tr>
  34148. <tr align='center'><td>6</td><td>PRODUCT</td></tr>
  34149. <tr align='center'><td>7</td><td>STDEV</td></tr>
  34150. <tr align='center'><td>8</td><td>STDEVP *</td></tr>
  34151. <tr align='center'><td>9</td><td>SUM</td></tr>
  34152. <tr align='center'><td>10</td><td>VAR *</td></tr>
  34153. <tr align='center'><td>11</td><td>VARP *</td></tr>
  34154. <tr align='center'><td>101-111</td><td>*</td></tr>
  34155. </table><br/>
  34156. * Not implemented in POI yet. Functions 101-111 are the same as functions 1-11 but with
  34157. the option 'ignore hidden values'.
  34158. <p/>
  34159. @author Paul Tomlin &lt; pault at bulk sms dot com &gt;
  34160. </member>
  34161. <member name="T:NPOI.SS.Formula.Functions.Sumif">
  34162. Implementation for the Excel function SUMIF<p>
  34163. Syntax : <br/>
  34164. SUMIF ( <b>range</b>, <b>criteria</b>, sum_range ) <br/>
  34165. <table border="0" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  34166. <tr><th>range</th><td>The range over which criteria is applied. Also used for addend values when the third parameter is not present</td></tr>
  34167. <tr><th>criteria</th><td>The value or expression used to filter rows from <b>range</b></td></tr>
  34168. <tr><th>sum_range</th><td>Locates the top-left corner of the corresponding range of addends - values to be added (after being selected by the criteria)</td></tr>
  34169. </table><br/>
  34170. </p>
  34171. @author Josh Micich
  34172. </member>
  34173. <member name="M:NPOI.SS.Formula.Functions.Sumif.CreateSumRange(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.AreaEval)">
  34174. @return a range of the same dimensions as aeRange using eval to define the top left corner.
  34175. @throws EvaluationException if eval is not a reference
  34176. </member>
  34177. <member name="M:NPOI.SS.Formula.Functions.Sumproduct.GetProductTerm(NPOI.SS.Formula.Eval.ValueEval,System.Boolean)">
  34178. Determines a <c>double</c> value for the specified <c>ValueEval</c>.
  34179. @param IsScalarProduct <c>false</c> for SUMPRODUCTs over area refs.
  34180. @throws EvalEx if <c>ve</c> represents an error value.
  34181. <p/>
  34182. Note - string values and empty cells are interpreted differently depending on
  34183. <c>isScalarProduct</c>. For scalar products, if any term Is blank or a string, the
  34184. error (#VALUE!) Is raised. For area (sum)products, if any term Is blank or a string, the
  34185. result Is zero.
  34186. </member>
  34187. <member name="T:NPOI.SS.Formula.Functions.XYNumericFunction">
  34188. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34189. </member>
  34190. <member name="M:NPOI.SS.Formula.Functions.XYNumericFunction.CreateAccumulator">
  34191. Constructs a new instance of the Accumulator used to calculated this function
  34192. </member>
  34193. <member name="T:NPOI.SS.Formula.Functions.Concatenate">
  34194. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34195. </member>
  34196. <member name="T:NPOI.SS.Formula.Functions.Exact">
  34197. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34198. </member>
  34199. <member name="T:NPOI.SS.Formula.Functions.LeftRight">
  34200. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34201. </member>
  34202. <member name="T:NPOI.SS.Formula.Functions.Len">
  34203. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34204. </member>
  34205. <member name="T:NPOI.SS.Formula.Functions.Lower">
  34206. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34207. </member>
  34208. <member name="T:NPOI.SS.Formula.Functions.Mid">
  34209. <summary>
  34210. An implementation of the MID function
  34211. MID returns a specific number of
  34212. Chars from a text string, starting at the specified position.
  34213. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org;
  34214. </summary>
  34215. </member>
  34216. <member name="T:NPOI.SS.Formula.Functions.Replace">
  34217. An implementation of the Replace function:
  34218. Replaces part of a text string based on the number of Chars
  34219. you specify, with another text string.
  34220. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org &gt;
  34221. </member>
  34222. <member name="M:NPOI.SS.Formula.Functions.Replace.EvaluateFunc(NPOI.SS.Formula.Eval.ValueEval[],System.Int32,System.Int32)">
  34223. Replaces part of a text string based on the number of Chars
  34224. you specify, with another text string.
  34225. @see org.apache.poi.hssf.record.formula.eval.Eval
  34226. </member>
  34227. <member name="T:NPOI.SS.Formula.Functions.Substitute">
  34228. An implementation of the SUBSTITUTE function:
  34229. Substitutes text in a text string with new text, some number of times.
  34230. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org &gt;
  34231. </member>
  34232. <member name="M:NPOI.SS.Formula.Functions.Substitute.EvaluateFunc(NPOI.SS.Formula.Eval.ValueEval[],System.Int32,System.Int32)">
  34233. Substitutes text in a text string with new text, some number of times.
  34234. @see org.apache.poi.hssf.record.formula.eval.Eval
  34235. </member>
  34236. <member name="T:NPOI.SS.Formula.Functions.Text">
  34237. An implementation of the TEXT function
  34238. TEXT returns a number value formatted with the given number formatting string.
  34239. This function is not a complete implementation of the Excel function, but
  34240. handles most of the common cases. All work is passed down to
  34241. {@link DataFormatter} to be done, as this works much the same as the
  34242. display focused work that that does.
  34243. </member>
  34244. <member name="T:NPOI.SS.Formula.Functions.Trim">
  34245. An implementation of the TRIM function:
  34246. Removes leading and trailing spaces from value if Evaluated operand
  34247. value Is string.
  34248. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org &gt;
  34249. </member>
  34250. <member name="T:NPOI.SS.Formula.Functions.Upper">
  34251. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34252. </member>
  34253. <member name="T:NPOI.SS.Formula.Functions.TimeFunc">
  34254. Implementation for the Excel function TIME
  34255. @author Steven Butler (sebutler @ gmail dot com)
  34256. Based on POI {@link DateFunc}
  34257. </member>
  34258. <member name="M:NPOI.SS.Formula.Functions.TimeFunc.Evaluate(System.Int32,System.Int32,System.Int32)">
  34259. Converts the supplied hours, minutes and seconds to an Excel time value.
  34260. @param ds array of 3 doubles Containing hours, minutes and seconds.
  34261. Non-integer inputs are tRuncated to an integer before further calculation
  34262. of the time value.
  34263. @return An Excel representation of a time of day.
  34264. If the time value represents more than a day, the days are Removed from
  34265. the result, leaving only the time of day component.
  34266. @throws NPOI.SS.Formula.Eval.EvaluationException
  34267. If any of the arguments are greater than 32767 or the hours
  34268. minutes and seconds when combined form a time value less than 0, the function
  34269. Evaluates to an error.
  34270. </member>
  34271. <member name="F:NPOI.SS.Formula.Functions.Value.MIN_DISTANCE_BETWEEN_THOUSANDS_SEPARATOR">
  34272. "1,0000" is valid, "1,00" is not
  34273. </member>
  34274. <member name="M:NPOI.SS.Formula.Functions.Value.ConvertTextToNumber(System.String)">
  34275. TODO see if the same functionality is needed in {@link OperandResolver#parseDouble(String)}
  34276. @return <code>null</code> if there is any problem converting the text
  34277. </member>
  34278. <member name="T:NPOI.SS.Formula.Functions.Var3or4ArgFunction">
  34279. Convenience base class for any function which must take three or four
  34280. arguments
  34281. @author Josh Micich
  34282. </member>
  34283. <member name="T:NPOI.SS.Formula.Functions.Vlookup">
  34284. Implementation of the VLOOKUP() function.<p/>
  34285. VLOOKUP Finds a row in a lookup table by the first column value and returns the value from another column.<br/>
  34286. <b>Syntax</b>:<br/>
  34287. <b>VLOOKUP</b>(<b>lookup_value</b>, <b>table_array</b>, <b>col_index_num</b>, range_lookup)<p/>
  34288. <b>lookup_value</b> The value to be found in the first column of the table array.<br/>
  34289. <b>table_array</b> An area reference for the lookup data. <br/>
  34290. <b>col_index_num</b> a 1 based index specifying which column value of the lookup data will be returned.<br/>
  34291. <b>range_lookup</b> If TRUE (default), VLOOKUP Finds the largest value less than or equal to
  34292. the lookup_value. If FALSE, only exact Matches will be considered<br/>
  34293. @author Josh Micich
  34294. </member>
  34295. <member name="M:NPOI.SS.Formula.Functions.Vlookup.CreateResultColumnVector(NPOI.SS.Formula.TwoDEval,System.Int32)">
  34296. Returns one column from an <c>AreaEval</c>
  34297. @(#VALUE!) if colIndex Is negative, (#REF!) if colIndex Is too high
  34298. </member>
  34299. <member name="T:NPOI.SS.Formula.Function.FunctionDataBuilder">
  34300. Temporarily collects <c>FunctionMetadata</c> instances for creation of a
  34301. <c>FunctionMetadataRegistry</c>.
  34302. @author Josh Micich
  34303. </member>
  34304. <member name="F:NPOI.SS.Formula.Function.FunctionDataBuilder._mutatingFunctionIndexes">
  34305. stores indexes of all functions with footnotes (i.e. whose definitions might Change)
  34306. </member>
  34307. <member name="T:NPOI.SS.Formula.Function.FunctionMetadata">
  34308. Holds information about Excel built-in functions.
  34309. @author Josh Micich
  34310. </member>
  34311. <member name="T:NPOI.SS.Formula.Function.FunctionMetadataReader">
  34312. Converts the text meta-data file into a <c>FunctionMetadataRegistry</c>
  34313. @author Josh Micich
  34314. </member>
  34315. <member name="F:NPOI.SS.Formula.Function.FunctionMetadataReader.ELLIPSIS">
  34316. plain ASCII text metadata file uses three dots for ellipsis
  34317. </member>
  34318. <member name="M:NPOI.SS.Formula.Function.FunctionMetadataReader.ValidateFunctionName(System.String)">
  34319. Makes sure that footnote digits from the original OOO document have not been accidentally
  34320. left behind
  34321. </member>
  34322. <member name="T:NPOI.SS.Formula.Function.FunctionMetadataRegistry">
  34323. Allows clients to Get <c>FunctionMetadata</c> instances for any built-in function of Excel.
  34324. @author Josh Micich
  34325. </member>
  34326. <member name="F:NPOI.SS.Formula.Function.FunctionMetadataRegistry.FUNCTION_NAME_IF">
  34327. The name of the IF function (i.e. "IF"). Extracted as a constant for clarity.
  34328. </member>
  34329. <member name="M:NPOI.SS.Formula.Function.FunctionMetadataRegistry.LookupIndexByName(System.String)">
  34330. Resolves a built-in function index.
  34331. @param name uppercase function name
  34332. @return a negative value if the function name is not found.
  34333. This typically occurs for external functions.
  34334. </member>
  34335. <member name="T:NPOI.SS.Formula.IEvaluationListener">
  34336. Tests can implement this class To track the internal working of the {@link WorkbookEvaluator}.<br/>
  34337. For POI internal testing use only
  34338. @author Josh Micich
  34339. </member>
  34340. <member name="M:NPOI.SS.Formula.IEvaluationListener.SortDependentCachedValues(NPOI.SS.Formula.ICacheEntry[])">
  34341. Internally, formula {@link ICacheEntry}s are stored in Sets which may Change ordering due
  34342. To seemingly trivial Changes. This method is provided To make the order of call-backs To
  34343. {@link #onClearDependentCachedValue(ICacheEntry, int)} more deterministic.
  34344. </member>
  34345. <member name="T:NPOI.SS.Formula.IStabilityClassifier">
  34346. Used to help optimise cell evaluation result caching by allowing applications to specify which
  34347. parts of a workbook are <em>final</em>.<br/>
  34348. The term <b>final</b> is introduced here to denote immutability or 'having constant definition'.
  34349. This classification refers to potential actions (on the evaluated workbook) by the evaluating
  34350. application. It does not refer to operations performed by the evaluator ({@link
  34351. WorkbookEvaluator}).<br/>
  34352. <br/>
  34353. <b>General guidelines</b>:
  34354. <ul>
  34355. <li>a plain value cell can be marked as 'final' if it will not be changed after the first call
  34356. to {@link WorkbookEvaluator#evaluate(EvaluationCell)}.
  34357. </li>
  34358. <li>a formula cell can be marked as 'final' if its formula will not be changed after the first
  34359. call to {@link WorkbookEvaluator#evaluate(EvaluationCell)}. This remains true even if changes
  34360. in dependent values may cause the evaluated value to change.</li>
  34361. <li>plain value cells should be marked as 'not final' if their plain value value may change.
  34362. </li>
  34363. <li>formula cells should be marked as 'not final' if their formula definition may change.</li>
  34364. <li>cells which may switch between plain value and formula should also be marked as 'not final'.
  34365. </li>
  34366. </ul>
  34367. <b>Notes</b>:
  34368. <ul>
  34369. <li>If none of the spreadsheet cells is expected to have its definition changed after evaluation
  34370. begins, every cell can be marked as 'final'. This is the most efficient / least resource
  34371. intensive option.</li>
  34372. <li>To retain freedom to change any cell definition at any time, an application may classify all
  34373. cells as 'not final'. This freedom comes at the expense of greater memory consumption.</li>
  34374. <li>For the purpose of these classifications, setting the cached formula result of a cell (for
  34375. example in {@link HSSFFormulaEvaluator#evaluateFormulaCell(org.apache.poi.ss.usermodel.Cell)})
  34376. does not constitute changing the definition of the cell.</li>
  34377. <li>Updating cells which have been classified as 'final' will cause the evaluator to behave
  34378. unpredictably (typically ignoring the update).</li>
  34379. </ul>
  34380. @author Josh Micich
  34381. </member>
  34382. <member name="F:NPOI.SS.Formula.IStabilityClassifier.TOTALLY_IMMUTABLE">
  34383. Convenience implementation for situations where all cell definitions remain fixed after
  34384. evaluation begins.
  34385. </member>
  34386. <member name="M:NPOI.SS.Formula.IStabilityClassifier.IsCellFinal(System.Int32,System.Int32,System.Int32)">
  34387. Checks if a cell's value(/formula) is fixed - in other words - not expected to be modified
  34388. between calls to the evaluator. (Note - this is an independent concept from whether a
  34389. formula cell's evaluated value may change during successive calls to the evaluator).
  34390. @param sheetIndex zero based index into workbook sheet list
  34391. @param rowIndex zero based row index of cell
  34392. @param columnIndex zero based column index of cell
  34393. @return <c>false</c> if the evaluating application may need to modify the specified
  34394. cell between calls to the evaluator.
  34395. </member>
  34396. <member name="T:NPOI.SS.Formula.LazyAreaEval">
  34397. Provides Lazy Evaluation to 3D Ranges
  34398. </member>
  34399. <member name="M:NPOI.SS.Formula.LazyAreaEval.IsSubTotal(System.Int32,System.Int32)">
  34400. @return whether cell at rowIndex and columnIndex is a subtotal
  34401. </member>
  34402. <member name="T:NPOI.SS.Formula.LazyRefEval">
  34403. Provides Lazy Evaluation to a 3D Reference
  34404. TODO Provide access to multiple sheets where present
  34405. </member>
  34406. <member name="T:NPOI.SS.Formula.OperandClassTransformer">
  34407. This class performs 'operand class' transformation. Non-base Tokens are classified into three
  34408. operand classes:
  34409. <ul>
  34410. <li>reference</li>
  34411. <li>value</li>
  34412. <li>array</li>
  34413. </ul>
  34414. <p/>
  34415. The operand class chosen for each Token depends on the formula type and the Token's place
  34416. in the formula. If POI Gets the operand class wrong, Excel <em>may</em> interpret the formula
  34417. incorrectly. This condition is typically manifested as a formula cell that displays as '#VALUE!',
  34418. but resolves correctly when the user presses F2, enter.<p/>
  34419. The logic implemented here was partially inspired by the description in
  34420. "OpenOffice.org's Documentation of the Microsoft Excel File Format". The model presented there
  34421. seems To be inconsistent with observed Excel behaviour (These differences have not been fully
  34422. investigated). The implementation in this class Has been heavily modified in order To satisfy
  34423. concrete examples of how Excel performs the same logic (see TestRVA).<p/>
  34424. Hopefully, as Additional important test cases are identified and Added To the test suite,
  34425. patterns might become more obvious in this code and allow for simplification.
  34426. @author Josh Micich
  34427. </member>
  34428. <member name="M:NPOI.SS.Formula.OperandClassTransformer.TransformFormula(NPOI.SS.Formula.ParseNode)">
  34429. Traverses the supplied formula parse tree, calling <c>Ptg.SetClass()</c> for each non-base
  34430. Token To Set its operand class.
  34431. </member>
  34432. <member name="M:NPOI.SS.Formula.OperandClassTransformer.TransformNode(NPOI.SS.Formula.ParseNode,System.Byte,System.Boolean)">
  34433. @param callerForceArrayFlag <c>true</c> if one of the current node's parents is a
  34434. function Ptg which Has been Changed from default 'V' To 'A' type (due To requirements on
  34435. the function return value).
  34436. </member>
  34437. <member name="T:NPOI.SS.Formula.OperationEvaluationContext">
  34438. Contains all the contextual information required to Evaluate an operation
  34439. within a formula
  34440. For POI internal use only
  34441. @author Josh Micich
  34442. </member>
  34443. <member name="M:NPOI.SS.Formula.OperationEvaluationContext.CreateExternSheetRefEvaluator(System.String,System.String)">
  34444. @return <code>null</code> if either workbook or sheet is not found
  34445. </member>
  34446. <member name="M:NPOI.SS.Formula.OperationEvaluationContext.GetDynamicReference(System.String,System.String,System.String,System.String,System.Boolean)">
  34447. Resolves a cell or area reference dynamically.
  34448. @param workbookName the name of the workbook Containing the reference. If <code>null</code>
  34449. the current workbook is assumed. Note - to Evaluate formulas which use multiple workbooks,
  34450. a {@link CollaboratingWorkbooksEnvironment} must be set up.
  34451. @param sheetName the name of the sheet Containing the reference. May be <code>null</code>
  34452. (when <c>workbookName</c> is also null) in which case the current workbook and sheet is
  34453. assumed.
  34454. @param refStrPart1 the single cell reference or first part of the area reference. Must not
  34455. be <code>null</code>.
  34456. @param refStrPart2 the second part of the area reference. For single cell references this
  34457. parameter must be <code>null</code>
  34458. @param isA1Style specifies the format for <c>refStrPart1</c> and <c>refStrPart2</c>.
  34459. Pass <c>true</c> for 'A1' style and <c>false</c> for 'R1C1' style.
  34460. TODO - currently POI only supports 'A1' reference style
  34461. @return a {@link RefEval} or {@link AreaEval}
  34462. </member>
  34463. <member name="T:NPOI.SS.Formula.OperationEvaluatorFactory">
  34464. This class Creates <c>OperationEval</c> instances To help evaluate <c>OperationPtg</c>
  34465. formula Tokens.
  34466. @author Josh Micich
  34467. </member>
  34468. <member name="M:NPOI.SS.Formula.OperationEvaluatorFactory.Evaluate(NPOI.SS.Formula.PTG.OperationPtg,NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  34469. returns the OperationEval concrete impl instance corresponding
  34470. to the supplied operationPtg
  34471. </member>
  34472. <member name="T:NPOI.SS.Formula.ParseNode">
  34473. Represents a syntactic element from a formula by encapsulating the corresponding <c>Ptg</c>
  34474. Token. Each <c>ParseNode</c> may have child <c>ParseNode</c>s in the case when the wrapped
  34475. <c>Ptg</c> is non-atomic.
  34476. @author Josh Micich
  34477. </member>
  34478. <member name="M:NPOI.SS.Formula.ParseNode.ToTokenArray(NPOI.SS.Formula.ParseNode)">
  34479. Collects the array of <c>Ptg</c> Tokens for the specified tree.
  34480. </member>
  34481. <member name="M:NPOI.SS.Formula.ParseNode.CollectIfPtgs(NPOI.SS.Formula.ParseNode.TokenCollector)">
  34482. The IF() function Gets marked up with two or three tAttr Tokens.
  34483. Similar logic will be required for CHOOSE() when it is supported
  34484. See excelfileformat.pdf sec 3.10.5 "tAttr (19H)
  34485. </member>
  34486. <member name="T:NPOI.SS.Formula.PlainCellCache">
  34487. @author Josh Micich
  34488. </member>
  34489. <member name="T:NPOI.SS.Formula.PlainValueCellCacheEntry">
  34490. Used for non-formula cells, primarily To keep track of the referencing (formula) cells.
  34491. @author Josh Micich
  34492. </member>
  34493. <member name="T:NPOI.SS.Formula.PTG.AbstractFunctionPtg">
  34494. This class provides the base functionality for Excel sheet functions
  34495. There are two kinds of function Ptgs - tFunc and tFuncVar
  34496. Therefore, this class will have ONLY two subclasses
  34497. @author Avik Sengupta
  34498. @author Andrew C. Oliver (acoliver at apache dot org)
  34499. </member>
  34500. <member name="T:NPOI.SS.Formula.PTG.OperationPtg">
  34501. defines a Ptg that is an operation instead of an operand
  34502. @author andy
  34503. </member>
  34504. <member name="M:NPOI.SS.Formula.PTG.OperationPtg.ToFormulaString(System.String[])">
  34505. returns a string representation of the operations
  34506. the Length of the input array should equal the number returned by
  34507. @see #GetNumberOfOperands
  34508. </member>
  34509. <member name="P:NPOI.SS.Formula.PTG.OperationPtg.NumberOfOperands">
  34510. The number of operands expected by the operations
  34511. </member>
  34512. <member name="F:NPOI.SS.Formula.PTG.AbstractFunctionPtg.FUNCTION_NAME_IF">
  34513. The name of the IF function (i.e. "IF"). Extracted as a constant for clarity.
  34514. </member>
  34515. <member name="F:NPOI.SS.Formula.PTG.AbstractFunctionPtg.FUNCTION_INDEX_EXTERNAL">
  34516. All external functions have function index 255
  34517. </member>
  34518. <member name="M:NPOI.SS.Formula.PTG.AbstractFunctionPtg.IsBuiltInFunctionName(System.String)">
  34519. Used to detect whether a function name found in a formula is one of the standard excel functions
  34520. The name matching is case insensitive.
  34521. @return <c>true</c> if the name specifies a standard worksheet function,
  34522. <c>false</c> if the name should be assumed to be an external function.
  34523. </member>
  34524. <member name="M:NPOI.SS.Formula.PTG.AbstractFunctionPtg.LookupIndex(System.String)">
  34525. Resolves internal function names into function indexes.
  34526. The name matching is case insensitive.
  34527. @return the standard worksheet function index if found, otherwise <c>FUNCTION_INDEX_EXTERNAL</c>
  34528. </member>
  34529. <member name="P:NPOI.SS.Formula.PTG.AbstractFunctionPtg.IsExternalFunction">
  34530. external functions Get some special Processing
  34531. @return <c>true</c> if this is an external function
  34532. </member>
  34533. <member name="T:NPOI.SS.Formula.PTG.AddPtg">
  34534. Addition operator PTG the "+" binomial operator. If you need more
  34535. explanation than that then well...We really can't help you here.
  34536. @author Andrew C. Oliver (acoliver@apache.org)
  34537. @author Jason Height (jheight at chariot dot net dot au)
  34538. </member>
  34539. <member name="T:NPOI.SS.Formula.PTG.ValueOperatorPtg">
  34540. Common baseclass of all value operators.
  34541. Subclasses include all Unary and binary operators except for the reference operators (IntersectionPtg, RangePtg, UnionPtg)
  34542. @author Josh Micich
  34543. </member>
  34544. <member name="P:NPOI.SS.Formula.PTG.ValueOperatorPtg.IsBaseToken">
  34545. All Operator <c>Ptg</c>s are base tokens (i.e. are not RVA classified)
  34546. </member>
  34547. <member name="M:NPOI.SS.Formula.PTG.AddPtg.ToFormulaString(System.String[])">
  34548. implementation of method from OperationsPtg
  34549. </member>
  34550. <member name="T:NPOI.SS.Formula.PTG.Area2DPtgBase">
  34551. Common superclass of 2-D area refs
  34552. </member>
  34553. <member name="T:NPOI.SS.Formula.PTG.Area3DPtg">
  34554. <p>Title: Area 3D Ptg - 3D reference (Sheet + Area)</p>
  34555. <p>Description: Defined an area in Extern Sheet. </p>
  34556. <p>REFERENCE: </p>
  34557. This is HSSF only, as it matches the HSSF file format way of
  34558. referring to the sheet by an extern index. The XSSF equivalent
  34559. is {@link Area3DPxg}
  34560. </member>
  34561. <member name="T:NPOI.SS.Formula.WorkbookDependentFormula">
  34562. Should be implemented by any {@link Ptg} subclass that needs a workbook To render its formula.
  34563. <br/>
  34564. For POI internal use only
  34565. @author Josh Micich
  34566. </member>
  34567. <member name="M:NPOI.SS.Formula.PTG.Area3DPtg.ToFormulaString(NPOI.SS.Formula.IFormulaRenderingWorkbook)">
  34568. @return text representation of this area reference that can be used in text
  34569. formulas. The sheet name will get properly delimited if required.
  34570. </member>
  34571. <member name="T:NPOI.SS.Formula.PTG.AreaErrPtg">
  34572. AreaErr - handles deleted cell area references.
  34573. @author Daniel Noll (daniel at nuix dot com dot au)
  34574. </member>
  34575. <member name="T:NPOI.SS.Formula.PTG.AreaNPtg">
  34576. Specifies a rectangular area of cells A1:A4 for instance.
  34577. @author Jason Height (jheight at chariot dot net dot au)
  34578. </member>
  34579. <member name="T:NPOI.SS.Formula.PTG.AreaPtg">
  34580. Specifies a rectangular area of cells A1:A4 for instance.
  34581. @author Jason Height (jheight at chariot dot net dot au)
  34582. </member>
  34583. <member name="T:NPOI.SS.Formula.PTG.ArrayPtg">
  34584. ArrayPtg - handles arrays
  34585. The ArrayPtg is a little weird, the size of the Ptg when parsing initially only
  34586. includes the Ptg sid and the reserved bytes. The next Ptg in the expression then follows.
  34587. It is only after the "size" of all the Ptgs is met, that the ArrayPtg data is actually
  34588. held after this. So Ptg.CreateParsedExpression keeps track of the number of
  34589. ArrayPtg elements and need to Parse the data upto the FORMULA record size.
  34590. @author Jason Height (jheight at chariot dot net dot au)
  34591. </member>
  34592. <member name="F:NPOI.SS.Formula.PTG.ArrayPtg.PLAIN_TOKEN_SIZE">
  34593. The size of the plain tArray token written within the standard formula tokens
  34594. (not including the data which comes after all formula tokens)
  34595. </member>
  34596. <member name="M:NPOI.SS.Formula.PTG.ArrayPtg.#ctor(System.Object[][])">
  34597. @param values2d array values arranged in rows
  34598. </member>
  34599. <member name="M:NPOI.SS.Formula.PTG.ArrayPtg.GetValueIndex(System.Int32,System.Int32)">
  34600. Note - (2D) array elements are stored column by column
  34601. @return the index into the internal 1D array for the specified column and row
  34602. </member>
  34603. <member name="P:NPOI.SS.Formula.PTG.ArrayPtg.Size">
  34604. This size includes the size of the array Ptg plus the Array Ptg Token value size
  34605. </member>
  34606. <member name="T:NPOI.SS.Formula.PTG.ArrayPtg.Initial">
  34607. Represents the initial plain tArray token (without the constant data that trails the whole
  34608. formula). Objects of this class are only temporary and cannot be used as {@link Ptg}s.
  34609. These temporary objects get converted to {@link ArrayPtg} by the
  34610. {@link #finishReading(LittleEndianInput)} method.
  34611. </member>
  34612. <member name="M:NPOI.SS.Formula.PTG.ArrayPtg.Initial.FinishReading(NPOI.Util.ILittleEndianInput)">
  34613. Read in the actual token (array) values. This occurs
  34614. AFTER the last Ptg in the expression.
  34615. See page 304-305 of Excel97-2007BinaryFileFormat(xls)Specification.pdf
  34616. </member>
  34617. <member name="T:NPOI.SS.Formula.PTG.AttrPtg">
  34618. "Special Attributes"
  34619. This seems to be a Misc Stuff and Junk record. One function it serves Is
  34620. in SUM functions (i.e. SUM(A1:A3) causes an area PTG then an ATTR with the SUM option Set)
  34621. @author andy
  34622. @author Jason Height (jheight at chariot dot net dot au)
  34623. </member>
  34624. <member name="T:NPOI.SS.Formula.PTG.ControlPtg">
  34625. Common baseclass for
  34626. tExp
  34627. tTbl
  34628. tParen
  34629. tNlr
  34630. tAttr
  34631. tSheet
  34632. tEndSheet
  34633. </member>
  34634. <member name="F:NPOI.SS.Formula.PTG.AttrPtg._jumpTable">
  34635. only used for tAttrChoose: table of offsets to starts of args
  34636. </member>
  34637. <member name="F:NPOI.SS.Formula.PTG.AttrPtg._chooseFuncOffset">
  34638. only used for tAttrChoose: offset to the tFuncVar for CHOOSE()
  34639. </member>
  34640. <member name="M:NPOI.SS.Formula.PTG.AttrPtg.CreateSpace(NPOI.SS.Formula.PTG.AttrPtg.SpaceType,System.Int32)">
  34641. <summary>
  34642. Creates the space.
  34643. </summary>
  34644. <param name="type">a constant from SpaceType</param>
  34645. <param name="count">The count.</param>
  34646. </member>
  34647. <member name="M:NPOI.SS.Formula.PTG.AttrPtg.CreateIf(System.Int32)">
  34648. <summary>
  34649. Creates if.
  34650. </summary>
  34651. <param name="dist">distance (in bytes) to start of either
  34652. tFuncVar(IF) token (when false parameter is not present).</param>
  34653. </member>
  34654. <member name="M:NPOI.SS.Formula.PTG.AttrPtg.CreateSkip(System.Int32)">
  34655. <summary>
  34656. Creates the skip.
  34657. </summary>
  34658. <param name="dist">distance (in bytes) to position behind tFuncVar(IF) token (minus 1).</param>
  34659. </member>
  34660. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.SpaceBefore">
  34661. 00H = Spaces before the next token (not allowed before tParen token)
  34662. </member>
  34663. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.CrBefore">
  34664. 01H = Carriage returns before the next token (not allowed before tParen token)
  34665. </member>
  34666. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.SpaceBeforeOpenParen">
  34667. 02H = Spaces before opening parenthesis (only allowed before tParen token)
  34668. </member>
  34669. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.CrBeforeOpenParen">
  34670. 03H = Carriage returns before opening parenthesis (only allowed before tParen token)
  34671. </member>
  34672. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.SpaceBeforeCloseParen">
  34673. 04H = Spaces before closing parenthesis (only allowed before tParen, tFunc, and tFuncVar tokens)
  34674. </member>
  34675. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.CrBeforeCloseParen">
  34676. 05H = Carriage returns before closing parenthesis (only allowed before tParen, tFunc, and tFuncVar tokens)
  34677. </member>
  34678. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.SpaceAfterEquality">
  34679. 06H = Spaces following the equality sign (only in macro sheets)
  34680. </member>
  34681. <member name="T:NPOI.SS.Formula.PTG.BoolPtg">
  34682. bool (bool)
  34683. Stores a (java) bool value in a formula.
  34684. @author Paul Krause (pkrause at soundbite dot com)
  34685. @author Andrew C. Oliver (acoliver at apache dot org)
  34686. @author Jason Height (jheight at chariot dot net dot au)
  34687. </member>
  34688. <member name="T:NPOI.SS.Formula.PTG.ScalarConstantPtg">
  34689. @author Josh Micich
  34690. </member>
  34691. <member name="T:NPOI.SS.Formula.PTG.ConcatPtg">
  34692. @author andy
  34693. @author Jason Height (jheight at chariot dot net dot au)
  34694. </member>
  34695. <member name="T:NPOI.SS.Formula.PTG.DeletedArea3DPtg">
  34696. Title: Deleted Area 3D Ptg - 3D referecnce (Sheet + Area)
  34697. Description: Defined a area in Extern Sheet.
  34698. REFERENCE:
  34699. @author Patrick Luby
  34700. @version 1.0-pre
  34701. </member>
  34702. <member name="T:NPOI.SS.Formula.PTG.DeletedRef3DPtg">
  34703. Title: Deleted Reference 3D Ptg
  34704. Description: Defined a cell in extern sheet.
  34705. REFERENCE:
  34706. @author Patrick Luby
  34707. @version 1.0-pre
  34708. </member>
  34709. <member name="M:NPOI.SS.Formula.PTG.DeletedRef3DPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  34710. Creates new DeletedRef3DPtg
  34711. </member>
  34712. <member name="T:NPOI.SS.Formula.PTG.DividePtg">
  34713. This PTG implements the standard binomial divide "/"
  34714. @author Andrew C. Oliver acoliver at apache dot org
  34715. @author Jason Height (jheight at chariot dot net dot au)
  34716. </member>
  34717. <member name="T:NPOI.SS.Formula.PTG.EqualPtg">
  34718. @author andy
  34719. </member>
  34720. <member name="T:NPOI.SS.Formula.PTG.ErrPtg">
  34721. @author Daniel Noll (daniel at nuix dot com dot au)
  34722. </member>
  34723. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.NULL_INTERSECTION">
  34724. <b>#NULL!</b> - Intersection of two cell ranges is empty
  34725. </member>
  34726. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.DIV_ZERO">
  34727. <b>#DIV/0!</b> - Division by zero
  34728. </member>
  34729. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.VALUE_INVALID">
  34730. <b>#VALUE!</b> - Wrong type of operand
  34731. </member>
  34732. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.REF_INVALID">
  34733. <b>#REF!</b> - Illegal or deleted cell reference
  34734. </member>
  34735. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.NAME_INVALID">
  34736. <b>#NAME?</b> - Wrong function or range name
  34737. </member>
  34738. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.NUM_ERROR">
  34739. <b>#NUM!</b> - Value range overflow
  34740. </member>
  34741. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.N_A">
  34742. <b>#N/A</b> - Argument or function not available
  34743. </member>
  34744. <member name="M:NPOI.SS.Formula.PTG.ErrPtg.#ctor(System.Int32)">
  34745. Creates new ErrPtg
  34746. </member>
  34747. <member name="T:NPOI.SS.Formula.PTG.ExpPtg">
  34748. @author andy
  34749. @author Jason Height (jheight at chariot dot net dot au)
  34750. @author dmui (save existing implementation)
  34751. </member>
  34752. <member name="T:NPOI.SS.Formula.FormulaShifter">
  34753. @author Josh Micich
  34754. </member>
  34755. <member name="F:NPOI.SS.Formula.FormulaShifter._externSheetIndex">
  34756. Extern sheet index of sheet where moving is occurring
  34757. </member>
  34758. <member name="F:NPOI.SS.Formula.FormulaShifter._sheetName">
  34759. Sheet name of the sheet where moving is occurring,
  34760. used for updating XSSF style 3D references on row shifts.
  34761. </member>
  34762. <member name="M:NPOI.SS.Formula.FormulaShifter.#ctor(System.Int32,System.String,System.Int32,System.Int32,System.Int32)">
  34763. Create an instance for Shifting row.
  34764. For example, this will be called on {@link NPOI.HSSF.UserModel.HSSFSheet#ShiftRows(int, int, int)} }
  34765. </member>
  34766. <member name="M:NPOI.SS.Formula.FormulaShifter.#ctor(System.Int32,System.Int32)">
  34767. Create an instance for shifting sheets.
  34768. For example, this will be called on {@link org.apache.poi.hssf.usermodel.HSSFWorkbook#setSheetOrder(String, int)}
  34769. </member>
  34770. <member name="M:NPOI.SS.Formula.FormulaShifter.AdjustFormula(NPOI.SS.Formula.PTG.Ptg[],System.Int32)">
  34771. @param ptgs - if necessary, will get modified by this method
  34772. @param currentExternSheetIx - the extern sheet index of the sheet that contains the formula being adjusted
  34773. @return <c>true</c> if a change was made to the formula tokens
  34774. </member>
  34775. <member name="M:NPOI.SS.Formula.FormulaShifter.AdjustPtgDueToRowMove(NPOI.SS.Formula.PTG.Ptg,System.Int32)">
  34776. @return <c>true</c> if this Ptg needed to be changed
  34777. </member>
  34778. <member name="T:NPOI.SS.Formula.PTG.FuncPtg">
  34779. @author aviks
  34780. @author Jason Height (jheight at chariot dot net dot au)
  34781. @author Danny Mui (dmui at apache dot org) (Leftover handling)
  34782. </member>
  34783. <member name="T:NPOI.SS.Formula.PTG.FuncVarPtg">
  34784. @author Jason Height (jheight at chariot dot net dot au)
  34785. </member>
  34786. <member name="F:NPOI.SS.Formula.PTG.FuncVarPtg.SUM">
  34787. Single instance of this token for 'sum() taking a single argument'
  34788. </member>
  34789. <member name="M:NPOI.SS.Formula.PTG.FuncVarPtg.Create(NPOI.Util.ILittleEndianInput)">
  34790. Creates new function pointer from a byte array
  34791. usually called while reading an excel file.
  34792. </member>
  34793. <member name="M:NPOI.SS.Formula.PTG.FuncVarPtg.Create(System.String,System.Int32)">
  34794. Create a function ptg from a string tokenised by the parser
  34795. </member>
  34796. <member name="T:NPOI.SS.Formula.PTG.GreaterEqualPtg">
  34797. PTG class to implement greater or equal to
  34798. @author fred at stsci dot edu
  34799. </member>
  34800. <member name="T:NPOI.SS.Formula.PTG.GreaterThanPtg">
  34801. Greater than operator PTG ">"
  34802. @author Cameron Riley (criley at ekmail.com)
  34803. </member>
  34804. <member name="M:NPOI.SS.Formula.PTG.GreaterThanPtg.ToFormulaString(System.String[])">
  34805. Implementation of method from OperationsPtg
  34806. @param operands a String array of operands
  34807. @return String the Formula as a String
  34808. </member>
  34809. <member name="P:NPOI.SS.Formula.PTG.GreaterThanPtg.NumberOfOperands">
  34810. Get the number of operands for the Less than operator
  34811. @return int the number of operands
  34812. </member>
  34813. <member name="T:NPOI.SS.Formula.PTG.IntersectionPtg">
  34814. @author Daniel Noll (daniel at nuix dot com dot au)
  34815. </member>
  34816. <member name="M:NPOI.SS.Formula.PTG.IntersectionPtg.ToFormulaString">
  34817. Implementation of method from Ptg
  34818. </member>
  34819. <member name="M:NPOI.SS.Formula.PTG.IntersectionPtg.ToFormulaString(System.String[])">
  34820. implementation of method from OperationsPtg
  34821. </member>
  34822. <member name="T:NPOI.SS.Formula.PTG.IntPtg">
  34823. Integer (unsigned short integer)
  34824. Stores an Unsigned short value (java int) in a formula
  34825. @author Andrew C. Oliver (acoliver at apache dot org)
  34826. @author Jason Height (jheight at chariot dot net dot au)
  34827. </member>
  34828. <member name="M:NPOI.SS.Formula.PTG.IntPtg.IsInRange(System.Int32)">
  34829. Excel represents integers 0..65535 with the tInt token.
  34830. @return <c>true</c> if the specified value is within the range of values
  34831. <c>IntPtg</c> can represent.
  34832. </member>
  34833. <member name="T:NPOI.SS.Formula.PTG.LessEqualPtg">
  34834. Ptg class to implement less than or equal
  34835. @author fred at stsci dot edu
  34836. </member>
  34837. <member name="T:NPOI.SS.Formula.PTG.LessThanPtg">
  34838. Less than operator PTG "&lt;". The SID is taken from the
  34839. Openoffice.orgs Documentation of the Excel File Format,
  34840. Table 3.5.7
  34841. @author Cameron Riley (criley at ekmail.com)
  34842. </member>
  34843. <member name="F:NPOI.SS.Formula.PTG.LessThanPtg.sid">
  34844. the sid for the less than operator as hex
  34845. </member>
  34846. <member name="F:NPOI.SS.Formula.PTG.LessThanPtg.LESSTHAN">
  34847. identifier for LESS THAN char
  34848. </member>
  34849. <member name="M:NPOI.SS.Formula.PTG.LessThanPtg.ToFormulaString(System.String[])">
  34850. Implementation of method from OperationsPtg
  34851. @param operands a String array of operands
  34852. @return String the Formula as a String
  34853. </member>
  34854. <member name="P:NPOI.SS.Formula.PTG.LessThanPtg.NumberOfOperands">
  34855. Get the number of operands for the Less than operator
  34856. @return int the number of operands
  34857. </member>
  34858. <member name="T:NPOI.SS.Formula.PTG.MemAreaPtg">
  34859. @author Daniel Noll (daniel at nuix dot com dot au)
  34860. </member>
  34861. <member name="M:NPOI.SS.Formula.PTG.MemAreaPtg.#ctor(System.Int32)">
  34862. Creates new MemAreaPtg
  34863. </member>
  34864. <member name="T:NPOI.SS.Formula.PTG.MemErrPtg">
  34865. @author andy
  34866. @author Jason Height (jheight at chariot dot net dot au)
  34867. @author Daniel Noll (daniel at nuix dot com dot au)
  34868. </member>
  34869. <member name="M:NPOI.SS.Formula.PTG.MemErrPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  34870. Creates new MemErrPtg
  34871. </member>
  34872. <member name="T:NPOI.SS.Formula.PTG.MemFuncPtg">
  34873. @author Glen Stampoultzis (glens at apache.org)
  34874. </member>
  34875. <member name="M:NPOI.SS.Formula.PTG.MemFuncPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  34876. Creates new function pointer from a byte array
  34877. usually called while Reading an excel file.
  34878. </member>
  34879. <member name="T:NPOI.SS.Formula.PTG.MissingArgPtg">
  34880. Missing Function Arguments
  34881. Avik Sengupta &lt;avik at apache.org&gt;
  34882. @author Jason Height (jheight at chariot dot net dot au)
  34883. </member>
  34884. <member name="T:NPOI.SS.Formula.PTG.MultiplyPtg">
  34885. Implements the standard mathmatical multiplication - *
  34886. @author Andrew C. Oliver (acoliver at apache dot org)
  34887. @author Jason Height (jheight at chariot dot net dot au)
  34888. </member>
  34889. <member name="T:NPOI.SS.Formula.PTG.NamePtg">
  34890. @author andy
  34891. @author Jason Height (jheight at chariot dot net dot au)
  34892. </member>
  34893. <member name="F:NPOI.SS.Formula.PTG.NamePtg.field_1_label_index">
  34894. one-based index to defined name record
  34895. </member>
  34896. <member name="M:NPOI.SS.Formula.PTG.NamePtg.#ctor(System.Int32)">
  34897. @param nameIndex zero-based index to name within workbook
  34898. </member>
  34899. <member name="M:NPOI.SS.Formula.PTG.NamePtg.#ctor(NPOI.Util.ILittleEndianInput)">
  34900. Creates new NamePtg
  34901. </member>
  34902. <member name="P:NPOI.SS.Formula.PTG.NamePtg.Index">
  34903. @return zero based index to a defined name record in the LinkTable
  34904. </member>
  34905. <member name="T:NPOI.SS.Formula.PTG.NameXPtg">
  34906. A Name, be that a Named Range or a Function / User Defined
  34907. Function, addressed in the HSSF External Sheet style.
  34908. This is HSSF only, as it matches the HSSF file format way of
  34909. referring to the sheet by an extern index. The XSSF equivalent
  34910. is {@link NameXPxg}
  34911. </member>
  34912. <member name="F:NPOI.SS.Formula.PTG.NameXPtg._sheetRefIndex">
  34913. index to REF entry in externsheet record
  34914. </member>
  34915. <member name="F:NPOI.SS.Formula.PTG.NameXPtg._nameNumber">
  34916. index to defined name or externname table(1 based)
  34917. </member>
  34918. <member name="F:NPOI.SS.Formula.PTG.NameXPtg._reserved">
  34919. reserved must be 0
  34920. </member>
  34921. <member name="M:NPOI.SS.Formula.PTG.NameXPtg.#ctor(System.Int32,System.Int32)">
  34922. @param sheetRefIndex index to REF entry in externsheet record
  34923. @param nameIndex index to defined name or externname table
  34924. </member>
  34925. <member name="T:NPOI.SS.Formula.PTG.NotEqualPtg">
  34926. Ptg class to implement not equal
  34927. @author fred at stsci dot edu
  34928. </member>
  34929. <member name="T:NPOI.SS.Formula.PTG.NumberPtg">
  34930. Number
  34931. Stores a floating point value in a formula
  34932. value stored in a 8 byte field using IEEE notation
  34933. @author Avik Sengupta
  34934. @author Jason Height (jheight at chariot dot net dot au)
  34935. </member>
  34936. <member name="M:NPOI.SS.Formula.PTG.NumberPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  34937. Create a NumberPtg from a byte array Read from disk
  34938. </member>
  34939. <member name="M:NPOI.SS.Formula.PTG.NumberPtg.#ctor(System.String)">
  34940. Create a NumberPtg from a string representation of the number
  34941. Number format is not checked, it is expected to be validated in the parser
  34942. that calls this method.
  34943. @param value : String representation of a floating point number
  34944. </member>
  34945. <member name="T:NPOI.SS.Formula.PTG.ParenthesisPtg">
  34946. While formula tokens are stored in RPN order and thus do not need parenthesis for
  34947. precedence reasons, Parenthesis tokens ARE written to Ensure that user entered
  34948. parenthesis are Displayed as-is on Reading back
  34949. Avik Sengupta &lt;lists@aviksengupta.com&gt;
  34950. Andrew C. Oliver (acoliver at apache dot org)
  34951. @author Jason Height (jheight at chariot dot net dot au)
  34952. </member>
  34953. <member name="T:NPOI.SS.Formula.PTG.PercentPtg">
  34954. Percent PTG.
  34955. @author Daniel Noll (daniel at nuix.com.au)
  34956. </member>
  34957. <member name="T:NPOI.SS.Formula.PTG.PowerPtg">
  34958. @author andy
  34959. @author Jason Height (jheight at chariot dot net dot au)
  34960. </member>
  34961. <member name="T:NPOI.SS.Formula.PTG.RangePtg">
  34962. @author Daniel Noll (daniel at nuix dot com dot au)
  34963. </member>
  34964. <member name="M:NPOI.SS.Formula.PTG.RangePtg.ToFormulaString(System.String[])">
  34965. implementation of method from OperationsPtg
  34966. </member>
  34967. <member name="T:NPOI.SS.Formula.PTG.Ref2DPtgBase">
  34968. @author Josh Micich
  34969. </member>
  34970. <member name="M:NPOI.SS.Formula.PTG.Ref2DPtgBase.#ctor(System.String)">
  34971. Takes in a String representation of a cell reference and fills out the
  34972. numeric fields.
  34973. </member>
  34974. <member name="T:NPOI.SS.Formula.PTG.Ref3DPtg">
  34975. Title: Reference 3D Ptg
  34976. Description: Defined a cell in extern sheet.
  34977. REFERENCE:
  34978. @author Libin Roman (Vista Portal LDT. Developer)
  34979. @author Jason Height (jheight at chariot dot net dot au)
  34980. @version 1.0-pre
  34981. </member>
  34982. <member name="F:NPOI.SS.Formula.PTG.Ref3DPtg.rowRelative">
  34983. Field 2
  34984. - lower 8 bits is the zero based Unsigned byte column index
  34985. - bit 16 - IsRowRelative
  34986. - bit 15 - IsColumnRelative
  34987. </member>
  34988. <member name="M:NPOI.SS.Formula.PTG.Ref3DPtg.#ctor">
  34989. Creates new AreaPtg
  34990. </member>
  34991. <member name="M:NPOI.SS.Formula.PTG.Ref3DPtg.ToFormulaString(NPOI.SS.Formula.IFormulaRenderingWorkbook)">
  34992. @return text representation of this cell reference that can be used in text
  34993. formulas. The sheet name will Get properly delimited if required.
  34994. </member>
  34995. <member name="T:NPOI.SS.Formula.PTG.RefErrorPtg">
  34996. RefError - handles deleted cell reference
  34997. @author Jason Height (jheight at chariot dot net dot au)
  34998. </member>
  34999. <member name="T:NPOI.SS.Formula.PTG.RefNPtg">
  35000. RefNPtg
  35001. @author Jason Height (jheight at apache dot com)
  35002. </member>
  35003. <member name="M:NPOI.SS.Formula.PTG.RefNPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  35004. Creates new ValueReferencePtg
  35005. </member>
  35006. <member name="T:NPOI.SS.Formula.PTG.RefPtg">
  35007. ReferencePtg - handles references (such as A1, A2, IA4)
  35008. @author Andrew C. Oliver (acoliver@apache.org)
  35009. @author Jason Height (jheight at chariot dot net dot au)
  35010. </member>
  35011. <member name="M:NPOI.SS.Formula.PTG.RefPtg.#ctor(System.String)">
  35012. Takes in a String representation of a cell reference and Fills out the
  35013. numeric fields.
  35014. </member>
  35015. <member name="T:NPOI.SS.Formula.PTG.StringPtg">
  35016. String Stores a String value in a formula value stored in the format
  35017. &lt;Length 2 bytes&gt;char[]
  35018. @author Werner Froidevaux
  35019. @author Jason Height (jheight at chariot dot net dot au)
  35020. @author Bernard Chesnoy
  35021. </member>
  35022. <member name="F:NPOI.SS.Formula.PTG.StringPtg.FORMULA_DELIMITER">
  35023. the Char (")used in formulas to delimit string literals
  35024. </member>
  35025. <member name="F:NPOI.SS.Formula.PTG.StringPtg.field_1_Length">
  35026. NOTE: OO doc says 16bit Length, but BiffViewer says 8 Book says something
  35027. totally different, so don't look there!
  35028. </member>
  35029. <member name="M:NPOI.SS.Formula.PTG.StringPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  35030. Create a StringPtg from a stream
  35031. </member>
  35032. <member name="M:NPOI.SS.Formula.PTG.StringPtg.#ctor(System.String)">
  35033. Create a StringPtg from a string representation of the number Number
  35034. format Is not Checked, it Is expected to be Validated in the Parser that
  35035. calls this method.
  35036. @param value :
  35037. String representation of a floating point number
  35038. </member>
  35039. <member name="T:NPOI.SS.Formula.PTG.SubtractPtg">
  35040. @author andy
  35041. @author Jason Height (jheight at chariot dot net dot au)
  35042. </member>
  35043. <member name="T:NPOI.SS.Formula.PTG.TblPtg">
  35044. This ptg indicates a data table.
  35045. It only occurs in a FORMULA record, never in an
  35046. ARRAY or NAME record. When ptgTbl occurs in a
  35047. formula, it is the only token in the formula.
  35048. This indicates that the cell containing the
  35049. formula is an interior cell in a data table;
  35050. the table description is found in a TABLE
  35051. record. Rows and columns which contain input
  35052. values to be substituted in the table do
  35053. not contain ptgTbl.
  35054. See page 811 of the june 08 binary docs.
  35055. </member>
  35056. <member name="F:NPOI.SS.Formula.PTG.TblPtg.field_1_first_row">
  35057. The row number of the upper left corner
  35058. </member>
  35059. <member name="F:NPOI.SS.Formula.PTG.TblPtg.field_2_first_col">
  35060. The column number of the upper left corner
  35061. </member>
  35062. <member name="T:NPOI.SS.Formula.PTG.UnaryMinusPtg">
  35063. Unary Plus operator
  35064. does not have any effect on the operand
  35065. @author Avik Sengupta
  35066. </member>
  35067. <member name="M:NPOI.SS.Formula.PTG.UnaryMinusPtg.ToFormulaString(System.String[])">
  35068. implementation of method from OperationsPtg
  35069. </member>
  35070. <member name="T:NPOI.SS.Formula.PTG.UnaryPlusPtg">
  35071. Unary Plus operator
  35072. does not have any effect on the operand
  35073. @author Avik Sengupta
  35074. </member>
  35075. <member name="M:NPOI.SS.Formula.PTG.UnaryPlusPtg.ToFormulaString(System.String[])">
  35076. implementation of method from OperationsPtg
  35077. </member>
  35078. <member name="T:NPOI.SS.Formula.PTG.UnionPtg">
  35079. @author Glen Stampoultzis (glens at apache.org)
  35080. </member>
  35081. <member name="M:NPOI.SS.Formula.PTG.UnionPtg.ToFormulaString(System.String[])">
  35082. implementation of method from OperationsPtg
  35083. </member>
  35084. <member name="T:NPOI.SS.Formula.PTG.UnknownPtg">
  35085. @author andy
  35086. @author Jason Height (jheight at chariot dot net dot au)
  35087. </member>
  35088. <member name="M:NPOI.SS.Formula.PTG.UnknownPtg.#ctor">
  35089. Creates new UnknownPtg
  35090. </member>
  35091. <member name="T:NPOI.SS.Formula.SheetNameFormatter">
  35092. Formats sheet names for use in formula expressions.
  35093. @author Josh Micich
  35094. </member>
  35095. <member name="M:NPOI.SS.Formula.SheetNameFormatter.Format(System.String)">
  35096. Used to format sheet names as they would appear in cell formula expressions.
  35097. @return the sheet name UnChanged if there is no need for delimiting. Otherwise the sheet
  35098. name is enclosed in single quotes ('). Any single quotes which were already present in the
  35099. sheet name will be converted to double single quotes ('').
  35100. </member>
  35101. <member name="M:NPOI.SS.Formula.SheetNameFormatter.AppendFormat(System.Text.StringBuilder,System.String)">
  35102. Convenience method for when a StringBuilder is already available
  35103. @param out - sheet name will be Appended here possibly with delimiting quotes
  35104. </member>
  35105. <member name="M:NPOI.SS.Formula.SheetNameFormatter.IsSpecialChar(System.Char)">
  35106. @return <c>true</c> if the presence of the specified Char in a sheet name would
  35107. require the sheet name to be delimited in formulas. This includes every non-alphanumeric
  35108. Char besides Underscore '_'.
  35109. </member>
  35110. <member name="M:NPOI.SS.Formula.SheetNameFormatter.CellReferenceIsWithinRange(System.String,System.String)">
  35111. Used to decide whether sheet names like 'AB123' need delimiting due to the fact that they
  35112. look like cell references.
  35113. <p/>
  35114. This code is currently being used for translating formulas represented with <code>Ptg</code>
  35115. tokens into human readable text form. In formula expressions, a sheet name always has a
  35116. trailing '!' so there is little chance for ambiguity. It doesn't matter too much what this
  35117. method returns but it is worth noting the likely consumers of these formula text strings:
  35118. <ol>
  35119. <li>POI's own formula parser</li>
  35120. <li>Visual reading by human</li>
  35121. <li>VBA automation entry into Excel cell contents e.g. ActiveCell.Formula = "=c64!A1"</li>
  35122. <li>Manual entry into Excel cell contents</li>
  35123. <li>Some third party formula parser</li>
  35124. </ol>
  35125. At the time of writing, POI's formula parser tolerates cell-like sheet names in formulas
  35126. with or without delimiters. The same goes for Excel(2007), both manual and automated entry.
  35127. <p/>
  35128. For better or worse this implementation attempts to replicate Excel's formula renderer.
  35129. Excel uses range checking on the apparent 'row' and 'column' components. Note however that
  35130. the maximum sheet size varies across versions.
  35131. @see org.apache.poi.hssf.util.CellReference
  35132. </member>
  35133. <member name="M:NPOI.SS.Formula.SheetNameFormatter.NameLooksLikePlainCellReference(System.String)">
  35134. Note - this method assumes the specified rawSheetName has only letters and digits. It
  35135. cannot be used to match absolute or range references (using the dollar or colon char).
  35136. Some notable cases:
  35137. <blockquote><table border="0" cellpAdding="1" cellspacing="0"
  35138. summary="Notable cases.">
  35139. <tr><th>Input </th><th>Result </th><th>Comments</th></tr>
  35140. <tr><td>"A1" </td><td>true</td><td> </td></tr>
  35141. <tr><td>"a111" </td><td>true</td><td> </td></tr>
  35142. <tr><td>"AA" </td><td>false</td><td> </td></tr>
  35143. <tr><td>"aa1" </td><td>true</td><td> </td></tr>
  35144. <tr><td>"A1A" </td><td>false</td><td> </td></tr>
  35145. <tr><td>"A1A1" </td><td>false</td><td> </td></tr>
  35146. <tr><td>"A$1:$C$20" </td><td>false</td><td>Not a plain cell reference</td></tr>
  35147. <tr><td>"SALES20080101" </td><td>true</td>
  35148. <td>Still needs delimiting even though well out of range</td></tr>
  35149. </table></blockquote>
  35150. @return <c>true</c> if there is any possible ambiguity that the specified rawSheetName
  35151. could be interpreted as a valid cell name.
  35152. </member>
  35153. <member name="T:NPOI.SS.Formula.SheetRefEvaluator">
  35154. @author Josh Micich
  35155. </member>
  35156. <member name="M:NPOI.SS.Formula.SheetRefEvaluator.IsSubTotal(System.Int32,System.Int32)">
  35157. @return whether cell at rowIndex and columnIndex is a subtotal
  35158. @see org.apache.poi.ss.formula.functions.Subtotal
  35159. </member>
  35160. <member name="T:NPOI.SS.Formula.Udf.DefaultUDFFinder">
  35161. Default UDF Finder - for Adding your own user defined functions.
  35162. @author PUdalau
  35163. </member>
  35164. <member name="T:NPOI.SS.Formula.WorkbookEvaluator">
  35165. Evaluates formula cells.<p/>
  35166. For performance reasons, this class keeps a cache of all previously calculated intermediate
  35167. cell values. Be sure To call {@link #ClearCache()} if any workbook cells are Changed between
  35168. calls To evaluate~ methods on this class.<br/>
  35169. For POI internal use only
  35170. @author Josh Micich
  35171. </member>
  35172. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetSheetName(System.Int32)">
  35173. also for debug use. Used in ToString methods
  35174. </member>
  35175. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.ClearAllCachedResultValues">
  35176. Should be called whenever there are Changes To input cells in the evaluated workbook.
  35177. Failure To call this method after changing cell values will cause incorrect behaviour
  35178. of the evaluate~ methods of this class
  35179. </member>
  35180. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.NotifyUpdateCell(NPOI.SS.Formula.IEvaluationCell)">
  35181. Should be called To tell the cell value cache that the specified (value or formula) cell
  35182. Has Changed.
  35183. </member>
  35184. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.NotifyDeleteCell(NPOI.SS.Formula.IEvaluationCell)">
  35185. Should be called To tell the cell value cache that the specified cell Has just been
  35186. deleted.
  35187. </member>
  35188. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetSheetIndex(System.String)">
  35189. Case-insensitive.
  35190. @return -1 if sheet with specified name does not exist
  35191. </member>
  35192. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.EvaluateAny(NPOI.SS.Formula.IEvaluationCell,System.Int32,System.Int32,System.Int32,NPOI.SS.Formula.EvaluationTracker)">
  35193. @return never <c>null</c>, never {@link BlankEval}
  35194. </member>
  35195. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.AddExceptionInfo(System.NotImplementedException,System.Int32,System.Int32,System.Int32)">
  35196. Adds the current cell reference to the exception for easier debugging.
  35197. Would be nice to get the formula text as well, but that seems to require
  35198. too much digging around and casting to get the FormulaRenderingWorkbook.
  35199. </member>
  35200. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetValueFromNonFormulaCell(NPOI.SS.Formula.IEvaluationCell)">
  35201. Gets the value from a non-formula cell.
  35202. @param cell may be <c>null</c>
  35203. @return {@link BlankEval} if cell is <c>null</c> or blank, never <c>null</c>
  35204. </member>
  35205. <member name="F:NPOI.SS.Formula.WorkbookEvaluator.dbgEvaluationOutputForNextEval">
  35206. whether print detailed messages about the next formula evaluation
  35207. </member>
  35208. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.CountTokensToBeSkipped(NPOI.SS.Formula.PTG.Ptg[],System.Int32,System.Int32)">
  35209. Calculates the number of tokens that the evaluator should skip upon reaching a tAttrSkip.
  35210. @return the number of tokens (starting from <c>startIndex+1</c>) that need to be skipped
  35211. to achieve the specified <c>distInBytes</c> skip distance.
  35212. </member>
  35213. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.DereferenceResult(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  35214. Dereferences a single value from any AreaEval or RefEval evaluation result.
  35215. If the supplied evaluationResult is just a plain value, it is returned as-is.
  35216. @return a <c>NumberEval</c>, <c>StringEval</c>, <c>BoolEval</c>,
  35217. <c>BlankEval</c> or <c>ErrorEval</c>. Never <c>null</c>.
  35218. </member>
  35219. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetEvalForPtg(NPOI.SS.Formula.PTG.Ptg,NPOI.SS.Formula.OperationEvaluationContext)">
  35220. returns an appropriate Eval impl instance for the Ptg. The Ptg must be
  35221. one of: Area3DPtg, AreaPtg, ReferencePtg, Ref3DPtg, IntPtg, NumberPtg,
  35222. StringPtg, BoolPtg <br/>special Note: OperationPtg subtypes cannot be
  35223. passed here!
  35224. </member>
  35225. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.EvaluateReference(NPOI.SS.Formula.IEvaluationSheet,System.Int32,System.Int32,System.Int32,NPOI.SS.Formula.EvaluationTracker)">
  35226. Used by the lazy ref evals whenever they need To Get the value of a contained cell.
  35227. </member>
  35228. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetSupportedFunctionNames">
  35229. Return a collection of functions that POI can evaluate
  35230. @return names of functions supported by POI
  35231. </member>
  35232. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetNotSupportedFunctionNames">
  35233. Return a collection of functions that POI does not support
  35234. @return names of functions NOT supported by POI
  35235. </member>
  35236. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.RegisterFunction(System.String,NPOI.SS.Formula.Functions.FreeRefFunction)">
  35237. Register a ATP function in runtime.
  35238. @param name the function name
  35239. @param func the functoin to register
  35240. @throws IllegalArgumentException if the function is unknown or already registered.
  35241. @since 3.8 beta6
  35242. </member>
  35243. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.RegisterFunction(System.String,NPOI.SS.Formula.Functions.Function)">
  35244. Register a function in runtime.
  35245. @param name the function name
  35246. @param func the functoin to register
  35247. @throws IllegalArgumentException if the function is unknown or already registered.
  35248. @since 3.8 beta6
  35249. </member>
  35250. <member name="P:NPOI.SS.Formula.WorkbookEvaluator.IgnoreMissingWorkbooks">
  35251. Whether to ignore missing references to external workbooks and
  35252. use cached formula results in the main workbook instead.
  35253. <p>
  35254. In some cases exetrnal workbooks referenced by formulas in the main workbook are not avaiable.
  35255. With this method you can control how POI handles such missing references:
  35256. <ul>
  35257. <li>by default ignoreMissingWorkbooks=false and POI throws {@link WorkbookNotFoundException}
  35258. if an external reference cannot be resolved</li>
  35259. <li>if ignoreMissingWorkbooks=true then POI uses cached formula result
  35260. that already exists in the main workbook</li>
  35261. </ul>
  35262. </p>
  35263. @param ignore whether to ignore missing references to external workbooks
  35264. @see <a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=52575">Bug 52575 for details</a>
  35265. </member>
  35266. <member name="T:NPOI.SS.SpreadsheetVersion">
  35267. This enum allows spReadsheets from multiple Excel versions to be handled by the common code.
  35268. Properties of this enum correspond to attributes of the <i>spReadsheet</i> that are easily
  35269. discernable to the user. It is not intended to deal with low-level issues like file formats.
  35270. <p/>
  35271. @author Josh Micich
  35272. @author Yegor Kozlov
  35273. </member>
  35274. <member name="F:NPOI.SS.SpreadsheetVersion.EXCEL97">
  35275. Excel97 format aka BIFF8
  35276. <ul>
  35277. <li>The total number of available columns is 256 (2^8)</li>
  35278. <li>The total number of available rows is 64k (2^16)</li>
  35279. <li>The maximum number of arguments to a function is 30</li>
  35280. <li>Number of conditional format conditions on a cell is 3</li>
  35281. <li>Length of text cell contents is unlimited </li>
  35282. <li>Length of text cell contents is 32767</li>
  35283. </ul>
  35284. </member>
  35285. <member name="F:NPOI.SS.SpreadsheetVersion.EXCEL2007">
  35286. Excel2007
  35287. <ul>
  35288. <li>The total number of available columns is 16K (2^14)</li>
  35289. <li>The total number of available rows is 1M (2^20)</li>
  35290. <li>The maximum number of arguments to a function is 255</li>
  35291. <li>Number of conditional format conditions on a cell is unlimited
  35292. (actually limited by available memory in Excel)</li>
  35293. <li>Length of text cell contents is unlimited </li>
  35294. </ul>
  35295. </member>
  35296. <member name="P:NPOI.SS.SpreadsheetVersion.DefaultExtension">
  35297. @return the default file extension of spReadsheet
  35298. </member>
  35299. <member name="P:NPOI.SS.SpreadsheetVersion.MaxRows">
  35300. @return the maximum number of usable rows in each spReadsheet
  35301. </member>
  35302. <member name="P:NPOI.SS.SpreadsheetVersion.LastRowIndex">
  35303. @return the last (maximum) valid row index, equals to <code> GetMaxRows() - 1 </code>
  35304. </member>
  35305. <member name="P:NPOI.SS.SpreadsheetVersion.MaxColumns">
  35306. @return the maximum number of usable columns in each spReadsheet
  35307. </member>
  35308. <member name="P:NPOI.SS.SpreadsheetVersion.LastColumnIndex">
  35309. @return the last (maximum) valid column index, equals to <code> GetMaxColumns() - 1 </code>
  35310. </member>
  35311. <member name="P:NPOI.SS.SpreadsheetVersion.MaxFunctionArgs">
  35312. @return the maximum number arguments that can be passed to a multi-arg function (e.g. COUNTIF)
  35313. </member>
  35314. <member name="P:NPOI.SS.SpreadsheetVersion.MaxConditionalFormats">
  35315. @return the maximum number of conditional format conditions on a cell
  35316. </member>
  35317. <member name="P:NPOI.SS.SpreadsheetVersion.LastColumnName">
  35318. @return the last valid column index in a ALPHA-26 representation
  35319. (<code>IV</code> or <code>XFD</code>).
  35320. </member>
  35321. <member name="P:NPOI.SS.SpreadsheetVersion.MaxCellStyles">
  35322. @return the maximum number of cell styles per spreadsheet
  35323. </member>
  35324. <member name="P:NPOI.SS.SpreadsheetVersion.MaxTextLength">
  35325. @return the maximum length of a text cell
  35326. </member>
  35327. <member name="T:NPOI.SS.UserModel.BorderStyle">
  35328. <summary>
  35329. The enumeration value indicating the line style of a border in a cell
  35330. </summary>
  35331. </member>
  35332. <member name="F:NPOI.SS.UserModel.BorderStyle.None">
  35333. <summary>
  35334. No border
  35335. </summary>
  35336. </member>
  35337. <member name="F:NPOI.SS.UserModel.BorderStyle.Thin">
  35338. <summary>
  35339. Thin border
  35340. </summary>
  35341. </member>
  35342. <member name="F:NPOI.SS.UserModel.BorderStyle.Medium">
  35343. <summary>
  35344. Medium border
  35345. </summary>
  35346. </member>
  35347. <member name="F:NPOI.SS.UserModel.BorderStyle.Dashed">
  35348. <summary>
  35349. dash border
  35350. </summary>
  35351. </member>
  35352. <member name="F:NPOI.SS.UserModel.BorderStyle.Dotted">
  35353. <summary>
  35354. dot border
  35355. </summary>
  35356. </member>
  35357. <member name="F:NPOI.SS.UserModel.BorderStyle.Thick">
  35358. <summary>
  35359. Thick border
  35360. </summary>
  35361. </member>
  35362. <member name="F:NPOI.SS.UserModel.BorderStyle.Double">
  35363. <summary>
  35364. double-line border
  35365. </summary>
  35366. </member>
  35367. <member name="F:NPOI.SS.UserModel.BorderStyle.Hair">
  35368. <summary>
  35369. hair-line border
  35370. </summary>
  35371. </member>
  35372. <member name="F:NPOI.SS.UserModel.BorderStyle.MediumDashed">
  35373. <summary>
  35374. Medium dashed border
  35375. </summary>
  35376. </member>
  35377. <member name="F:NPOI.SS.UserModel.BorderStyle.DashDot">
  35378. <summary>
  35379. dash-dot border
  35380. </summary>
  35381. </member>
  35382. <member name="F:NPOI.SS.UserModel.BorderStyle.MediumDashDot">
  35383. <summary>
  35384. medium dash-dot border
  35385. </summary>
  35386. </member>
  35387. <member name="F:NPOI.SS.UserModel.BorderStyle.DashDotDot">
  35388. <summary>
  35389. dash-dot-dot border
  35390. </summary>
  35391. </member>
  35392. <member name="F:NPOI.SS.UserModel.BorderStyle.MediumDashDotDot">
  35393. <summary>
  35394. medium dash-dot-dot border
  35395. </summary>
  35396. </member>
  35397. <member name="F:NPOI.SS.UserModel.BorderStyle.SlantedDashDot">
  35398. <summary>
  35399. slanted dash-dot border
  35400. </summary>
  35401. </member>
  35402. <member name="T:NPOI.SS.UserModel.BuiltinFormats">
  35403. Utility to identify built-in formats. The following is a list of the formats as
  35404. returned by this class.<p/>
  35405. <p/>
  35406. 0, "General"<br/>
  35407. 1, "0"<br/>
  35408. 2, "0.00"<br/>
  35409. 3, "#,##0"<br/>
  35410. 4, "#,##0.00"<br/>
  35411. 5, "$#,##0_);($#,##0)"<br/>
  35412. 6, "$#,##0_);[Red]($#,##0)"<br/>
  35413. 7, "$#,##0.00);($#,##0.00)"<br/>
  35414. 8, "$#,##0.00_);[Red]($#,##0.00)"<br/>
  35415. 9, "0%"<br/>
  35416. 0xa, "0.00%"<br/>
  35417. 0xb, "0.00E+00"<br/>
  35418. 0xc, "# ?/?"<br/>
  35419. 0xd, "# ??/??"<br/>
  35420. 0xe, "m/d/yy"<br/>
  35421. 0xf, "d-mmm-yy"<br/>
  35422. 0x10, "d-mmm"<br/>
  35423. 0x11, "mmm-yy"<br/>
  35424. 0x12, "h:mm AM/PM"<br/>
  35425. 0x13, "h:mm:ss AM/PM"<br/>
  35426. 0x14, "h:mm"<br/>
  35427. 0x15, "h:mm:ss"<br/>
  35428. 0x16, "m/d/yy h:mm"<br/>
  35429. <p/>
  35430. // 0x17 - 0x24 reserved for international and undocumented
  35431. 0x25, "#,##0_);(#,##0)"<br/>
  35432. 0x26, "#,##0_);[Red](#,##0)"<br/>
  35433. 0x27, "#,##0.00_);(#,##0.00)"<br/>
  35434. 0x28, "#,##0.00_);[Red](#,##0.00)"<br/>
  35435. 0x29, "_(*#,##0_);_(*(#,##0);_(* \"-\"_);_(@_)"<br/>
  35436. 0x2a, "_($*#,##0_);_($*(#,##0);_($* \"-\"_);_(@_)"<br/>
  35437. 0x2b, "_(*#,##0.00_);_(*(#,##0.00);_(*\"-\"??_);_(@_)"<br/>
  35438. 0x2c, "_($*#,##0.00_);_($*(#,##0.00);_($*\"-\"??_);_(@_)"<br/>
  35439. 0x2d, "mm:ss"<br/>
  35440. 0x2e, "[h]:mm:ss"<br/>
  35441. 0x2f, "mm:ss.0"<br/>
  35442. 0x30, "##0.0E+0"<br/>
  35443. 0x31, "@" - This is text format.<br/>
  35444. 0x31 "text" - Alias for "@"<br/>
  35445. <p/>
  35446. @author Yegor Kozlov
  35447. Modified 6/17/09 by Stanislav Shor - positive formats don't need starting '('
  35448. </member>
  35449. <member name="F:NPOI.SS.UserModel.BuiltinFormats.FIRST_USER_DEFINED_FORMAT_INDEX">
  35450. The first user-defined format starts at 164.
  35451. </member>
  35452. <member name="M:NPOI.SS.UserModel.BuiltinFormats.GetBuiltinFormats">
  35453. @deprecated (May 2009) use {@link #getAll()}
  35454. </member>
  35455. <member name="M:NPOI.SS.UserModel.BuiltinFormats.GetAll">
  35456. @return array of built-in data formats
  35457. </member>
  35458. <member name="M:NPOI.SS.UserModel.BuiltinFormats.GetBuiltinFormat(System.Int32)">
  35459. Get the format string that matches the given format index
  35460. @param index of a built in format
  35461. @return string represented at index of format or <code>null</code> if there is not a built-in format at that index
  35462. </member>
  35463. <member name="M:NPOI.SS.UserModel.BuiltinFormats.GetBuiltinFormat(System.String)">
  35464. Get the format index that matches the given format string.
  35465. <p>
  35466. Automatically converts "text" to excel's format string to represent text.
  35467. </p>
  35468. @param pFmt string matching a built-in format
  35469. @return index of format or -1 if undefined.
  35470. </member>
  35471. <member name="M:NPOI.SS.UserModel.ICellRange`1.GetCell(System.Int32,System.Int32)">
  35472. @param relativeRowIndex must be between <tt>0</tt> and <tt>height-1</tt>
  35473. @param relativeColumnIndex must be between <tt>0</tt> and <tt>width-1</tt>
  35474. @return the cell at the specified coordinates. Never <code>null</code>.
  35475. </member>
  35476. <member name="P:NPOI.SS.UserModel.ICellRange`1.Size">
  35477. Gets the number of cells in this range.
  35478. @return <tt>height * width </tt>
  35479. </member>
  35480. <member name="P:NPOI.SS.UserModel.ICellRange`1.ReferenceText">
  35481. @return the text format of this range. Single cell ranges are formatted
  35482. like single cell references (e.g. 'A1' instead of 'A1:A1').
  35483. </member>
  35484. <member name="P:NPOI.SS.UserModel.ICellRange`1.TopLeftCell">
  35485. @return the cell at relative coordinates (0,0). Never <code>null</code>.
  35486. </member>
  35487. <member name="P:NPOI.SS.UserModel.ICellRange`1.FlattenedCells">
  35488. @return a flattened array of all the cells in this {@link CellRange}
  35489. </member>
  35490. <member name="P:NPOI.SS.UserModel.ICellRange`1.Cells">
  35491. @return a 2-D array of all the cells in this {@link CellRange}. The first
  35492. array dimension is the row index (values <tt>0...height-1</tt>)
  35493. and the second dimension is the column index (values <tt>0...width-1</tt>)
  35494. </member>
  35495. <member name="T:NPOI.SS.UserModel.CellValue">
  35496. Mimics the 'data view' of a cell. This allows formula Evaluator
  35497. to return a CellValue instead of precasting the value to String
  35498. or Number or bool type.
  35499. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35500. </member>
  35501. <member name="P:NPOI.SS.UserModel.CellValue.BooleanValue">
  35502. @return Returns the boolValue.
  35503. </member>
  35504. <member name="P:NPOI.SS.UserModel.CellValue.NumberValue">
  35505. @return Returns the numberValue.
  35506. </member>
  35507. <member name="P:NPOI.SS.UserModel.CellValue.StringValue">
  35508. @return Returns the stringValue.
  35509. </member>
  35510. <member name="P:NPOI.SS.UserModel.CellValue.CellType">
  35511. @return Returns the cellType.
  35512. </member>
  35513. <member name="P:NPOI.SS.UserModel.CellValue.ErrorValue">
  35514. @return Returns the errorValue.
  35515. </member>
  35516. <member name="T:NPOI.SS.UserModel.IChart">
  35517. High level representation of a chart.
  35518. @author Roman Kashitsyn
  35519. </member>
  35520. <member name="T:NPOI.SS.UserModel.Charts.ManuallyPositionable">
  35521. Abstraction of chart element that can be positioned with manual
  35522. layout.
  35523. @author Roman Kashitsyn
  35524. </member>
  35525. <member name="M:NPOI.SS.UserModel.Charts.ManuallyPositionable.GetManualLayout">
  35526. Returns manual layout for the chart element.
  35527. @return manual layout for the chart element.
  35528. </member>
  35529. <member name="M:NPOI.SS.UserModel.IChart.GetOrCreateLegend">
  35530. @return chart legend instance
  35531. </member>
  35532. <member name="M:NPOI.SS.UserModel.IChart.DeleteLegend">
  35533. Delete current chart legend.
  35534. </member>
  35535. <member name="M:NPOI.SS.UserModel.IChart.GetAxis">
  35536. @return list of all chart axis
  35537. </member>
  35538. <member name="M:NPOI.SS.UserModel.IChart.Plot(NPOI.SS.UserModel.Charts.IChartData,NPOI.SS.UserModel.Charts.IChartAxis[])">
  35539. Plots specified data on the chart.
  35540. @param data a data to plot
  35541. </member>
  35542. <member name="P:NPOI.SS.UserModel.IChart.ChartDataFactory">
  35543. @return an appropriate ChartDataFactory implementation
  35544. </member>
  35545. <member name="P:NPOI.SS.UserModel.IChart.ChartAxisFactory">
  35546. @return an appropriate ChartAxisFactory implementation
  35547. </member>
  35548. <member name="T:NPOI.SS.UserModel.Charts.AxisCrossBetween">
  35549. Specifies the possible crossing states of an axis.
  35550. @author Roman Kashitsyn
  35551. </member>
  35552. <member name="F:NPOI.SS.UserModel.Charts.AxisCrossBetween.Between">
  35553. Specifies the value axis shall cross the category axis
  35554. between data markers.
  35555. </member>
  35556. <member name="F:NPOI.SS.UserModel.Charts.AxisCrossBetween.MidpointCategory">
  35557. Specifies the value axis shall cross the category axis at
  35558. the midpoint of a category.
  35559. </member>
  35560. <member name="T:NPOI.SS.UserModel.Charts.AxisCrosses">
  35561. Specifies the possible crossing points for an axis.
  35562. @author Roman Kashitsyn
  35563. </member>
  35564. <member name="F:NPOI.SS.UserModel.Charts.AxisCrosses.AutoZero">
  35565. The category axis crosses at the zero point of the value axis (if
  35566. possible), or the minimum value (if the minimum is greater than zero) or
  35567. the maximum (if the maximum is less than zero).
  35568. </member>
  35569. <member name="F:NPOI.SS.UserModel.Charts.AxisCrosses.Min">
  35570. The axis crosses at the maximum value.
  35571. </member>
  35572. <member name="F:NPOI.SS.UserModel.Charts.AxisCrosses.Max">
  35573. Axis crosses at the minimum value of the chart.
  35574. </member>
  35575. <member name="T:NPOI.SS.UserModel.Charts.AxisOrientation">
  35576. Specifies the possible ways to place a picture on a data point, series, wall, or floor.
  35577. @author Roman Kashitsyn
  35578. </member>
  35579. <member name="F:NPOI.SS.UserModel.Charts.AxisOrientation.MaxToMin">
  35580. Specifies that the values on the axis shall be reversed
  35581. so they go from maximum to minimum.
  35582. </member>
  35583. <member name="F:NPOI.SS.UserModel.Charts.AxisOrientation.MinToMax">
  35584. Specifies that the axis values shall be in the usual
  35585. order, minimum to maximum.
  35586. </member>
  35587. <member name="T:NPOI.SS.UserModel.Charts.AxisPosition">
  35588. Enumeration of all possible axis positions.
  35589. @author Roman Kashitsyn
  35590. </member>
  35591. <member name="T:NPOI.SS.UserModel.Charts.IChartAxis">
  35592. High level representation of chart axis.
  35593. @author Roman Kashitsyn
  35594. </member>
  35595. <member name="M:NPOI.SS.UserModel.Charts.IChartAxis.CrossAxis(NPOI.SS.UserModel.Charts.IChartAxis)">
  35596. Declare this axis cross another axis.
  35597. @param axis that this axis should cross
  35598. </member>
  35599. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Id">
  35600. @return axis id
  35601. </member>
  35602. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Position">
  35603. get or set axis position
  35604. </member>
  35605. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.NumberFormat">
  35606. get or set axis number format
  35607. </member>
  35608. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.IsSetLogBase">
  35609. @return true if log base is defined, false otherwise
  35610. </member>
  35611. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.LogBase">
  35612. @param logBase a number between 2 and 1000 (inclusive)
  35613. @return axis log base or 0.0 if not Set
  35614. @throws ArgumentException if log base not within allowed range
  35615. </member>
  35616. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.IsSetMinimum">
  35617. @return true if minimum value is defined, false otherwise
  35618. </member>
  35619. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Minimum">
  35620. get or set axis minimum
  35621. 0.0 if not Set
  35622. </member>
  35623. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.IsSetMaximum">
  35624. @return true if maximum value is defined, false otherwise
  35625. </member>
  35626. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Maximum">
  35627. get or set axis maximum
  35628. 0.0 if not Set
  35629. </member>
  35630. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Orientation">
  35631. get or set axis orientation
  35632. </member>
  35633. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Crosses">
  35634. get or set axis cross type
  35635. </member>
  35636. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.IsVisible">
  35637. @return visibility of the axis.
  35638. </member>
  35639. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.MajorTickMark">
  35640. @return major tick mark.
  35641. </member>
  35642. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.MinorTickMark">
  35643. @return minor tick mark.
  35644. </member>
  35645. <member name="T:NPOI.SS.UserModel.Charts.IChartAxisFactory">
  35646. <summary>
  35647. A factory for different chart axis.
  35648. </summary>
  35649. <remarks>@author Roman Kashitsyn</remarks>
  35650. </member>
  35651. <member name="M:NPOI.SS.UserModel.Charts.IChartAxisFactory.CreateValueAxis(NPOI.SS.UserModel.Charts.AxisPosition)">
  35652. <summary>
  35653. returns new value axis
  35654. </summary>
  35655. <param name="pos"></param>
  35656. <returns></returns>
  35657. </member>
  35658. <member name="T:NPOI.SS.UserModel.Charts.IChartDataFactory">
  35659. <summary>
  35660. A factory for different chart data types.
  35661. </summary>
  35662. <remarks>
  35663. @author Roman Kashitsyn
  35664. </remarks>
  35665. </member>
  35666. <member name="M:NPOI.SS.UserModel.Charts.IChartDataFactory.CreateScatterChartData``2">
  35667. <summary>
  35668. returns an appropriate ScatterChartData instance
  35669. </summary>
  35670. <returns></returns>
  35671. </member>
  35672. <member name="T:NPOI.SS.UserModel.Charts.IChartLegend">
  35673. <summary>
  35674. High level representation of chart legend.
  35675. </summary>
  35676. <remarks>@author Roman Kashitsyn</remarks>
  35677. </member>
  35678. <member name="P:NPOI.SS.UserModel.Charts.IChartLegend.Position">
  35679. <summary>
  35680. legend position
  35681. </summary>
  35682. <returns></returns>
  35683. </member>
  35684. <member name="P:NPOI.SS.UserModel.Charts.IChartLegend.IsOverlay">
  35685. <summary>
  35686. If true the legend is positioned over the chart area otherwise
  35687. the legend is displayed next to it.
  35688. Default is no overlay.
  35689. </summary>
  35690. </member>
  35691. <member name="T:NPOI.SS.UserModel.Charts.LayoutMode">
  35692. <summary>
  35693. Specifies the possible ways to store a chart element's position.
  35694. </summary>
  35695. <remarks>
  35696. @author Roman Kashitsyn
  35697. </remarks>
  35698. </member>
  35699. <member name="F:NPOI.SS.UserModel.Charts.LayoutMode.Edge">
  35700. <summary>
  35701. Specifies that the Width or Height shall be interpreted as the Right or Bottom of the chart element.
  35702. </summary>
  35703. </member>
  35704. <member name="F:NPOI.SS.UserModel.Charts.LayoutMode.Factor">
  35705. <summary>
  35706. Specifies that the Width or Height shall be interpreted as the width or Height of the chart element.
  35707. </summary>
  35708. </member>
  35709. <member name="T:NPOI.SS.UserModel.Charts.LayoutTarget">
  35710. <summary>
  35711. Specifies whether to layout the plot area by its inside (not including axis
  35712. and axis labels) or outside (including axis and axis labels).
  35713. </summary>
  35714. <remarks>
  35715. @author Roman Kashitsyn
  35716. </remarks>
  35717. </member>
  35718. <member name="F:NPOI.SS.UserModel.Charts.LayoutTarget.Inner">
  35719. <summary>
  35720. Specifies that the plot area size shall determine the size of the plot area, not including the tick marks and axis labels.
  35721. </summary>
  35722. </member>
  35723. <member name="F:NPOI.SS.UserModel.Charts.LayoutTarget.Outer">
  35724. <summary>
  35725. Specifies that the plot area size shall determine the
  35726. size of the plot area, the tick marks, and the axis
  35727. labels.
  35728. </summary>
  35729. </member>
  35730. <member name="T:NPOI.SS.UserModel.Charts.LegendPosition">
  35731. <summary>
  35732. Enumeration of all possible chart legend positions.
  35733. </summary>
  35734. <remarks>
  35735. @author Roman Kashitsyn
  35736. </remarks>
  35737. </member>
  35738. <member name="T:NPOI.SS.UserModel.Charts.IManualLayout">
  35739. High level representation of chart element manual layout.
  35740. @author Roman Kashitsyn
  35741. </member>
  35742. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetTarget(NPOI.SS.UserModel.Charts.LayoutTarget)">
  35743. Sets the layout target.
  35744. @param target new layout target.
  35745. </member>
  35746. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetTarget">
  35747. Returns current layout target.
  35748. @return current layout target
  35749. </member>
  35750. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetXMode(NPOI.SS.UserModel.Charts.LayoutMode)">
  35751. Sets the x-coordinate layout mode.
  35752. @param mode new x-coordinate layout mode.
  35753. </member>
  35754. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetXMode">
  35755. Returns current x-coordinnate layout mode.
  35756. @return current x-coordinate layout mode.
  35757. </member>
  35758. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetYMode(NPOI.SS.UserModel.Charts.LayoutMode)">
  35759. Sets the y-coordinate layout mode.
  35760. @param mode new y-coordinate layout mode.
  35761. </member>
  35762. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetYMode">
  35763. Returns current y-coordinate layout mode.
  35764. @return current y-coordinate layout mode.
  35765. </member>
  35766. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetX">
  35767. Returns the x location of the chart element.
  35768. @return the x location (left) of the chart element or 0.0 if
  35769. not Set.
  35770. </member>
  35771. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetX(System.Double)">
  35772. Specifies the x location (left) of the chart element as a
  35773. fraction of the width of the chart. If Left Mode is Factor,
  35774. then the position is relative to the default position for the
  35775. chart element.
  35776. </member>
  35777. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetY">
  35778. Returns current y location of the chart element.
  35779. @return the y location (top) of the chart element or 0.0 if not
  35780. Set.
  35781. </member>
  35782. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetY(System.Double)">
  35783. Specifies the y location (top) of the chart element as a
  35784. fraction of the height of the chart. If Top Mode is Factor,
  35785. then the position is relative to the default position for the
  35786. chart element.
  35787. </member>
  35788. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetWidthMode(NPOI.SS.UserModel.Charts.LayoutMode)">
  35789. Specifies how to interpret the Width element for this manual
  35790. layout.
  35791. @param mode new width layout mode of this manual layout.
  35792. </member>
  35793. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetWidthMode">
  35794. Returns current width mode of this manual layout.
  35795. @return width mode of this manual layout.
  35796. </member>
  35797. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetHeightMode(NPOI.SS.UserModel.Charts.LayoutMode)">
  35798. Specifies how to interpret the Height element for this manual
  35799. layout.
  35800. @param mode new height mode of this manual layout.
  35801. </member>
  35802. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetHeightMode">
  35803. Returns current height mode of this
  35804. @return height mode of this manual layout.
  35805. </member>
  35806. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetWidthRatio(System.Double)">
  35807. Specifies the width (if Width Mode is Factor) or right (if
  35808. Width Mode is Edge) of the chart element as a fraction of the
  35809. width of the chart.
  35810. @param ratio a fraction of the width of the chart.
  35811. </member>
  35812. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetWidthRatio">
  35813. Returns current fraction of the width of the chart.
  35814. @return fraction of the width of the chart or 0.0 if not Set.
  35815. </member>
  35816. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetHeightRatio(System.Double)">
  35817. Specifies the height (if Height Mode is Factor) or bottom (if
  35818. Height Mode is edge) of the chart element as a fraction of the
  35819. height of the chart.
  35820. @param ratio a fraction of the height of the chart.
  35821. </member>
  35822. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetHeightRatio">
  35823. Returns current fraction of the height of the chart.
  35824. @return fraction of the height of the chart or 0.0 if not Set.
  35825. </member>
  35826. <member name="T:NPOI.SS.UserModel.Charts.IScatterChartData`2">
  35827. Data for a Scatter Chart
  35828. </member>
  35829. <member name="M:NPOI.SS.UserModel.Charts.IScatterChartData`2.AddSeries(NPOI.SS.UserModel.Charts.IChartDataSource{`0},NPOI.SS.UserModel.Charts.IChartDataSource{`1})">
  35830. @param xs data source to be used for X axis values
  35831. @param ys data source to be used for Y axis values
  35832. @return a new scatter charts series
  35833. </member>
  35834. <member name="M:NPOI.SS.UserModel.Charts.IScatterChartData`2.GetSeries">
  35835. @return list of all series
  35836. </member>
  35837. <member name="T:NPOI.SS.UserModel.Charts.IScatterChartSeries`2">
  35838. Represents scatter charts serie.
  35839. @author Roman Kashitsyn
  35840. </member>
  35841. <member name="M:NPOI.SS.UserModel.Charts.IScatterChartSeries`2.GetXValues">
  35842. @return data source used for X axis values
  35843. </member>
  35844. <member name="M:NPOI.SS.UserModel.Charts.IScatterChartSeries`2.GetYValues">
  35845. @return data source used for Y axis values
  35846. </member>
  35847. <member name="T:NPOI.SS.UserModel.Charts.IValueAxis">
  35848. @author Roman Kashitsyn
  35849. </member>
  35850. <member name="M:NPOI.SS.UserModel.Charts.IValueAxis.GetCrossBetween">
  35851. @return cross between type
  35852. </member>
  35853. <member name="M:NPOI.SS.UserModel.Charts.IValueAxis.SetCrossBetween(NPOI.SS.UserModel.Charts.AxisCrossBetween)">
  35854. @param crossBetween cross between type
  35855. </member>
  35856. <member name="F:NPOI.SS.UserModel.AnchorType.MoveAndResize">
  35857. Move and Resize With Anchor Cells
  35858. <p>
  35859. Specifies that the current drawing shall move and
  35860. resize to maintain its row and column anchors (i.e. the
  35861. object is anchored to the actual from and to row and column)
  35862. </p>
  35863. </member>
  35864. <member name="F:NPOI.SS.UserModel.AnchorType.MoveDontResize">
  35865. Move With Cells but Do Not Resize
  35866. <p>
  35867. Specifies that the current drawing shall move with its
  35868. row and column (i.e. the object is anchored to the
  35869. actual from row and column), but that the size shall remain absolute.
  35870. </p>
  35871. <p>
  35872. If Additional rows/columns are Added between the from and to locations of the drawing,
  35873. the drawing shall move its to anchors as needed to maintain this same absolute size.
  35874. </p>
  35875. </member>
  35876. <member name="F:NPOI.SS.UserModel.AnchorType.DontMoveAndResize">
  35877. Do Not Move or Resize With Underlying Rows/Columns
  35878. <p>
  35879. Specifies that the current start and end positions shall
  35880. be maintained with respect to the distances from the
  35881. absolute start point of the worksheet.
  35882. </p>
  35883. <p>
  35884. If Additional rows/columns are Added before the
  35885. drawing, the drawing shall move its anchors as needed
  35886. to maintain this same absolute position.
  35887. </p>
  35888. </member>
  35889. <member name="T:NPOI.SS.UserModel.ComparisonOperator">
  35890. The conditional format operators used for "Highlight Cells That Contain..." rules.
  35891. <p>
  35892. For example, "highlight cells that begin with "M2" and contain "Mountain Gear".
  35893. </p>
  35894. @author Dmitriy Kumshayev
  35895. @author Yegor Kozlov
  35896. </member>
  35897. <member name="F:NPOI.SS.UserModel.ComparisonOperator.Between">
  35898. 'Between' operator
  35899. </member>
  35900. <member name="F:NPOI.SS.UserModel.ComparisonOperator.NotBetween">
  35901. 'Not between' operator
  35902. </member>
  35903. <member name="F:NPOI.SS.UserModel.ComparisonOperator.Equal">
  35904. 'Equal to' operator
  35905. </member>
  35906. <member name="F:NPOI.SS.UserModel.ComparisonOperator.NotEqual">
  35907. 'Not equal to' operator
  35908. </member>
  35909. <member name="F:NPOI.SS.UserModel.ComparisonOperator.GreaterThan">
  35910. 'Greater than' operator
  35911. </member>
  35912. <member name="F:NPOI.SS.UserModel.ComparisonOperator.LessThan">
  35913. 'Less than' operator
  35914. </member>
  35915. <member name="F:NPOI.SS.UserModel.ComparisonOperator.GreaterThanOrEqual">
  35916. 'Greater than or equal to' operator
  35917. </member>
  35918. <member name="F:NPOI.SS.UserModel.ComparisonOperator.LessThanOrEqual">
  35919. 'Less than or equal to' operator
  35920. </member>
  35921. <member name="F:NPOI.SS.UserModel.ConditionType.None">
  35922. <summary>
  35923. Allow accessing the Initial value.
  35924. </summary>
  35925. </member>
  35926. <member name="F:NPOI.SS.UserModel.ConditionType.CellValueIs">
  35927. This conditional formatting rule Compares a cell value
  35928. to a formula calculated result, using an operator
  35929. </member>
  35930. <member name="F:NPOI.SS.UserModel.ConditionType.Formula">
  35931. This conditional formatting rule Contains a formula to Evaluate.
  35932. When the formula result is true, the cell is highlighted.
  35933. </member>
  35934. <member name="T:NPOI.SS.UserModel.ERRORSTYLE">
  35935. Error style constants for error box
  35936. </member>
  35937. <member name="F:NPOI.SS.UserModel.ERRORSTYLE.STOP">
  35938. STOP style
  35939. </member>
  35940. <member name="F:NPOI.SS.UserModel.ERRORSTYLE.WARNING">
  35941. WARNING style
  35942. </member>
  35943. <member name="F:NPOI.SS.UserModel.ERRORSTYLE.INFO">
  35944. INFO style
  35945. </member>
  35946. <member name="T:NPOI.SS.UserModel.ValidationType">
  35947. ValidationType enum
  35948. </member>
  35949. <member name="F:NPOI.SS.UserModel.ValidationType.ANY">
  35950. 'Any value' type - value not restricted
  35951. </member>
  35952. <member name="F:NPOI.SS.UserModel.ValidationType.INTEGER">
  35953. int ('Whole number') type
  35954. </member>
  35955. <member name="F:NPOI.SS.UserModel.ValidationType.DECIMAL">
  35956. Decimal type
  35957. </member>
  35958. <member name="F:NPOI.SS.UserModel.ValidationType.LIST">
  35959. List type ( combo box type )
  35960. </member>
  35961. <member name="F:NPOI.SS.UserModel.ValidationType.DATE">
  35962. Date type
  35963. </member>
  35964. <member name="F:NPOI.SS.UserModel.ValidationType.TIME">
  35965. Time type
  35966. </member>
  35967. <member name="F:NPOI.SS.UserModel.ValidationType.TEXT_LENGTH">
  35968. String length type
  35969. </member>
  35970. <member name="F:NPOI.SS.UserModel.ValidationType.FORMULA">
  35971. Formula ( 'Custom' ) type
  35972. </member>
  35973. <member name="T:NPOI.SS.UserModel.OperatorType">
  35974. Condition operator enum
  35975. </member>
  35976. <member name="F:NPOI.SS.UserModel.OperatorType.IGNORED">
  35977. default value to supply when the operator type is not used
  35978. </member>
  35979. <member name="T:NPOI.SS.UserModel.ErrorConstants">
  35980. Contains raw Excel error codes (as defined in OOO's excelfileformat.pdf (2.5.6)
  35981. @author Michael Harhen
  35982. </member>
  35983. <member name="F:NPOI.SS.UserModel.ErrorConstants.ERROR_NULL">
  35984. <b>#NULL!</b> - Intersection of two cell ranges is empty
  35985. </member>
  35986. <member name="F:NPOI.SS.UserModel.ErrorConstants.ERROR_DIV_0">
  35987. <b>#DIV/0!</b> - Division by zero
  35988. </member>
  35989. <member name="F:NPOI.SS.UserModel.ErrorConstants.ERROR_VALUE">
  35990. <b>#VALUE!</b> - Wrong type of operand
  35991. </member>
  35992. <member name="F:NPOI.SS.UserModel.ErrorConstants.ERROR_REF">
  35993. <b>#REF!</b> - Illegal or deleted cell reference
  35994. </member>
  35995. <member name="F:NPOI.SS.UserModel.ErrorConstants.ERROR_NAME">
  35996. <b>#NAME?</b> - Wrong function or range name
  35997. </member>
  35998. <member name="F:NPOI.SS.UserModel.ErrorConstants.ERROR_NUM">
  35999. <b>#NUM!</b> - Value range overflow
  36000. </member>
  36001. <member name="F:NPOI.SS.UserModel.ErrorConstants.ERROR_NA">
  36002. <b>#N/A</b> - Argument or function not available
  36003. </member>
  36004. <member name="M:NPOI.SS.UserModel.ErrorConstants.GetText(System.Int32)">
  36005. @return Standard Excel error literal for the specified error code.
  36006. @throws ArgumentException if the specified error code is not one of the 7
  36007. standard error codes
  36008. </member>
  36009. <member name="M:NPOI.SS.UserModel.ErrorConstants.IsValidCode(System.Int32)">
  36010. @return <c>true</c> if the specified error code is a standard Excel error code.
  36011. </member>
  36012. <member name="T:NPOI.SS.UserModel.ExcelStyleDateFormatter">
  36013. A wrapper around a {@link SimpleDateFormat} instance,
  36014. which handles a few Excel-style extensions that
  36015. are not supported by {@link SimpleDateFormat}.
  36016. Currently, the extensions are around the handling
  36017. of elapsed time, eg rendering 1 day 2 hours
  36018. as 26 hours.
  36019. </member>
  36020. <member name="M:NPOI.SS.UserModel.ExcelStyleDateFormatter.ProcessFormatPattern(System.String)">
  36021. Takes a format String, and Replaces Excel specific bits
  36022. with our detection sequences
  36023. </member>
  36024. <member name="M:NPOI.SS.UserModel.ExcelStyleDateFormatter.SetDateToBeFormatted(System.Double)">
  36025. Used to let us know what the date being
  36026. formatted is, in Excel terms, which we
  36027. may wish to use when handling elapsed
  36028. times.
  36029. </member>
  36030. <member name="F:NPOI.SS.UserModel.FontUnderlineType.None">
  36031. not underlined
  36032. </member>
  36033. <member name="F:NPOI.SS.UserModel.FontUnderlineType.Single">
  36034. single (normal) underline
  36035. </member>
  36036. <member name="F:NPOI.SS.UserModel.FontUnderlineType.Double">
  36037. double underlined
  36038. </member>
  36039. <member name="F:NPOI.SS.UserModel.FontUnderlineType.SingleAccounting">
  36040. accounting style single underline
  36041. </member>
  36042. <member name="F:NPOI.SS.UserModel.FontUnderlineType.DoubleAccounting">
  36043. accounting style double underline
  36044. </member>
  36045. <member name="F:NPOI.SS.UserModel.FontSuperScript.None">
  36046. no type Offsetting (not super or subscript)
  36047. </member>
  36048. <member name="F:NPOI.SS.UserModel.FontSuperScript.Super">
  36049. superscript
  36050. </member>
  36051. <member name="F:NPOI.SS.UserModel.FontSuperScript.Sub">
  36052. subscript
  36053. </member>
  36054. <member name="F:NPOI.SS.UserModel.FontColor.None">
  36055. <summary>
  36056. Allow accessing the Initial value.
  36057. </summary>
  36058. </member>
  36059. <member name="F:NPOI.SS.UserModel.FontColor.Normal">
  36060. normal type of black color.
  36061. </member>
  36062. <member name="F:NPOI.SS.UserModel.FontColor.Red">
  36063. Dark Red color
  36064. </member>
  36065. <member name="F:NPOI.SS.UserModel.FontBoldWeight.None">
  36066. <summary>
  36067. Allow accessing the Initial value.
  36068. </summary>
  36069. </member>
  36070. <member name="F:NPOI.SS.UserModel.FontBoldWeight.Normal">
  36071. Normal boldness (not bold)
  36072. </member>
  36073. <member name="F:NPOI.SS.UserModel.FontBoldWeight.Bold">
  36074. Bold boldness (bold)
  36075. </member>
  36076. <member name="T:NPOI.SS.UserModel.FontCharset">
  36077. Charset represents the basic set of characters associated with a font (that it can display), and
  36078. corresponds to the ANSI codepage (8-bit or DBCS) of that character set used by a given language.
  36079. @author Gisella Bronzetti
  36080. </member>
  36081. <member name="P:NPOI.SS.UserModel.FontCharset.Value">
  36082. Returns value of this charset
  36083. @return value of this charset
  36084. </member>
  36085. <member name="T:NPOI.SS.UserModel.FontFamily">
  36086. The font family this font belongs to. A font family is a set of fonts having common stroke width and serif
  36087. characteristics. The font name overrides when there are conflicting values.
  36088. @author Gisella Bronzetti
  36089. </member>
  36090. <member name="P:NPOI.SS.UserModel.FontFamily.Value">
  36091. Returns index of this font family
  36092. @return index of this font family
  36093. </member>
  36094. <member name="T:NPOI.SS.UserModel.FontScheme">
  36095. Defines the font scheme to which this font belongs.
  36096. When a font defInition is part of a theme defInition, then the font is categorized as either a major or minor font scheme component.
  36097. When a new theme is chosen, every font that is part of a theme defInition is updated to use the new major or minor font defInition for that
  36098. theme.
  36099. Usually major fonts are used for styles like headings, and minor fonts are used for body and paragraph text.
  36100. @author Gisella Bronzetti
  36101. </member>
  36102. <member name="T:NPOI.SS.UserModel.FormulaError">
  36103. Enumerates error values in SpreadsheetML formula calculations.
  36104. See also OOO's excelfileformat.pdf (2.5.6)
  36105. </member>
  36106. <member name="F:NPOI.SS.UserModel.FormulaError.NULL">
  36107. Intended to indicate when two areas are required to intersect, but do not.
  36108. <p>Example:
  36109. In the case of SUM(B1 C1), the space between B1 and C1 is treated as the binary
  36110. intersection operator, when a comma was intended. end example]
  36111. </p>
  36112. </member>
  36113. <member name="F:NPOI.SS.UserModel.FormulaError.DIV0">
  36114. Intended to indicate when any number, including zero, is divided by zero.
  36115. Note: However, any error code divided by zero results in that error code.
  36116. </member>
  36117. <member name="F:NPOI.SS.UserModel.FormulaError.VALUE">
  36118. Intended to indicate when an incompatible type argument is passed to a function, or
  36119. an incompatible type operand is used with an operator.
  36120. <p>Example:
  36121. In the case of a function argument, text was expected, but a number was provided
  36122. </p>
  36123. </member>
  36124. <member name="F:NPOI.SS.UserModel.FormulaError.REF">
  36125. Intended to indicate when a cell reference is invalid.
  36126. <p>Example:
  36127. If a formula Contains a reference to a cell, and then the row or column Containing that cell is deleted,
  36128. a #REF! error results. If a worksheet does not support 20,001 columns,
  36129. OFFSET(A1,0,20000) will result in a #REF! error.
  36130. </p>
  36131. </member>
  36132. <member name="F:NPOI.SS.UserModel.FormulaError.NUM">
  36133. Intended to indicate when an argument to a function has a compatible type, but has a
  36134. value that is outside the domain over which that function is defined. (This is known as
  36135. a domain error.)
  36136. <p>Example:
  36137. Certain calls to ASIN, ATANH, FACT, and SQRT might result in domain errors.
  36138. </p>
  36139. Intended to indicate that the result of a function cannot be represented in a value of
  36140. the specified type, typically due to extreme magnitude. (This is known as a range
  36141. error.)
  36142. <p>Example: FACT(1000) might result in a range error. </p>
  36143. </member>
  36144. <member name="F:NPOI.SS.UserModel.FormulaError.NA">
  36145. Intended to indicate when a designated value is not available.
  36146. <p>Example:
  36147. Some functions, such as SUMX2MY2, perform a series of operations on corresponding
  36148. elements in two arrays. If those arrays do not have the same number of elements, then
  36149. for some elements in the longer array, there are no corresponding elements in the
  36150. shorter one; that is, one or more values in the shorter array are not available.
  36151. </p>
  36152. This error value can be produced by calling the function NA
  36153. </member>
  36154. <member name="F:NPOI.SS.UserModel.FormulaError.CIRCULAR_REF">
  36155. POI specific code to indicate that there is a circular reference
  36156. in the formula
  36157. </member>
  36158. <member name="F:NPOI.SS.UserModel.FormulaError.FUNCTION_NOT_IMPLEMENTED">
  36159. POI specific code to indicate that the funcition required is
  36160. not implemented in POI
  36161. </member>
  36162. <member name="P:NPOI.SS.UserModel.FormulaError.Code">
  36163. @return numeric code of the error
  36164. </member>
  36165. <member name="P:NPOI.SS.UserModel.FormulaError.LongCode">
  36166. @return long (internal) numeric code of the error
  36167. </member>
  36168. <member name="P:NPOI.SS.UserModel.FormulaError.String">
  36169. @return string representation of the error
  36170. </member>
  36171. <member name="T:NPOI.SS.UserModel.HorizontalAlignment">
  36172. The enumeration value indicating horizontal alignment of a cell,
  36173. i.e., whether it is aligned general, left, right, horizontally centered, Filled (replicated),
  36174. justified, centered across multiple cells, or distributed.
  36175. </member>
  36176. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.General">
  36177. The horizontal alignment is general-aligned. Text data is left-aligned.
  36178. Numbers, dates, and times are rightaligned. Boolean types are centered.
  36179. Changing the alignment does not change the type of data.
  36180. </member>
  36181. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Left">
  36182. The horizontal alignment is left-aligned, even in Rightto-Left mode.
  36183. Aligns contents at the left edge of the cell. If an indent amount is specified, the contents of
  36184. the cell is indented from the left by the specified number of character spaces. The character spaces are
  36185. based on the default font and font size for the workbook.
  36186. </member>
  36187. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Center">
  36188. The horizontal alignment is centered, meaning the text is centered across the cell.
  36189. </member>
  36190. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Right">
  36191. The horizontal alignment is right-aligned, meaning that cell contents are aligned at the right edge of the cell,
  36192. even in Right-to-Left mode.
  36193. </member>
  36194. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Justify">
  36195. The horizontal alignment is justified (flush left and right).
  36196. For each line of text, aligns each line of the wrapped text in a cell to the right and left
  36197. (except the last line). If no single line of text wraps in the cell, then the text is not justified.
  36198. </member>
  36199. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Fill">
  36200. Indicates that the value of the cell should be Filled
  36201. across the entire width of the cell. If blank cells to the right also have the fill alignment,
  36202. they are also Filled with the value, using a convention similar to centerContinuous.
  36203. <p>
  36204. Additional rules:
  36205. <ol>
  36206. <li>Only whole values can be Appended, not partial values.</li>
  36207. <li>The column will not be widened to 'best fit' the Filled value</li>
  36208. <li>If Appending an Additional occurrence of the value exceeds the boundary of the cell
  36209. left/right edge, don't append the Additional occurrence of the value.</li>
  36210. <li>The display value of the cell is Filled, not the underlying raw number.</li>
  36211. </ol>
  36212. </p>
  36213. </member>
  36214. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.CenterSelection">
  36215. The horizontal alignment is centered across multiple cells.
  36216. The information about how many cells to span is expressed in the Sheet Part,
  36217. in the row of the cell in question. For each cell that is spanned in the alignment,
  36218. a cell element needs to be written out, with the same style Id which references the centerContinuous alignment.
  36219. </member>
  36220. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Distributed">
  36221. Indicates that each 'word' in each line of text inside the cell is evenly distributed
  36222. across the width of the cell, with flush right and left margins.
  36223. <p>
  36224. When there is also an indent value to apply, both the left and right side of the cell
  36225. are pAdded by the indent value.
  36226. </p>
  36227. <p> A 'word' is a set of characters with no space character in them. </p>
  36228. <p> Two lines inside a cell are Separated by a carriage return. </p>
  36229. </member>
  36230. <member name="F:NPOI.SS.UserModel.HyperlinkType.Url">
  36231. <summary>
  36232. Link to an existing file or web page
  36233. </summary>
  36234. </member>
  36235. <member name="F:NPOI.SS.UserModel.HyperlinkType.Document">
  36236. <summary>
  36237. Link to a place in this document
  36238. </summary>
  36239. </member>
  36240. <member name="F:NPOI.SS.UserModel.HyperlinkType.Email">
  36241. <summary>
  36242. Link to an E-mail Address
  36243. </summary>
  36244. </member>
  36245. <member name="F:NPOI.SS.UserModel.HyperlinkType.File">
  36246. <summary>
  36247. Link to a file
  36248. </summary>
  36249. </member>
  36250. <member name="T:NPOI.SS.UserModel.PageOrder">
  36251. Specifies printed page order.
  36252. @author Gisella Bronzetti
  36253. </member>
  36254. <member name="F:NPOI.SS.UserModel.PageOrder.DOWN_THEN_OVER">
  36255. Order pages vertically first, then move horizontally.
  36256. </member>
  36257. <member name="F:NPOI.SS.UserModel.PageOrder.OVER_THEN_DOWN">
  36258. Order pages horizontally first, then move vertically
  36259. </member>
  36260. <member name="T:NPOI.SS.UserModel.PaperSize">
  36261. The enumeration value indicating the possible paper size for a sheet
  36262. @author Daniele Montagni
  36263. </member>
  36264. <member name="F:NPOI.SS.UserModel.PaperSize.PRINTER_DEFAULT_PAPERSIZE">
  36265. <summary>
  36266. Allow accessing the Initial value.
  36267. </summary>
  36268. </member>
  36269. <member name="F:NPOI.SS.UserModel.PaperSize.A4_TRANSVERSE_PAPERSIZE">
  36270. <summary>
  36271. A4 Transverse - 210x297 mm
  36272. </summary>
  36273. </member>
  36274. <member name="F:NPOI.SS.UserModel.PaperSize.A4_PLUS_PAPERSIZE">
  36275. <summary>
  36276. A4 Plus - 210x330 mm
  36277. </summary>
  36278. </member>
  36279. <member name="F:NPOI.SS.UserModel.PaperSize.LETTER_ROTATED_PAPERSIZE">
  36280. <summary>
  36281. US Letter Rotated 11 x 8 1/2 in
  36282. </summary>
  36283. </member>
  36284. <member name="F:NPOI.SS.UserModel.PaperSize.A4_ROTATED_PAPERSIZE">
  36285. <summary>
  36286. A4 Rotated - 297x210 mm */
  36287. </summary>
  36288. </member>
  36289. <member name="F:NPOI.SS.UserModel.PictureType.Unknown">
  36290. <summary>
  36291. Allow accessing the Initial value.
  36292. </summary>
  36293. </member>
  36294. <member name="F:NPOI.SS.UserModel.PictureType.EMF">
  36295. Extended windows meta file
  36296. </member>
  36297. <member name="F:NPOI.SS.UserModel.PictureType.WMF">
  36298. Windows Meta File
  36299. </member>
  36300. <member name="F:NPOI.SS.UserModel.PictureType.PICT">
  36301. Mac PICT format
  36302. </member>
  36303. <member name="F:NPOI.SS.UserModel.PictureType.JPEG">
  36304. JPEG format
  36305. </member>
  36306. <member name="F:NPOI.SS.UserModel.PictureType.PNG">
  36307. PNG format
  36308. </member>
  36309. <member name="F:NPOI.SS.UserModel.PictureType.DIB">
  36310. Device independent bitmap
  36311. </member>
  36312. <member name="F:NPOI.SS.UserModel.PictureType.GIF">
  36313. GIF image format
  36314. </member>
  36315. <member name="F:NPOI.SS.UserModel.PictureType.TIFF">
  36316. Tag Image File (.tiff)
  36317. </member>
  36318. <member name="F:NPOI.SS.UserModel.PictureType.EPS">
  36319. Encapsulated Postscript (.eps)
  36320. </member>
  36321. <member name="F:NPOI.SS.UserModel.PictureType.BMP">
  36322. Windows Bitmap (.bmp)
  36323. </member>
  36324. <member name="F:NPOI.SS.UserModel.PictureType.WPG">
  36325. WordPerfect graphics (.wpg)
  36326. </member>
  36327. <member name="T:NPOI.SS.UserModel.PrintCellComments">
  36328. These enumerations specify how cell comments shall be displayed for paper printing purposes.
  36329. @author Gisella Bronzetti
  36330. </member>
  36331. <member name="F:NPOI.SS.UserModel.PrintCellComments.NONE">
  36332. Do not print cell comments.
  36333. </member>
  36334. <member name="F:NPOI.SS.UserModel.PrintCellComments.AS_DISPLAYED">
  36335. Print cell comments as displayed.
  36336. </member>
  36337. <member name="F:NPOI.SS.UserModel.PrintCellComments.AT_END">
  36338. Print cell comments at end of document.
  36339. </member>
  36340. <member name="T:NPOI.SS.UserModel.PrintOrientation">
  36341. The enumeration value indicating the print orientation for a sheet.
  36342. @author Gisella Bronzetti
  36343. </member>
  36344. <member name="F:NPOI.SS.UserModel.PrintOrientation.DEFAULT">
  36345. orientation not specified
  36346. </member>
  36347. <member name="F:NPOI.SS.UserModel.PrintOrientation.PORTRAIT">
  36348. portrait orientation
  36349. </member>
  36350. <member name="F:NPOI.SS.UserModel.PrintOrientation.LANDSCAPE">
  36351. landscape orientations
  36352. </member>
  36353. <member name="T:NPOI.SS.UserModel.DisplayCellErrorType">
  36354. <summary>
  36355. Used by HSSFPrintSetup.CellError property
  36356. </summary>
  36357. </member>
  36358. <member name="T:NPOI.SS.UserModel.MissingCellPolicy">
  36359. <summary>
  36360. Used to specify the different possible policies
  36361. if for the case of null and blank cells
  36362. </summary>
  36363. </member>
  36364. <member name="F:NPOI.SS.UserModel.MissingCellPolicy.RETURN_NULL_AND_BLANK">
  36365. <summary>Missing cells are returned as null, Blank cells are returned as normal</summary>
  36366. </member>
  36367. <member name="F:NPOI.SS.UserModel.MissingCellPolicy.RETURN_BLANK_AS_NULL">
  36368. <summary>Missing cells are returned as null, as are blank cells</summary>
  36369. </member>
  36370. <member name="F:NPOI.SS.UserModel.MissingCellPolicy.CREATE_NULL_AS_BLANK">
  36371. <summary>A new, blank cell is Created for missing cells. Blank cells are returned as normal</summary>
  36372. </member>
  36373. <member name="T:NPOI.SS.UserModel.ShapeTypes">
  36374. All known types of automatic shapes in DrawingML
  36375. @author Yegor Kozlov
  36376. </member>
  36377. <member name="F:NPOI.SS.UserModel.ShapeTypes.None">
  36378. <summary>
  36379. Allow accessing the Initial value.
  36380. </summary>
  36381. </member>
  36382. <member name="T:NPOI.SS.UserModel.MarginType">
  36383. <summary>
  36384. Indicate the position of the margin. One of left, right, top and bottom.
  36385. </summary>
  36386. </member>
  36387. <member name="F:NPOI.SS.UserModel.MarginType.LeftMargin">
  36388. <summary>
  36389. referes to the left margin
  36390. </summary>
  36391. </member>
  36392. <member name="F:NPOI.SS.UserModel.MarginType.RightMargin">
  36393. <summary>
  36394. referes to the right margin
  36395. </summary>
  36396. </member>
  36397. <member name="F:NPOI.SS.UserModel.MarginType.TopMargin">
  36398. <summary>
  36399. referes to the top margin
  36400. </summary>
  36401. </member>
  36402. <member name="F:NPOI.SS.UserModel.MarginType.BottomMargin">
  36403. <summary>
  36404. referes to the bottom margin
  36405. </summary>
  36406. </member>
  36407. <member name="T:NPOI.SS.UserModel.PanePosition">
  36408. <summary>
  36409. Define the position of the pane. One of lower/right, upper/right, lower/left and upper/left.
  36410. </summary>
  36411. </member>
  36412. <member name="F:NPOI.SS.UserModel.PanePosition.LowerRight">
  36413. <summary>
  36414. referes to the lower/right corner
  36415. </summary>
  36416. </member>
  36417. <member name="F:NPOI.SS.UserModel.PanePosition.UpperRight">
  36418. <summary>
  36419. referes to the upper/right corner
  36420. </summary>
  36421. </member>
  36422. <member name="F:NPOI.SS.UserModel.PanePosition.LowerLeft">
  36423. <summary>
  36424. referes to the lower/left corner
  36425. </summary>
  36426. </member>
  36427. <member name="F:NPOI.SS.UserModel.PanePosition.UpperLeft">
  36428. <summary>
  36429. referes to the upper/left corner
  36430. </summary>
  36431. </member>
  36432. <member name="P:NPOI.SS.UserModel.ITextbox.String">
  36433. @return the rich text string for this textbox.
  36434. </member>
  36435. <member name="P:NPOI.SS.UserModel.ITextbox.MarginLeft">
  36436. @return Returns the left margin within the textbox.
  36437. </member>
  36438. <member name="P:NPOI.SS.UserModel.ITextbox.MarginRight">
  36439. @return returns the right margin within the textbox.
  36440. </member>
  36441. <member name="P:NPOI.SS.UserModel.ITextbox.MarginTop">
  36442. @return returns the top margin within the textbox.
  36443. </member>
  36444. <member name="P:NPOI.SS.UserModel.ITextbox.MarginBottom">
  36445. s the bottom margin within the textbox.
  36446. </member>
  36447. <member name="T:NPOI.SS.UserModel.VerticalAlignment">
  36448. This enumeration value indicates the type of vertical alignment for a cell, i.e.,
  36449. whether it is aligned top, bottom, vertically centered, justified or distributed.
  36450. </member>
  36451. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Top">
  36452. The vertical alignment is aligned-to-top.
  36453. </member>
  36454. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Center">
  36455. The vertical alignment is centered across the height of the cell.
  36456. </member>
  36457. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Bottom">
  36458. The vertical alignment is aligned-to-bottom.
  36459. </member>
  36460. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Justify">
  36461. <p>
  36462. When text direction is horizontal: the vertical alignment of lines of text is distributed vertically,
  36463. where each line of text inside the cell is evenly distributed across the height of the cell,
  36464. with flush top and bottom margins.
  36465. </p>
  36466. <p>
  36467. When text direction is vertical: similar behavior as horizontal justification.
  36468. The alignment is justified (flush top and bottom in this case). For each line of text, each
  36469. line of the wrapped text in a cell is aligned to the top and bottom (except the last line).
  36470. If no single line of text wraps in the cell, then the text is not justified.
  36471. </p>
  36472. </member>
  36473. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Distributed">
  36474. <p>
  36475. When text direction is horizontal: the vertical alignment of lines of text is distributed vertically,
  36476. where each line of text inside the cell is evenly distributed across the height of the cell,
  36477. with flush top
  36478. </p>
  36479. <p>
  36480. When text direction is vertical: behaves exactly as distributed horizontal alignment.
  36481. The first words in a line of text (appearing at the top of the cell) are flush
  36482. with the top edge of the cell, and the last words of a line of text are flush with the bottom edge of the cell,
  36483. and the line of text is distributed evenly from top to bottom.
  36484. </p>
  36485. </member>
  36486. <member name="F:NPOI.SS.UserModel.SheetState.Visible">
  36487. <summary>
  36488. Indicates the sheet is visible.
  36489. </summary>
  36490. </member>
  36491. <member name="F:NPOI.SS.UserModel.SheetState.Hidden">
  36492. <summary>
  36493. Indicates the book window is hidden, but can be shown by the user via the user interface.
  36494. </summary>
  36495. </member>
  36496. <member name="F:NPOI.SS.UserModel.SheetState.VeryHidden">
  36497. <summary>
  36498. Indicates the sheet is hidden and cannot be shown in the user interface (UI).
  36499. </summary>
  36500. <remarks>
  36501. In Excel this state is only available programmatically in VBA:
  36502. ThisWorkbook.Sheets("MySheetName").Visible = xlSheetVeryHidden
  36503. </remarks>
  36504. </member>
  36505. <member name="F:NPOI.SS.Util.AreaReference.SHEET_NAME_DELIMITER">
  36506. The Char (!) that Separates sheet names from cell references
  36507. </member>
  36508. <member name="F:NPOI.SS.Util.AreaReference.CELL_DELIMITER">
  36509. The Char (:) that Separates the two cell references in a multi-cell area reference
  36510. </member>
  36511. <member name="F:NPOI.SS.Util.AreaReference.SPECIAL_NAME_DELIMITER">
  36512. The Char (') used to quote sheet names when they contain special Chars
  36513. </member>
  36514. <member name="M:NPOI.SS.Util.AreaReference.#ctor(System.String)">
  36515. Create an area ref from a string representation. Sheet names containing special Chars should be
  36516. delimited and escaped as per normal syntax rules for formulas.<br/>
  36517. The area reference must be contiguous (i.e. represent a single rectangle, not a Union of rectangles)
  36518. </member>
  36519. <member name="M:NPOI.SS.Util.AreaReference.#ctor(NPOI.SS.Util.CellReference,NPOI.SS.Util.CellReference)">
  36520. Creates an area ref from a pair of Cell References.
  36521. </member>
  36522. <member name="M:NPOI.SS.Util.AreaReference.IsContiguous(System.String)">
  36523. is the reference for a contiguous (i.e.
  36524. Unbroken) area, or is it made up of
  36525. several different parts?
  36526. (If it Is, you will need to call
  36527. ....
  36528. </member>
  36529. <member name="M:NPOI.SS.Util.AreaReference.IsWholeColumnReference(NPOI.SS.Util.CellReference,NPOI.SS.Util.CellReference)">
  36530. is the reference for a whole-column reference,
  36531. such as C:C or D:G ?
  36532. </member>
  36533. <member name="M:NPOI.SS.Util.AreaReference.GenerateContiguous(System.String)">
  36534. Takes a non-contiguous area reference, and
  36535. returns an array of contiguous area references.
  36536. </member>
  36537. <member name="M:NPOI.SS.Util.AreaReference.GetAllReferencedCells">
  36538. Returns a reference to every cell covered by this area
  36539. </member>
  36540. <member name="M:NPOI.SS.Util.AreaReference.FormatAsString">
  36541. Example return values:
  36542. <table border="0" cellpAdding="1" cellspacing="0" summary="Example return values">
  36543. <tr><th align='left'>Result</th><th align='left'>Comment</th></tr>
  36544. <tr><td>A1:A1</td><td>Single cell area reference without sheet</td></tr>
  36545. <tr><td>A1:$C$1</td><td>Multi-cell area reference without sheet</td></tr>
  36546. <tr><td>Sheet1!A$1:B4</td><td>Standard sheet name</td></tr>
  36547. <tr><td>'O''Brien''s Sales'!B5:C6' </td><td>Sheet name with special Chars</td></tr>
  36548. </table>
  36549. @return the text representation of this area reference as it would appear in a formula.
  36550. </member>
  36551. <member name="M:NPOI.SS.Util.AreaReference.SeparateAreaRefs(System.String)">
  36552. Separates Area refs in two parts and returns them as Separate elements in a String array,
  36553. each qualified with the sheet name (if present)
  36554. @return array with one or two elements. never <c>null</c>
  36555. </member>
  36556. <member name="P:NPOI.SS.Util.AreaReference.IsSingleCell">
  36557. @return <c>false</c> if this area reference involves more than one cell
  36558. </member>
  36559. <member name="P:NPOI.SS.Util.AreaReference.FirstCell">
  36560. @return the first cell reference which defines this area. Usually this cell is in the upper
  36561. left corner of the area (but this is not a requirement).
  36562. </member>
  36563. <member name="P:NPOI.SS.Util.AreaReference.LastCell">
  36564. Note - if this area reference refers to a single cell, the return value of this method will
  36565. be identical to that of <c>GetFirstCell()</c>
  36566. @return the second cell reference which defines this area. For multi-cell areas, this is
  36567. cell diagonally opposite the 'first cell'. Usually this cell is in the lower right corner
  36568. of the area (but this is not a requirement).
  36569. </member>
  36570. <member name="T:NPOI.SS.Util.CellRangeAddressBase">
  36571. See OOO documentation: excelfileformat.pdf sec 2.5.14 - 'Cell Range Address'<p/>
  36572. Common subclass of 8-bit and 16-bit versions
  36573. @author Josh Micich
  36574. </member>
  36575. <member name="M:NPOI.SS.Util.CellRangeAddressBase.Validate(NPOI.SS.SpreadsheetVersion)">
  36576. Validate the range limits against the supplied version of Excel
  36577. @param ssVersion the version of Excel to validate against
  36578. @throws IllegalArgumentException if the range limits are outside of the allowed range
  36579. </member>
  36580. <member name="M:NPOI.SS.Util.CellRangeAddressBase.ValidateRow(System.Int32,NPOI.SS.SpreadsheetVersion)">
  36581. Runs a bounds check for row numbers
  36582. @param row
  36583. </member>
  36584. <member name="M:NPOI.SS.Util.CellRangeAddressBase.ValidateColumn(System.Int32,NPOI.SS.SpreadsheetVersion)">
  36585. Runs a bounds check for column numbers
  36586. @param column
  36587. </member>
  36588. <member name="P:NPOI.SS.Util.CellRangeAddressBase.FirstColumn">
  36589. @return column number for the upper left hand corner
  36590. </member>
  36591. <member name="P:NPOI.SS.Util.CellRangeAddressBase.FirstRow">
  36592. @return row number for the upper left hand corner
  36593. </member>
  36594. <member name="P:NPOI.SS.Util.CellRangeAddressBase.LastColumn">
  36595. @return column number for the lower right hand corner
  36596. </member>
  36597. <member name="P:NPOI.SS.Util.CellRangeAddressBase.LastRow">
  36598. @return row number for the lower right hand corner
  36599. </member>
  36600. <member name="P:NPOI.SS.Util.CellRangeAddressBase.NumberOfCells">
  36601. @return the size of the range (number of cells in the area).
  36602. </member>
  36603. <member name="M:NPOI.SS.Util.CellRangeAddress.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  36604. Creates new cell range. Indexes are zero-based.
  36605. @param firstRow Index of first row
  36606. @param lastRow Index of last row (inclusive), must be equal to or larger than {@code firstRow}
  36607. @param firstCol Index of first column
  36608. @param lastCol Index of last column (inclusive), must be equal to or larger than {@code firstCol}
  36609. </member>
  36610. <member name="M:NPOI.SS.Util.CellRangeAddress.FormatAsString(System.String,System.Boolean)">
  36611. @return the text format of this range using specified sheet name.
  36612. </member>
  36613. <member name="M:NPOI.SS.Util.CellRangeAddress.ValueOf(System.String)">
  36614. <summary>
  36615. Creates a CellRangeAddress from a cell range reference string.
  36616. </summary>
  36617. <param name="reference">
  36618. usually a standard area ref (e.g. "B1:D8"). May be a single
  36619. cell ref (e.g. "B5") in which case the result is a 1 x 1 cell
  36620. range. May also be a whole row range (e.g. "3:5"), or a whole
  36621. column range (e.g. "C:F")
  36622. </param>
  36623. <returns>a CellRangeAddress object</returns>
  36624. </member>
  36625. <member name="F:NPOI.SS.Util.CellRangeAddressList._list">
  36626. List of <c>CellRangeAddress</c>es. Each structure represents a cell range
  36627. </member>
  36628. <member name="M:NPOI.SS.Util.CellRangeAddressList.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  36629. Convenience constructor for creating a <c>CellRangeAddressList</c> with a single
  36630. <c>CellRangeAddress</c>. Other <c>CellRangeAddress</c>es may be Added later.
  36631. </member>
  36632. <member name="M:NPOI.SS.Util.CellRangeAddressList.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  36633. @param in the RecordInputstream to read the record from
  36634. </member>
  36635. <member name="M:NPOI.SS.Util.CellRangeAddressList.CountRanges">
  36636. Get the number of following ADDR structures. The number of this
  36637. structures is automatically set when reading an Excel file and/or
  36638. increased when you manually Add a new ADDR structure . This is the reason
  36639. there isn't a set method for this field .
  36640. @return number of ADDR structures
  36641. </member>
  36642. <member name="M:NPOI.SS.Util.CellRangeAddressList.AddCellRangeAddress(System.Int32,System.Int32,System.Int32,System.Int32)">
  36643. Add a cell range structure.
  36644. @param firstRow - the upper left hand corner's row
  36645. @param firstCol - the upper left hand corner's col
  36646. @param lastRow - the lower right hand corner's row
  36647. @param lastCol - the lower right hand corner's col
  36648. @return the index of this ADDR structure
  36649. </member>
  36650. <member name="M:NPOI.SS.Util.CellRangeAddressList.GetCellRangeAddress(System.Int32)">
  36651. @return <c>CellRangeAddress</c> at the given index
  36652. </member>
  36653. <member name="M:NPOI.SS.Util.CellRangeAddressList.GetEncodedSize(System.Int32)">
  36654. @return the total size of for the specified number of ranges,
  36655. including the initial 2 byte range count
  36656. </member>
  36657. <member name="F:NPOI.SS.Util.NameType.None">
  36658. <summary>
  36659. Allow accessing the Initial value.
  36660. </summary>
  36661. </member>
  36662. <member name="T:NPOI.SS.Util.CellReference">
  36663. @author Avik Sengupta
  36664. @author Dennis doubleday (patch to seperateRowColumns())
  36665. </member>
  36666. <member name="F:NPOI.SS.Util.CellReference.ABSOLUTE_REFERENCE_MARKER">
  36667. The character ($) that signifies a row or column value is absolute instead of relative
  36668. </member>
  36669. <member name="F:NPOI.SS.Util.CellReference.SHEET_NAME_DELIMITER">
  36670. The character (!) that Separates sheet names from cell references
  36671. </member>
  36672. <member name="F:NPOI.SS.Util.CellReference.SPECIAL_NAME_DELIMITER">
  36673. The character (') used to quote sheet names when they contain special characters
  36674. </member>
  36675. <member name="F:NPOI.SS.Util.CellReference.CELL_REF_PATTERN">
  36676. Matches a run of one or more letters followed by a run of one or more digits.
  36677. The run of letters is group 1 and the run of digits is group 2.
  36678. Each group may optionally be prefixed with a single '$'.
  36679. </member>
  36680. <member name="F:NPOI.SS.Util.CellReference.COLUMN_REF_PATTERN">
  36681. Matches a run of one or more letters. The run of letters is group 1.
  36682. The text may optionally be prefixed with a single '$'.
  36683. </member>
  36684. <member name="F:NPOI.SS.Util.CellReference.ROW_REF_PATTERN">
  36685. Matches a run of one or more digits. The run of digits is group 1.
  36686. The text may optionally be prefixed with a single '$'.
  36687. </member>
  36688. <member name="F:NPOI.SS.Util.CellReference.NAMED_RANGE_NAME_PATTERN">
  36689. Named range names must start with a letter or underscore. Subsequent characters may include
  36690. digits or dot. (They can even end in dot).
  36691. </member>
  36692. <member name="M:NPOI.SS.Util.CellReference.#ctor(System.String)">
  36693. Create an cell ref from a string representation. Sheet names containing special characters should be
  36694. delimited and escaped as per normal syntax rules for formulas.
  36695. </member>
  36696. <member name="M:NPOI.SS.Util.CellReference.ConvertColStringToIndex(System.String)">
  36697. takes in a column reference portion of a CellRef and converts it from
  36698. ALPHA-26 number format to 0-based base 10.
  36699. 'A' -> 0
  36700. 'Z' -> 25
  36701. 'AA' -> 26
  36702. 'IV' -> 255
  36703. @return zero based column index
  36704. </member>
  36705. <member name="M:NPOI.SS.Util.CellReference.ConvertNumToColString(System.Int32)">
  36706. Takes in a 0-based base-10 column and returns a ALPHA-26
  36707. representation.
  36708. eg column #3 -> D
  36709. </member>
  36710. <member name="M:NPOI.SS.Util.CellReference.SeparateRefParts(System.String)">
  36711. Separates the row from the columns and returns an array of three Strings. The first element
  36712. is the sheet name. Only the first element may be null. The second element in is the column
  36713. name still in ALPHA-26 number format. The third element is the row.
  36714. </member>
  36715. <member name="M:NPOI.SS.Util.CellReference.FormatAsString">
  36716. Example return values:
  36717. <table border="0" cellpAdding="1" cellspacing="0" summary="Example return values">
  36718. <tr><th align='left'>Result</th><th align='left'>Comment</th></tr>
  36719. <tr><td>A1</td><td>Cell reference without sheet</td></tr>
  36720. <tr><td>Sheet1!A1</td><td>Standard sheet name</td></tr>
  36721. <tr><td>'O''Brien''s Sales'!A1'</td><td>Sheet name with special characters</td></tr>
  36722. </table>
  36723. @return the text representation of this cell reference as it would appear in a formula.
  36724. </member>
  36725. <member name="M:NPOI.SS.Util.CellReference.AppendCellReference(System.Text.StringBuilder)">
  36726. Appends cell reference with '$' markers for absolute values as required.
  36727. Sheet name is not included.
  36728. </member>
  36729. <member name="M:NPOI.SS.Util.CellReference.CellReferenceIsWithinRange(System.String,System.String,NPOI.SS.SpreadsheetVersion)">
  36730. Used to decide whether a name of the form "[A-Z]*[0-9]*" that appears in a formula can be
  36731. interpreted as a cell reference. Names of that form can be also used for sheets and/or
  36732. named ranges, and in those circumstances, the question of whether the potential cell
  36733. reference is valid (in range) becomes important.
  36734. <p/>
  36735. Note - that the maximum sheet size varies across Excel versions:
  36736. <p/>
  36737. <blockquote><table border="0" cellpadding="1" cellspacing="0"
  36738. summary="Notable cases.">
  36739. <tr><th>Version </th><th>File Format </th>
  36740. <th>Last Column </th><th>Last Row</th></tr>
  36741. <tr><td>97-2003</td><td>BIFF8</td><td>"IV" (2^8)</td><td>65536 (2^14)</td></tr>
  36742. <tr><td>2007</td><td>BIFF12</td><td>"XFD" (2^14)</td><td>1048576 (2^20)</td></tr>
  36743. </table></blockquote>
  36744. POI currently targets BIFF8 (Excel 97-2003), so the following behaviour can be observed for
  36745. this method:
  36746. <blockquote><table border="0" cellpadding="1" cellspacing="0"
  36747. summary="Notable cases.">
  36748. <tr><th>Input </th>
  36749. <th>Result </th></tr>
  36750. <tr><td>"A", "1"</td><td>true</td></tr>
  36751. <tr><td>"a", "111"</td><td>true</td></tr>
  36752. <tr><td>"A", "65536"</td><td>true</td></tr>
  36753. <tr><td>"A", "65537"</td><td>false</td></tr>
  36754. <tr><td>"iv", "1"</td><td>true</td></tr>
  36755. <tr><td>"IW", "1"</td><td>false</td></tr>
  36756. <tr><td>"AAA", "1"</td><td>false</td></tr>
  36757. <tr><td>"a", "111"</td><td>true</td></tr>
  36758. <tr><td>"Sheet", "1"</td><td>false</td></tr>
  36759. </table></blockquote>
  36760. @param colStr a string of only letter characters
  36761. @param rowStr a string of only digit characters
  36762. @return <c>true</c> if the row and col parameters are within range of a BIFF8 spreadsheet.
  36763. </member>
  36764. <member name="P:NPOI.SS.Util.CellReference.SheetName">
  36765. @return possibly <c>null</c> if this is a 2D reference. Special characters are not
  36766. escaped or delimited
  36767. </member>
  36768. <member name="P:NPOI.SS.Util.CellReference.CellRefParts">
  36769. Returns the three parts of the cell reference, the
  36770. Sheet name (or null if none supplied), the 1 based
  36771. row number, and the A based column letter.
  36772. This will not include any markers for absolute
  36773. references, so use {@link #formatAsString()}
  36774. to properly turn references into strings.
  36775. </member>
  36776. <member name="T:NPOI.SS.Util.CellUtil">
  36777. Various utility functions that make working with a cells and rows easier. The various methods
  36778. that deal with style's allow you to create your CellStyles as you need them. When you apply a
  36779. style change to a cell, the code will attempt to see if a style already exists that meets your
  36780. needs. If not, then it will create a new style. This is to prevent creating too many styles.
  36781. there is an upper limit in Excel on the number of styles that can be supported.
  36782. @author Eric Pugh epugh@upstate.com
  36783. @author (secondary) Avinash Kewalramani akewalramani@accelrys.com
  36784. </member>
  36785. <member name="M:NPOI.SS.Util.CellUtil.GetRow(System.Int32,NPOI.SS.UserModel.ISheet)">
  36786. Get a row from the spreadsheet, and create it if it doesn't exist.
  36787. @param rowIndex The 0 based row number
  36788. @param sheet The sheet that the row is part of.
  36789. @return The row indicated by the rowCounter
  36790. </member>
  36791. <member name="M:NPOI.SS.Util.CellUtil.GetCell(NPOI.SS.UserModel.IRow,System.Int32)">
  36792. Get a specific cell from a row. If the cell doesn't exist, then create it.
  36793. @param row The row that the cell is part of
  36794. @param columnIndex The column index that the cell is in.
  36795. @return The cell indicated by the column.
  36796. </member>
  36797. <member name="M:NPOI.SS.Util.CellUtil.CreateCell(NPOI.SS.UserModel.IRow,System.Int32,System.String,NPOI.SS.UserModel.ICellStyle)">
  36798. Creates a cell, gives it a value, and applies a style if provided
  36799. @param row the row to create the cell in
  36800. @param column the column index to create the cell in
  36801. @param value The value of the cell
  36802. @param style If the style is not null, then set
  36803. @return A new Cell
  36804. </member>
  36805. <member name="M:NPOI.SS.Util.CellUtil.CreateCell(NPOI.SS.UserModel.IRow,System.Int32,System.String)">
  36806. Create a cell, and give it a value.
  36807. @param row the row to create the cell in
  36808. @param column the column index to create the cell in
  36809. @param value The value of the cell
  36810. @return A new Cell.
  36811. </member>
  36812. <member name="M:NPOI.SS.Util.CellUtil.SetAlignment(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IWorkbook,System.Int16)">
  36813. Take a cell, and align it.
  36814. @param cell the cell to set the alignment for
  36815. @param workbook The workbook that is being worked with.
  36816. @param align the column alignment to use.
  36817. @see CellStyle for alignment options
  36818. </member>
  36819. <member name="M:NPOI.SS.Util.CellUtil.SetFont(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IWorkbook,NPOI.SS.UserModel.IFont)">
  36820. Take a cell, and apply a font to it
  36821. @param cell the cell to set the alignment for
  36822. @param workbook The workbook that is being worked with.
  36823. @param font The Font that you want to set...
  36824. </member>
  36825. <member name="M:NPOI.SS.Util.CellUtil.SetCellStyleProperty(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IWorkbook,System.String,System.Object)">
  36826. This method attempt to find an already existing CellStyle that matches what you want the
  36827. style to be. If it does not find the style, then it creates a new one. If it does create a
  36828. new one, then it applies the propertyName and propertyValue to the style. This is necessary
  36829. because Excel has an upper limit on the number of Styles that it supports.
  36830. @param workbook The workbook that is being worked with.
  36831. @param propertyName The name of the property that is to be changed.
  36832. @param propertyValue The value of the property that is to be changed.
  36833. @param cell The cell that needs it's style changes
  36834. </member>
  36835. <member name="M:NPOI.SS.Util.CellUtil.GetFormatProperties(NPOI.SS.UserModel.ICellStyle)">
  36836. Returns a map containing the format properties of the given cell style.
  36837. @param style cell style
  36838. @return map of format properties (String -> Object)
  36839. @see #setFormatProperties(org.apache.poi.ss.usermodel.CellStyle, org.apache.poi.ss.usermodel.Workbook, java.util.Map)
  36840. </member>
  36841. <member name="M:NPOI.SS.Util.CellUtil.SetFormatProperties(NPOI.SS.UserModel.ICellStyle,NPOI.SS.UserModel.IWorkbook,System.Collections.Generic.Dictionary{System.String,System.Object})">
  36842. Sets the format properties of the given style based on the given map.
  36843. @param style cell style
  36844. @param workbook parent workbook
  36845. @param properties map of format properties (String -> Object)
  36846. @see #getFormatProperties(CellStyle)
  36847. </member>
  36848. <member name="M:NPOI.SS.Util.CellUtil.GetShort(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  36849. Utility method that returns the named short value form the given map.
  36850. @return zero if the property does not exist, or is not a {@link Short}.
  36851. @param properties map of named properties (String -> Object)
  36852. @param name property name
  36853. @return property value, or zero
  36854. </member>
  36855. <member name="M:NPOI.SS.Util.CellUtil.GetBoolean(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  36856. Utility method that returns the named boolean value form the given map.
  36857. @return false if the property does not exist, or is not a {@link Boolean}.
  36858. @param properties map of properties (String -> Object)
  36859. @param name property name
  36860. @return property value, or false
  36861. </member>
  36862. <member name="M:NPOI.SS.Util.CellUtil.PutShort(System.Collections.Generic.Dictionary{System.String,System.Object},System.String,System.Int16)">
  36863. Utility method that puts the named short value to the given map.
  36864. @param properties map of properties (String -> Object)
  36865. @param name property name
  36866. @param value property value
  36867. </member>
  36868. <member name="M:NPOI.SS.Util.CellUtil.PutBoolean(System.Collections.Generic.Dictionary{System.String,System.Object},System.String,System.Boolean)">
  36869. Utility method that puts the named boolean value to the given map.
  36870. @param properties map of properties (String -> Object)
  36871. @param name property name
  36872. @param value property value
  36873. </member>
  36874. <member name="M:NPOI.SS.Util.CellUtil.TranslateUnicodeValues(NPOI.SS.UserModel.ICell)">
  36875. Looks for text in the cell that should be unicode, like an alpha and provides the
  36876. unicode version of it.
  36877. @param cell The cell to check for unicode values
  36878. @return translated to unicode
  36879. </member>
  36880. <member name="T:NPOI.SS.Util.CellWalk.ICellHandler">
  36881. Represents callback for CellWalk traverse method.
  36882. @author Roman Kashitsyn
  36883. </member>
  36884. <member name="M:NPOI.SS.Util.CellWalk.ICellHandler.OnCell(NPOI.SS.UserModel.ICell,NPOI.SS.Util.CellWalk.ICellWalkContext)">
  36885. @param cell current cell
  36886. @param ctx information about invokation context
  36887. </member>
  36888. <member name="T:NPOI.SS.Util.CellWalk.CellWalk">
  36889. Traverse cell range.
  36890. @author Roman Kashitsyn
  36891. </member>
  36892. <member name="M:NPOI.SS.Util.CellWalk.CellWalk.IsTraverseEmptyCells">
  36893. Should we call handler on empty (blank) cells. Default is
  36894. false.
  36895. @return true if handler should be called on empty (blank)
  36896. cells, false otherwise.
  36897. </member>
  36898. <member name="M:NPOI.SS.Util.CellWalk.CellWalk.SetTraverseEmptyCells(System.Boolean)">
  36899. Sets the traverseEmptyCells property.
  36900. @param traverseEmptyCells new property value
  36901. </member>
  36902. <member name="M:NPOI.SS.Util.CellWalk.CellWalk.Traverse(NPOI.SS.Util.CellWalk.ICellHandler)">
  36903. Traverse cell range from top left to bottom right cell.
  36904. @param handler handler to call on each appropriate cell
  36905. </member>
  36906. <member name="T:NPOI.SS.Util.CellWalk.CellWalk.SimpleCellWalkContext">
  36907. Inner class to hold walk context.
  36908. @author Roman Kashitsyn
  36909. </member>
  36910. <member name="T:NPOI.SS.Util.CellWalk.ICellWalkContext">
  36911. @author Roman Kashitsyn
  36912. </member>
  36913. <member name="P:NPOI.SS.Util.CellWalk.ICellWalkContext.OrdinalNumber">
  36914. Returns ordinal number of cell in range. Numeration starts
  36915. from top left cell and ends at bottom right cell. Here is a
  36916. brief example (number in cell is it's ordinal number):
  36917. <table border="1">
  36918. <tbody>
  36919. <tr><td>1</td><td>2</td></tr>
  36920. <tr><td>3</td><td>4</td></tr>
  36921. </tbody>
  36922. </table>
  36923. @return ordinal number of current cell
  36924. </member>
  36925. <member name="P:NPOI.SS.Util.CellWalk.ICellWalkContext.RowNumber">
  36926. Returns number of current row.
  36927. @return number of current row
  36928. </member>
  36929. <member name="P:NPOI.SS.Util.CellWalk.ICellWalkContext.ColumnNumber">
  36930. Returns number of current column.
  36931. @return number of current column
  36932. </member>
  36933. <member name="F:NPOI.SS.Util.ExpandedDouble._significand">
  36934. Always 64 bits long (MSB, bit-63 is '1')
  36935. </member>
  36936. <member name="M:NPOI.SS.Util.ExpandedDouble.NormaliseBaseTen">
  36937. Convert to an equivalent {@link NormalisedDecimal} representation having 15 decimal digits of precision in the
  36938. non-fractional bits of the significand.
  36939. </member>
  36940. <member name="M:NPOI.SS.Util.ExpandedDouble.GetBinaryExponent">
  36941. @return the number of non-fractional bits after the MSB of the significand
  36942. </member>
  36943. <member name="T:NPOI.SS.Util.SSNFormat">
  36944. Format class for Excel's SSN Format. This class mimics Excel's built-in
  36945. SSN Formatting.
  36946. @author James May
  36947. </member>
  36948. <member name="M:NPOI.SS.Util.SSNFormat.Format(System.Object,System.Globalization.CultureInfo)">
  36949. Format a number as an SSN
  36950. </member>
  36951. <member name="T:NPOI.SS.Util.ZipPlusFourFormat">
  36952. Format class for Excel Zip + 4 Format. This class mimics Excel's
  36953. built-in Formatting for Zip + 4.
  36954. @author James May
  36955. </member>
  36956. <member name="M:NPOI.SS.Util.ZipPlusFourFormat.Format(System.Object,System.Globalization.CultureInfo)">
  36957. Format a number as Zip + 4
  36958. </member>
  36959. <member name="T:NPOI.SS.Util.PhoneFormat">
  36960. Format class for Excel phone number Format. This class mimics Excel's
  36961. built-in phone number Formatting.
  36962. @author James May
  36963. </member>
  36964. <member name="M:NPOI.SS.Util.PhoneFormat.Format(System.Object,System.Globalization.CultureInfo)">
  36965. Format a number as a phone number
  36966. </member>
  36967. <member name="T:NPOI.SS.Util.ConstantStringFormat">
  36968. Format class that does nothing and always returns a constant string.
  36969. This format is used to simulate Excel's handling of a format string
  36970. of all # when the value is 0. Excel will output "", Java will output "0".
  36971. @see DataFormatter#createFormat(double, int, String)
  36972. </member>
  36973. <member name="F:NPOI.SS.Util.IEEEDouble.BIASED_EXPONENT_SPECIAL_VALUE">
  36974. The value the exponent field Gets for all <i>NaN</i> and <i>InfInity</i> values
  36975. </member>
  36976. <member name="M:NPOI.SS.Util.IEEEDouble.GetBiasedExponent(System.Int64)">
  36977. @param rawBits the 64 bit binary representation of the double value
  36978. @return the top 12 bits (sign and biased exponent value)
  36979. </member>
  36980. <member name="F:NPOI.SS.Util.MutableFPNumber.C_64">
  36981. Width of a long
  36982. </member>
  36983. <member name="F:NPOI.SS.Util.MutableFPNumber.MIN_PRECISION">
  36984. Minimum precision after discarding whole 32-bit words from the significand
  36985. </member>
  36986. <member name="F:NPOI.SS.Util.MutableFPNumber.BI_MIN_BASE">
  36987. The minimum value in 'Base-10 normalised form'.<br/>
  36988. When {@link #_binaryExponent} == 46 this is the the minimum {@link #_frac} value
  36989. (10<sup>14</sup>-0.05) * 2^17
  36990. <br/>
  36991. Values between (10<sup>14</sup>-0.05) and 10<sup>14</sup> will be represented as '1'
  36992. followed by 14 zeros.
  36993. Values less than (10<sup>14</sup>-0.05) will get Shifted by one more power of 10
  36994. This frac value rounds to '1' followed by fourteen zeros with an incremented decimal exponent
  36995. </member>
  36996. <member name="F:NPOI.SS.Util.MutableFPNumber.BI_MAX_BASE">
  36997. For 'Base-10 normalised form'<br/>
  36998. The maximum {@link #_frac} value when {@link #_binaryExponent} == 49
  36999. (10^15-0.5) * 2^14
  37000. </member>
  37001. <member name="M:NPOI.SS.Util.MutableFPNumber.Rounder.Round(NPOI.Util.BigInteger,System.Int32)">
  37002. @param nBits number of bits to shift right
  37003. </member>
  37004. <member name="T:NPOI.SS.Util.MutableFPNumber.TenPower">
  37005. Holds values for quick multiplication and division by 10
  37006. </member>
  37007. <member name="F:NPOI.SS.Util.NormalisedDecimal.EXPONENT_OFFSET">
  37008. Number of powers of ten Contained in the significand
  37009. </member>
  37010. <member name="F:NPOI.SS.Util.NormalisedDecimal.C_2_POW_19">
  37011. 2<sup>19</sup>
  37012. </member>
  37013. <member name="F:NPOI.SS.Util.NormalisedDecimal.FRAC_HALF">
  37014. the value of {@link #_fractionalPart} that represents 0.5
  37015. </member>
  37016. <member name="F:NPOI.SS.Util.NormalisedDecimal.MAX_REP_WHOLE_PART">
  37017. 10<sup>15</sup>
  37018. </member>
  37019. <member name="M:NPOI.SS.Util.NormalisedDecimal.RoundUnits">
  37020. Rounds at the digit with value 10<sup>decimalExponent</sup>
  37021. </member>
  37022. <member name="F:NPOI.SS.Util.NormalisedDecimal._relativeDecimalExponent">
  37023. The decimal exponent increased by one less than the digit count of {@link #_wholePart}
  37024. </member>
  37025. <member name="F:NPOI.SS.Util.NormalisedDecimal._wholePart">
  37026. The whole part of the significand (typically 15 digits).
  37027. 47-50 bits long (MSB may be anywhere from bit 46 to 49)
  37028. LSB is units bit.
  37029. </member>
  37030. <member name="F:NPOI.SS.Util.NormalisedDecimal._fractionalPart">
  37031. The fractional part of the significand.
  37032. 24 bits (only top 14-17 bits significant): a value between 0x000000 and 0xFFFF80
  37033. </member>
  37034. <member name="M:NPOI.SS.Util.NormalisedDecimal.NormaliseBaseTwo">
  37035. Convert to an equivalent {@link ExpandedDouble} representation (binary frac and exponent).
  37036. The resulting transformed object is easily Converted to a 64 bit IEEE double:
  37037. <ul>
  37038. <li>bits 2-53 of the {@link #GetSignificand()} become the 52 bit 'fraction'.</li>
  37039. <li>{@link #GetBinaryExponent()} is biased by 1023 to give the 'exponent'.</li>
  37040. </ul>
  37041. The sign bit must be obtained from somewhere else.
  37042. @return a new {@link NormalisedDecimal} normalised to base 2 representation.
  37043. </member>
  37044. <member name="M:NPOI.SS.Util.NormalisedDecimal.ComposeFrac">
  37045. @return the significand as a fixed point number (with 24 fraction bits and 47-50 whole bits)
  37046. </member>
  37047. <member name="M:NPOI.SS.Util.NormalisedDecimal.GetSignificantDecimalDigitsLastDigitRounded">
  37048. Rounds the first whole digit position (considers only units digit, not frational part).
  37049. Caller should check total digit count of result to see whether the rounding operation caused
  37050. a carry out of the most significant digit
  37051. </member>
  37052. <member name="M:NPOI.SS.Util.NormalisedDecimal.GetDecimalExponent">
  37053. @return the number of powers of 10 which have been extracted from the significand and binary exponent.
  37054. </member>
  37055. <member name="M:NPOI.SS.Util.NormalisedDecimal.CompareNormalised(NPOI.SS.Util.NormalisedDecimal)">
  37056. assumes both this and other are normalised
  37057. </member>
  37058. <member name="M:NPOI.SS.Util.NumberComparer.Compare(System.Double,System.Double)">
  37059. This class attempts to reproduce Excel's behaviour for comparing numbers. Results are
  37060. mostly the same as those from {@link Double#compare(double, double)} but with some
  37061. rounding. For numbers that are very close, this code converts to a format having 15
  37062. decimal digits of precision and a decimal exponent, before completing the comparison.
  37063. <p/>
  37064. In Excel formula evaluation, expressions like "(0.06-0.01)=0.05" evaluate to "TRUE" even
  37065. though the equivalent java expression is <c>false</c>. In examples like this,
  37066. Excel achieves the effect by having additional logic for comparison operations.
  37067. <p/>
  37068. <p/>
  37069. Note - Excel also gives special treatment to expressions like "0.06-0.01-0.05" which
  37070. evaluates to "0" (in java, rounding anomalies give a result of 6.9E-18). The special
  37071. behaviour here is for different reasons to the example above: If the last operator in a
  37072. cell formula is '+' or '-' and the result is less than 2<sup>50</sup> times smaller than
  37073. first operand, the result is rounded to zero.
  37074. Needless to say, the two rules are not consistent and it is relatively easy to find
  37075. examples that satisfy<br/>
  37076. "A=B" is "TRUE" but "A-B" is not "0"<br/>
  37077. and<br/>
  37078. "A=B" is "FALSE" but "A-B" is "0"<br/>
  37079. <br/>
  37080. This rule (for rounding the result of a final addition or subtraction), has not been
  37081. implemented in POI (as of Jul-2009).
  37082. @return <code>negative, 0, or positive</code> according to the standard Excel comparison
  37083. of values <c>a</c> and <c>b</c>.
  37084. </member>
  37085. <member name="M:NPOI.SS.Util.NumberComparer.CompareSubnormalNumbers(System.Int64,System.Int64,System.Boolean)">
  37086. If both numbers are subnormal, Excel seems to use standard comparison rules
  37087. </member>
  37088. <member name="M:NPOI.SS.Util.NumberComparer.CompareAcrossSubnormalThreshold(System.Int64,System.Int64,System.Boolean)">
  37089. Usually any normal number is greater (in magnitude) than any subnormal number.
  37090. However there are some anomalous cases around the threshold where Excel produces screwy results
  37091. @param isNegative both values are either negative or positive. This parameter affects the sign of the comparison result
  37092. @return usually <code>isNegative ? -1 : +1</code>
  37093. </member>
  37094. <member name="M:NPOI.SS.Util.NumberComparer.ToHex(System.Double)">
  37095. for formatting double values in error messages
  37096. </member>
  37097. <member name="M:NPOI.SS.Util.NumberToTextConverter.ToText(System.Double)">
  37098. Converts the supplied <c>value</c> to the text representation that Excel would give if
  37099. the value were to appear in an unformatted cell, or as a literal number in a formula.<br/>
  37100. Note - the results from this method differ slightly from those of <c>Double.ToString()</c>
  37101. In some special cases Excel behaves quite differently. This function attempts to reproduce
  37102. those results.
  37103. </member>
  37104. <member name="T:NPOI.SS.Util.PaneInformation">
  37105. Holds information regarding a split plane or freeze plane for a sheet.
  37106. </member>
  37107. <member name="F:NPOI.SS.Util.PaneInformation.PANE_LOWER_RIGHT">
  37108. Constant for active pane being the lower right
  37109. </member>
  37110. <member name="F:NPOI.SS.Util.PaneInformation.PANE_UPPER_RIGHT">
  37111. Constant for active pane being the upper right
  37112. </member>
  37113. <member name="F:NPOI.SS.Util.PaneInformation.PANE_LOWER_LEFT">
  37114. Constant for active pane being the lower left
  37115. </member>
  37116. <member name="F:NPOI.SS.Util.PaneInformation.PANE_UPPER_LEFT">
  37117. Constant for active pane being the upper left
  37118. </member>
  37119. <member name="M:NPOI.SS.Util.PaneInformation.IsFreezePane">
  37120. Returns true if this is a Freeze pane, false if it is a split pane.
  37121. </member>
  37122. <member name="P:NPOI.SS.Util.PaneInformation.VerticalSplitPosition">
  37123. Returns the vertical position of the split.
  37124. @return 0 if there is no vertical spilt,
  37125. or for a freeze pane the number of columns in the TOP pane,
  37126. or for a split plane the position of the split in 1/20th of a point.
  37127. </member>
  37128. <member name="P:NPOI.SS.Util.PaneInformation.HorizontalSplitPosition">
  37129. Returns the horizontal position of the split.
  37130. @return 0 if there is no horizontal spilt,
  37131. or for a freeze pane the number of rows in the LEFT pane,
  37132. or for a split plane the position of the split in 1/20th of a point.
  37133. </member>
  37134. <member name="P:NPOI.SS.Util.PaneInformation.HorizontalSplitTopRow">
  37135. For a horizontal split returns the top row in the BOTTOM pane.
  37136. @return 0 if there is no horizontal split, or the top row of the bottom pane.
  37137. </member>
  37138. <member name="P:NPOI.SS.Util.PaneInformation.VerticalSplitLeftColumn">
  37139. For a vertical split returns the left column in the RIGHT pane.
  37140. @return 0 if there is no vertical split, or the left column in the RIGHT pane.
  37141. </member>
  37142. <member name="P:NPOI.SS.Util.PaneInformation.ActivePane">
  37143. Returns the active pane
  37144. @see #PANE_LOWER_RIGHT
  37145. @see #PANE_UPPER_RIGHT
  37146. @see #PANE_LOWER_LEFT
  37147. @see #PANE_UPPER_LEFT
  37148. @return the active pane.
  37149. </member>
  37150. <member name="T:NPOI.SS.Util.Region">
  37151. Represents a from/to row/col square. This is a object primitive
  37152. that can be used to represent row,col - row,col just as one would use String
  37153. to represent a string of characters. Its really only useful for HSSF though.
  37154. @author Andrew C. Oliver acoliver at apache dot org
  37155. </member>
  37156. <member name="M:NPOI.SS.Util.Region.#ctor">
  37157. Creates a new instance of Region (0,0 - 0,0)
  37158. </member>
  37159. <member name="M:NPOI.SS.Util.Region.ConvertCellRangesToRegions(NPOI.SS.Util.CellRangeAddress[])">
  37160. Convert a List of CellRange objects to an array of regions
  37161. @param List of CellRange objects
  37162. @return regions
  37163. </member>
  37164. <member name="P:NPOI.SS.Util.Region.ColumnFrom">
  37165. Get the upper left hand corner column number
  37166. @return column number for the upper left hand corner
  37167. </member>
  37168. <member name="P:NPOI.SS.Util.Region.RowFrom">
  37169. Get the upper left hand corner row number
  37170. @return row number for the upper left hand corner
  37171. </member>
  37172. <member name="P:NPOI.SS.Util.Region.ColumnTo">
  37173. Get the lower right hand corner column number
  37174. @return column number for the lower right hand corner
  37175. </member>
  37176. <member name="P:NPOI.SS.Util.Region.RowTo">
  37177. Get the lower right hand corner row number
  37178. @return row number for the lower right hand corner
  37179. </member>
  37180. <member name="T:NPOI.SS.Util.RegionUtil">
  37181. Various utility functions that make working with a region of cells easier.
  37182. @author Eric Pugh epugh@upstate.com
  37183. @author (secondary) Avinash Kewalramani akewalramani@accelrys.com
  37184. </member>
  37185. <member name="M:NPOI.SS.Util.RegionUtil.SetBorderLeft(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  37186. Sets the left border for a region of cells by manipulating the cell style of the individual
  37187. cells on the left
  37188. @param border The new border
  37189. @param region The region that should have the border
  37190. @param workbook The workbook that the region is on.
  37191. @param sheet The sheet that the region is on.
  37192. </member>
  37193. <member name="M:NPOI.SS.Util.RegionUtil.SetLeftBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  37194. Sets the leftBorderColor attribute of the RegionUtil object
  37195. @param color The color of the border
  37196. @param region The region that should have the border
  37197. @param workbook The workbook that the region is on.
  37198. @param sheet The sheet that the region is on.
  37199. </member>
  37200. <member name="M:NPOI.SS.Util.RegionUtil.SetBorderRight(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  37201. Sets the borderRight attribute of the RegionUtil object
  37202. @param border The new border
  37203. @param region The region that should have the border
  37204. @param workbook The workbook that the region is on.
  37205. @param sheet The sheet that the region is on.
  37206. </member>
  37207. <member name="M:NPOI.SS.Util.RegionUtil.SetRightBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  37208. Sets the rightBorderColor attribute of the RegionUtil object
  37209. @param color The color of the border
  37210. @param region The region that should have the border
  37211. @param workbook The workbook that the region is on.
  37212. @param sheet The sheet that the region is on.
  37213. </member>
  37214. <member name="M:NPOI.SS.Util.RegionUtil.SetBorderBottom(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  37215. Sets the borderBottom attribute of the RegionUtil object
  37216. @param border The new border
  37217. @param region The region that should have the border
  37218. @param workbook The workbook that the region is on.
  37219. @param sheet The sheet that the region is on.
  37220. </member>
  37221. <member name="M:NPOI.SS.Util.RegionUtil.SetBottomBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  37222. Sets the bottomBorderColor attribute of the RegionUtil object
  37223. @param color The color of the border
  37224. @param region The region that should have the border
  37225. @param workbook The workbook that the region is on.
  37226. @param sheet The sheet that the region is on.
  37227. </member>
  37228. <member name="M:NPOI.SS.Util.RegionUtil.SetBorderTop(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  37229. Sets the borderBottom attribute of the RegionUtil object
  37230. @param border The new border
  37231. @param region The region that should have the border
  37232. @param workbook The workbook that the region is on.
  37233. @param sheet The sheet that the region is on.
  37234. </member>
  37235. <member name="M:NPOI.SS.Util.RegionUtil.SetTopBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  37236. Sets the topBorderColor attribute of the RegionUtil object
  37237. @param color The color of the border
  37238. @param region The region that should have the border
  37239. @param workbook The workbook that the region is on.
  37240. @param sheet The sheet that the region is on.
  37241. </member>
  37242. <member name="T:NPOI.SS.Util.RegionUtil.CellPropertySetter">
  37243. For setting the same property on many cells to the same value
  37244. </member>
  37245. <member name="T:NPOI.SS.Util.SheetBuilder">
  37246. Class {@code SheetBuilder} provides an easy way of building workbook sheets
  37247. from 2D array of Objects. It can be used in test cases to improve code
  37248. readability or in Swing applications with tables.
  37249. @author Roman Kashitsyn
  37250. </member>
  37251. <member name="M:NPOI.SS.Util.SheetBuilder.GetCreateEmptyCells">
  37252. Returns {@code true} if null array elements should be treated as empty
  37253. cells.
  37254. @return {@code true} if null objects should be treated as empty cells
  37255. and {@code false} otherwise
  37256. </member>
  37257. <member name="M:NPOI.SS.Util.SheetBuilder.SetCreateEmptyCells(System.Boolean)">
  37258. Specifies if null array elements should be treated as empty cells.
  37259. @param shouldCreateEmptyCells {@code true} if null array elements should be
  37260. treated as empty cells
  37261. @return {@code this}
  37262. </member>
  37263. <member name="M:NPOI.SS.Util.SheetBuilder.SetSheetName(System.String)">
  37264. Specifies name of the sheet to build. If not specified, default name (provided by
  37265. workbook) will be used instead.
  37266. @param sheetName sheet name to use
  37267. @return {@code this}
  37268. </member>
  37269. <member name="M:NPOI.SS.Util.SheetBuilder.Build">
  37270. Builds sheet from parent workbook and 2D array with cell
  37271. values. Creates rows anyway (even if row contains only null
  37272. cells), creates cells if either corresponding array value is not
  37273. null or createEmptyCells property is true.
  37274. The conversion is performed in the following way:
  37275. <p/>
  37276. <ul>
  37277. <li>Numbers become numeric cells.</li>
  37278. <li><code>java.util.Date</code> or <code>java.util.Calendar</code>
  37279. instances become date cells.</li>
  37280. <li>String with leading '=' char become formulas (leading '='
  37281. will be truncated).</li>
  37282. <li>Other objects become strings via <code>Object.toString()</code>
  37283. method call.</li>
  37284. </ul>
  37285. @return newly created sheet
  37286. </member>
  37287. <member name="M:NPOI.SS.Util.SheetBuilder.SetCellValue(NPOI.SS.UserModel.ICell,System.Object)">
  37288. Sets the cell value using object type information.
  37289. @param cell cell to change
  37290. @param value value to set
  37291. </member>
  37292. <member name="T:NPOI.SS.Util.SheetReferences">
  37293. Holds a collection of Sheet names and their associated
  37294. reference numbers.
  37295. @author Andrew C. Oliver (acoliver at apache dot org)
  37296. </member>
  37297. <member name="T:NPOI.SS.Util.SheetUtil">
  37298. Helper methods for when working with Usermodel sheets
  37299. @author Yegor Kozlov
  37300. </member>
  37301. <member name="F:NPOI.SS.Util.SheetUtil.dummyEvaluator">
  37302. Dummy formula Evaluator that does nothing.
  37303. YK: The only reason of having this class is that
  37304. {@link NPOI.SS.UserModel.DataFormatter#formatCellValue(NPOI.SS.UserModel.Cell)}
  37305. returns formula string for formula cells. Dummy Evaluator Makes it to format the cached formula result.
  37306. See Bugzilla #50021
  37307. </member>
  37308. <member name="M:NPOI.SS.Util.SheetUtil.GetCellWidth(NPOI.SS.UserModel.ICell,System.Int32,NPOI.SS.UserModel.DataFormatter,System.Boolean)">
  37309. Compute width of a single cell
  37310. @param cell the cell whose width is to be calculated
  37311. @param defaultCharWidth the width of a single character
  37312. @param formatter formatter used to prepare the text to be measured
  37313. @param useMergedCells whether to use merged cells
  37314. @return the width in pixels
  37315. </member>
  37316. <member name="M:NPOI.SS.Util.SheetUtil.GetColumnWidth(NPOI.SS.UserModel.ISheet,System.Int32,System.Boolean)">
  37317. Compute width of a column and return the result
  37318. @param sheet the sheet to calculate
  37319. @param column 0-based index of the column
  37320. @param useMergedCells whether to use merged cells
  37321. @return the width in pixels
  37322. </member>
  37323. <member name="M:NPOI.SS.Util.SheetUtil.GetColumnWidth(NPOI.SS.UserModel.ISheet,System.Int32,System.Boolean,System.Int32,System.Int32)">
  37324. Compute width of a column based on a subset of the rows and return the result
  37325. @param sheet the sheet to calculate
  37326. @param column 0-based index of the column
  37327. @param useMergedCells whether to use merged cells
  37328. @param firstRow 0-based index of the first row to consider (inclusive)
  37329. @param lastRow 0-based index of the last row to consider (inclusive)
  37330. @return the width in pixels
  37331. </member>
  37332. <member name="M:NPOI.SS.Util.SheetUtil.IFont2Font(NPOI.SS.UserModel.IFont)">
  37333. <summary>
  37334. Convert HSSFFont to Font.
  37335. </summary>
  37336. <param name="font1">The font.</param>
  37337. <returns></returns>
  37338. </member>
  37339. <member name="M:NPOI.SS.Util.SheetUtil.GetUniqueSheetName(NPOI.SS.UserModel.IWorkbook,System.String)">
  37340. Generate a valid sheet name based on the existing one. Used when cloning sheets.
  37341. @param srcName the original sheet name to
  37342. @return clone sheet name
  37343. </member>
  37344. <member name="M:NPOI.SS.Util.SheetUtil.GetCellWithMerges(NPOI.SS.UserModel.ISheet,System.Int32,System.Int32)">
  37345. Return the cell, taking account of merged regions. Allows you to find the
  37346. cell who's contents are Shown in a given position in the sheet.
  37347. <p>If the cell at the given co-ordinates is a merged cell, this will
  37348. return the primary (top-left) most cell of the merged region.</p>
  37349. <p>If the cell at the given co-ordinates is not in a merged region,
  37350. then will return the cell itself.</p>
  37351. <p>If there is no cell defined at the given co-ordinates, will return
  37352. null.</p>
  37353. </member>
  37354. <member name="T:NPOI.SS.Util.SSCellRange`1">
  37355. For POI internal use only
  37356. @author Josh Micich
  37357. </member>
  37358. <member name="T:NPOI.SS.Util.WorkbookUtil">
  37359. Helper methods for when working with Usermodel Workbooks
  37360. </member>
  37361. <member name="M:NPOI.SS.Util.WorkbookUtil.CreateSafeSheetName(System.String)">
  37362. Creates a valid sheet name, which is conform to the rules.
  37363. In any case, the result safely can be used for
  37364. {@link org.apache.poi.ss.usermodel.Workbook#setSheetName(int, String)}.
  37365. <br/>
  37366. Rules:
  37367. <ul>
  37368. <li>never null</li>
  37369. <li>minimum length is 1</li>
  37370. <li>maximum length is 31</li>
  37371. <li>doesn't contain special chars: 0x0000, 0x0003, / \ ? * ] [ </li>
  37372. <li>Sheet names must not begin or end with ' (apostrophe)</li>
  37373. </ul>
  37374. Invalid characters are replaced by one space character ' '.
  37375. @param nameProposal can be any string, will be truncated if necessary,
  37376. allowed to be null
  37377. @return a valid string, "empty" if to short, "null" if null
  37378. </member>
  37379. <member name="M:NPOI.SS.Util.WorkbookUtil.CreateSafeSheetName(System.String,System.Char)">
  37380. Creates a valid sheet name, which is conform to the rules.
  37381. In any case, the result safely can be used for
  37382. {@link org.apache.poi.ss.usermodel.Workbook#setSheetName(int, String)}.
  37383. <br />
  37384. Rules:
  37385. <ul>
  37386. <li>never null</li>
  37387. <li>minimum length is 1</li>
  37388. <li>maximum length is 31</li>
  37389. <li>doesn't contain special chars: : 0x0000, 0x0003, / \ ? * ] [ </li>
  37390. <li>Sheet names must not begin or end with ' (apostrophe)</li>
  37391. </ul>
  37392. @param nameProposal can be any string, will be truncated if necessary,
  37393. allowed to be null
  37394. @param replaceChar the char to replace invalid characters.
  37395. @return a valid string, "empty" if to short, "null" if null
  37396. </member>
  37397. <member name="M:NPOI.SS.Util.WorkbookUtil.ValidateSheetName(System.String)">
  37398. Validates sheet name.
  37399. <p>
  37400. The character count <c>MUST</c> be greater than or equal to 1 and less than or equal to 31.
  37401. The string MUST NOT contain the any of the following characters:
  37402. <ul>
  37403. <li> 0x0000 </li>
  37404. <li> 0x0003 </li>
  37405. <li> colon (:) </li>
  37406. <li> backslash (\) </li>
  37407. <li> asterisk (*) </li>
  37408. <li> question mark (?) </li>
  37409. <li> forward slash (/) </li>
  37410. <li> opening square bracket ([) </li>
  37411. <li> closing square bracket (]) </li>
  37412. </ul>
  37413. The string MUST NOT begin or end with the single quote (') character.
  37414. </p>
  37415. @param sheetName the name to validate
  37416. </member>
  37417. <member name="M:NPOI.Util.Arrays.Fill(System.Byte[],System.Byte)">
  37418. <summary>
  37419. Fills the specified array.
  37420. </summary>
  37421. <param name="array">The array.</param>
  37422. <param name="defaultValue">The default value.</param>
  37423. </member>
  37424. <member name="M:NPOI.Util.Arrays.Fill(System.Byte[],System.Int32,System.Int32,System.Byte)">
  37425. <summary>
  37426. Assigns the specified byte value to each element of the specified
  37427. range of the specified array of bytes. The range to be filled
  37428. extends from index <tt>fromIndex</tt>, inclusive, to index
  37429. <tt>toIndex</tt>, exclusive. (If <tt>fromIndex==toIndex</tt>, the
  37430. range to be filled is empty.)
  37431. </summary>
  37432. <param name="a">the array to be filled</param>
  37433. <param name="fromIndex">the index of the first element (inclusive) to be filled with the specified value</param>
  37434. <param name="toIndex">the index of the last element (exclusive) to be filled with the specified value</param>
  37435. <param name="val">the value to be stored in all elements of the array</param>
  37436. <exception cref="T:System.ArgumentException">if <c>fromIndex &gt; toIndex</c></exception>
  37437. <exception cref="T:System.IndexOutOfRangeException"> if <c>fromIndex &lt; 0</c> or <c>toIndex &gt; a.length</c></exception>
  37438. </member>
  37439. <member name="M:NPOI.Util.Arrays.RangeCheck(System.Int32,System.Int32,System.Int32)">
  37440. <summary>
  37441. Checks that {@code fromIndex} and {@code toIndex} are in
  37442. the range and throws an appropriate exception, if they aren't.
  37443. </summary>
  37444. <param name="length"></param>
  37445. <param name="fromIndex"></param>
  37446. <param name="toIndex"></param>
  37447. </member>
  37448. <member name="M:NPOI.Util.Arrays.AsList(System.Array)">
  37449. <summary>
  37450. Convert Array to ArrayList
  37451. </summary>
  37452. <param name="arr">source array</param>
  37453. <returns></returns>
  37454. </member>
  37455. <member name="M:NPOI.Util.Arrays.Fill(System.Int32[],System.Byte)">
  37456. <summary>
  37457. Fills the specified array.
  37458. </summary>
  37459. <param name="array">The array.</param>
  37460. <param name="defaultValue">The default value.</param>
  37461. </member>
  37462. <member name="M:NPOI.Util.Arrays.Equals(System.Object,System.Object)">
  37463. <summary>
  37464. Equals the specified a1.
  37465. </summary>
  37466. <param name="a1">The a1.</param>
  37467. <param name="b1">The b1.</param>
  37468. <returns></returns>
  37469. </member>
  37470. <member name="M:NPOI.Util.Arrays.Equals(System.Object[],System.Object[])">
  37471. Returns <c>true</c> if the two specified arrays of Objects are
  37472. <i>equal</i> to one another. The two arrays are considered equal if
  37473. both arrays contain the same number of elements, and all corresponding
  37474. pairs of elements in the two arrays are equal. Two objects <c>e1</c>
  37475. and <c>e2</c> are considered <i>equal</i> if <c>(e1==null ? e2==null
  37476. : e1.equals(e2))</c>. In other words, the two arrays are equal if
  37477. they contain the same elements in the same order. Also, two array
  37478. references are considered equal if both are <c>null</c>.
  37479. @param a one array to be tested for equality
  37480. @param a2 the other array to be tested for equality
  37481. @return <c>true</c> if the two arrays are equal
  37482. </member>
  37483. <member name="M:NPOI.Util.Arrays.ArrayMoveWithin(System.Object[],System.Int32,System.Int32,System.Int32)">
  37484. <summary>
  37485. Moves a number of entries in an array to another point in the array, shifting those inbetween as required.
  37486. </summary>
  37487. <param name="array">The array to alter</param>
  37488. <param name="moveFrom">The (0 based) index of the first entry to move</param>
  37489. <param name="moveTo">The (0 based) index of the positition to move to</param>
  37490. <param name="numToMove">The number of entries to move</param>
  37491. </member>
  37492. <member name="M:NPOI.Util.Arrays.CopyOf(System.Byte[],System.Int32)">
  37493. <summary>
  37494. Copies the specified array, truncating or padding with zeros (if
  37495. necessary) so the copy has the specified length. This method is temporary
  37496. replace for Arrays.copyOf() until we start to require JDK 1.6.
  37497. </summary>
  37498. <param name="source">the array to be copied</param>
  37499. <param name="newLength">the length of the copy to be returned</param>
  37500. <returns>a copy of the original array, truncated or padded with zeros to obtain the specified length</returns>
  37501. </member>
  37502. <member name="M:NPOI.Util.Arrays.HashCode(System.Int64[])">
  37503. Returns a hash code based on the contents of the specified array.
  37504. For any two <tt>long</tt> arrays <tt>a</tt> and <tt>b</tt>
  37505. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  37506. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  37507. The value returned by this method is the same value that would be
  37508. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  37509. method on a {@link List} Containing a sequence of {@link Long}
  37510. instances representing the elements of <tt>a</tt> in the same order.
  37511. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  37512. @param a the array whose hash value to compute
  37513. @return a content-based hash code for <tt>a</tt>
  37514. @since 1.5
  37515. </member>
  37516. <member name="M:NPOI.Util.Arrays.HashCode(System.Int32[])">
  37517. Returns a hash code based on the contents of the specified array.
  37518. For any two non-null <tt>int</tt> arrays <tt>a</tt> and <tt>b</tt>
  37519. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  37520. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  37521. The value returned by this method is the same value that would be
  37522. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  37523. method on a {@link List} Containing a sequence of {@link int}
  37524. instances representing the elements of <tt>a</tt> in the same order.
  37525. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  37526. @param a the array whose hash value to compute
  37527. @return a content-based hash code for <tt>a</tt>
  37528. @since 1.5
  37529. </member>
  37530. <member name="M:NPOI.Util.Arrays.HashCode(System.Int16[])">
  37531. Returns a hash code based on the contents of the specified array.
  37532. For any two <tt>short</tt> arrays <tt>a</tt> and <tt>b</tt>
  37533. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  37534. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  37535. The value returned by this method is the same value that would be
  37536. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  37537. method on a {@link List} Containing a sequence of {@link short}
  37538. instances representing the elements of <tt>a</tt> in the same order.
  37539. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  37540. @param a the array whose hash value to compute
  37541. @return a content-based hash code for <tt>a</tt>
  37542. @since 1.5
  37543. </member>
  37544. <member name="M:NPOI.Util.Arrays.HashCode(System.Char[])">
  37545. Returns a hash code based on the contents of the specified array.
  37546. For any two <tt>char</tt> arrays <tt>a</tt> and <tt>b</tt>
  37547. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  37548. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  37549. The value returned by this method is the same value that would be
  37550. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  37551. method on a {@link List} Containing a sequence of {@link Character}
  37552. instances representing the elements of <tt>a</tt> in the same order.
  37553. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  37554. @param a the array whose hash value to compute
  37555. @return a content-based hash code for <tt>a</tt>
  37556. @since 1.5
  37557. </member>
  37558. <member name="M:NPOI.Util.Arrays.HashCode(System.Byte[])">
  37559. Returns a hash code based on the contents of the specified array.
  37560. For any two <tt>byte</tt> arrays <tt>a</tt> and <tt>b</tt>
  37561. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  37562. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  37563. The value returned by this method is the same value that would be
  37564. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  37565. method on a {@link List} Containing a sequence of {@link Byte}
  37566. instances representing the elements of <tt>a</tt> in the same order.
  37567. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  37568. @param a the array whose hash value to compute
  37569. @return a content-based hash code for <tt>a</tt>
  37570. @since 1.5
  37571. </member>
  37572. <member name="M:NPOI.Util.Arrays.HashCode(System.Boolean[])">
  37573. Returns a hash code based on the contents of the specified array.
  37574. For any two <tt>bool</tt> arrays <tt>a</tt> and <tt>b</tt>
  37575. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  37576. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  37577. The value returned by this method is the same value that would be
  37578. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  37579. method on a {@link List} Containing a sequence of {@link Boolean}
  37580. instances representing the elements of <tt>a</tt> in the same order.
  37581. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  37582. @param a the array whose hash value to compute
  37583. @return a content-based hash code for <tt>a</tt>
  37584. @since 1.5
  37585. </member>
  37586. <member name="M:NPOI.Util.Arrays.HashCode(System.Single[])">
  37587. Returns a hash code based on the contents of the specified array.
  37588. For any two <tt>float</tt> arrays <tt>a</tt> and <tt>b</tt>
  37589. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  37590. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  37591. The value returned by this method is the same value that would be
  37592. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  37593. method on a {@link List} Containing a sequence of {@link Float}
  37594. instances representing the elements of <tt>a</tt> in the same order.
  37595. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  37596. @param a the array whose hash value to compute
  37597. @return a content-based hash code for <tt>a</tt>
  37598. @since 1.5
  37599. </member>
  37600. <member name="M:NPOI.Util.Arrays.HashCode(System.Double[])">
  37601. Returns a hash code based on the contents of the specified array.
  37602. For any two <tt>double</tt> arrays <tt>a</tt> and <tt>b</tt>
  37603. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  37604. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  37605. The value returned by this method is the same value that would be
  37606. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  37607. method on a {@link List} Containing a sequence of {@link Double}
  37608. instances representing the elements of <tt>a</tt> in the same order.
  37609. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  37610. @param a the array whose hash value to compute
  37611. @return a content-based hash code for <tt>a</tt>
  37612. @since 1.5
  37613. </member>
  37614. <member name="M:NPOI.Util.Arrays.HashCode(System.Object[])">
  37615. Returns a hash code based on the contents of the specified array. If
  37616. the array Contains other arrays as elements, the hash code is based on
  37617. their identities rather than their contents. It is therefore
  37618. acceptable to invoke this method on an array that Contains itself as an
  37619. element, either directly or indirectly through one or more levels of
  37620. arrays.
  37621. For any two arrays <tt>a</tt> and <tt>b</tt> such that
  37622. <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  37623. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  37624. The value returned by this method is equal to the value that would
  37625. be returned by <tt>Arrays.AsList(a).HashCode()</tt>, unless <tt>a</tt>
  37626. is <tt>null</tt>, in which case <tt>0</tt> is returned.
  37627. @param a the array whose content-based hash code to compute
  37628. @return a content-based hash code for <tt>a</tt>
  37629. @see #deepHashCode(Object[])
  37630. @since 1.5
  37631. </member>
  37632. <member name="M:NPOI.Util.Arrays.DeepHashCode(System.Object[])">
  37633. Returns a hash code based on the "deep contents" of the specified
  37634. array. If the array Contains other arrays as elements, the
  37635. hash code is based on their contents and so on, ad infInitum.
  37636. It is therefore unacceptable to invoke this method on an array that
  37637. Contains itself as an element, either directly or indirectly through
  37638. one or more levels of arrays. The behavior of such an invocation is
  37639. undefined.
  37640. For any two arrays <tt>a</tt> and <tt>b</tt> such that
  37641. <tt>Arrays.DeepEquals(a, b)</tt>, it is also the case that
  37642. <tt>Arrays.DeepHashCode(a) == Arrays.DeepHashCode(b)</tt>.
  37643. The computation of the value returned by this method is similar to
  37644. that of the value returned by {@link List#hashCode()} on a list
  37645. Containing the same elements as <tt>a</tt> in the same order, with one
  37646. difference: If an element <tt>e</tt> of <tt>a</tt> is itself an array,
  37647. its hash code is computed not by calling <tt>e.HashCode()</tt>, but as
  37648. by calling the appropriate overloading of <tt>Arrays.HashCode(e)</tt>
  37649. if <tt>e</tt> is an array of a primitive type, or as by calling
  37650. <tt>Arrays.DeepHashCode(e)</tt> recursively if <tt>e</tt> is an array
  37651. of a reference type. If <tt>a</tt> is <tt>null</tt>, this method
  37652. returns 0.
  37653. @param a the array whose deep-content-based hash code to compute
  37654. @return a deep-content-based hash code for <tt>a</tt>
  37655. @see #hashCode(Object[])
  37656. @since 1.5
  37657. </member>
  37658. <member name="M:NPOI.Util.Arrays.DeepEquals(System.Object[],System.Object[])">
  37659. Returns <tt>true</tt> if the two specified arrays are <i>deeply
  37660. Equal</i> to one another. Unlike the {@link #Equals(Object[],Object[])}
  37661. method, this method is appropriate for use with nested arrays of
  37662. arbitrary depth.
  37663. Two array references are considered deeply equal if both
  37664. are <tt>null</tt>, or if they refer to arrays that contain the same
  37665. number of elements and all corresponding pairs of elements in the two
  37666. arrays are deeply Equal.
  37667. Two possibly <tt>null</tt> elements <tt>e1</tt> and <tt>e2</tt> are
  37668. deeply equal if any of the following conditions hold:
  37669. <ul>
  37670. <li> <tt>e1</tt> and <tt>e2</tt> are both arrays of object reference
  37671. types, and <tt>Arrays.DeepEquals(e1, e2) would return true</tt></li>
  37672. <li> <tt>e1</tt> and <tt>e2</tt> are arrays of the same primitive
  37673. type, and the appropriate overloading of
  37674. <tt>Arrays.Equals(e1, e2)</tt> would return true.</li>
  37675. <li> <tt>e1 == e2</tt></li>
  37676. <li> <tt>e1.Equals(e2)</tt> would return true.</li>
  37677. </ul>
  37678. Note that this defInition permits <tt>null</tt> elements at any depth.
  37679. If either of the specified arrays contain themselves as elements
  37680. either directly or indirectly through one or more levels of arrays,
  37681. the behavior of this method is undefined.
  37682. @param a1 one array to be tested for Equality
  37683. @param a2 the other array to be tested for Equality
  37684. @return <tt>true</tt> if the two arrays are equal
  37685. @see #Equals(Object[],Object[])
  37686. @see Objects#deepEquals(Object, Object)
  37687. @since 1.5
  37688. </member>
  37689. <member name="M:NPOI.Util.Arrays.ToString(System.Int64[])">
  37690. Returns a string representation of the contents of the specified array.
  37691. The string representation consists of a list of the array's elements,
  37692. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  37693. Separated by the characters <tt>", "</tt> (a comma followed by a
  37694. space). Elements are Converted to strings as by
  37695. <tt>String.ValueOf(long)</tt>. Returns <tt>"null"</tt> if <tt>a</tt>
  37696. is <tt>null</tt>.
  37697. @param a the array whose string representation to return
  37698. @return a string representation of <tt>a</tt>
  37699. @since 1.5
  37700. </member>
  37701. <member name="M:NPOI.Util.Arrays.ToString(System.Int32[])">
  37702. Returns a string representation of the contents of the specified array.
  37703. The string representation consists of a list of the array's elements,
  37704. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  37705. Separated by the characters <tt>", "</tt> (a comma followed by a
  37706. space). Elements are Converted to strings as by
  37707. <tt>String.ValueOf(int)</tt>. Returns <tt>"null"</tt> if <tt>a</tt> is
  37708. <tt>null</tt>.
  37709. @param a the array whose string representation to return
  37710. @return a string representation of <tt>a</tt>
  37711. @since 1.5
  37712. </member>
  37713. <member name="M:NPOI.Util.Arrays.ToString(System.Int16[])">
  37714. Returns a string representation of the contents of the specified array.
  37715. The string representation consists of a list of the array's elements,
  37716. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  37717. Separated by the characters <tt>", "</tt> (a comma followed by a
  37718. space). Elements are Converted to strings as by
  37719. <tt>String.ValueOf(short)</tt>. Returns <tt>"null"</tt> if <tt>a</tt>
  37720. is <tt>null</tt>.
  37721. @param a the array whose string representation to return
  37722. @return a string representation of <tt>a</tt>
  37723. @since 1.5
  37724. </member>
  37725. <member name="M:NPOI.Util.Arrays.ToString(System.Char[])">
  37726. Returns a string representation of the contents of the specified array.
  37727. The string representation consists of a list of the array's elements,
  37728. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  37729. Separated by the characters <tt>", "</tt> (a comma followed by a
  37730. space). Elements are Converted to strings as by
  37731. <tt>String.ValueOf(char)</tt>. Returns <tt>"null"</tt> if <tt>a</tt>
  37732. is <tt>null</tt>.
  37733. @param a the array whose string representation to return
  37734. @return a string representation of <tt>a</tt>
  37735. @since 1.5
  37736. </member>
  37737. <member name="M:NPOI.Util.Arrays.ToString(System.Byte[])">
  37738. Returns a string representation of the contents of the specified array.
  37739. The string representation consists of a list of the array's elements,
  37740. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements
  37741. are Separated by the characters <tt>", "</tt> (a comma followed
  37742. by a space). Elements are Converted to strings as by
  37743. <tt>String.ValueOf(byte)</tt>. Returns <tt>"null"</tt> if
  37744. <tt>a</tt> is <tt>null</tt>.
  37745. @param a the array whose string representation to return
  37746. @return a string representation of <tt>a</tt>
  37747. @since 1.5
  37748. </member>
  37749. <member name="M:NPOI.Util.Arrays.ToString(System.Boolean[])">
  37750. Returns a string representation of the contents of the specified array.
  37751. The string representation consists of a list of the array's elements,
  37752. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  37753. Separated by the characters <tt>", "</tt> (a comma followed by a
  37754. space). Elements are Converted to strings as by
  37755. <tt>String.ValueOf(bool)</tt>. Returns <tt>"null"</tt> if
  37756. <tt>a</tt> is <tt>null</tt>.
  37757. @param a the array whose string representation to return
  37758. @return a string representation of <tt>a</tt>
  37759. @since 1.5
  37760. </member>
  37761. <member name="M:NPOI.Util.Arrays.ToString(System.Single[])">
  37762. Returns a string representation of the contents of the specified array.
  37763. The string representation consists of a list of the array's elements,
  37764. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  37765. Separated by the characters <tt>", "</tt> (a comma followed by a
  37766. space). Elements are Converted to strings as by
  37767. <tt>String.ValueOf(float)</tt>. Returns <tt>"null"</tt> if <tt>a</tt>
  37768. is <tt>null</tt>.
  37769. @param a the array whose string representation to return
  37770. @return a string representation of <tt>a</tt>
  37771. @since 1.5
  37772. </member>
  37773. <member name="M:NPOI.Util.Arrays.ToString(System.Double[])">
  37774. Returns a string representation of the contents of the specified array.
  37775. The string representation consists of a list of the array's elements,
  37776. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  37777. Separated by the characters <tt>", "</tt> (a comma followed by a
  37778. space). Elements are Converted to strings as by
  37779. <tt>String.ValueOf(double)</tt>. Returns <tt>"null"</tt> if <tt>a</tt>
  37780. is <tt>null</tt>.
  37781. @param a the array whose string representation to return
  37782. @return a string representation of <tt>a</tt>
  37783. @since 1.5
  37784. </member>
  37785. <member name="M:NPOI.Util.Arrays.DeepToString(System.Object[])">
  37786. Returns a string representation of the "deep contents" of the specified
  37787. array. If the array Contains other arrays as elements, the string
  37788. representation Contains their contents and so on. This method is
  37789. designed for Converting multidimensional arrays to strings.
  37790. The string representation consists of a list of the array's
  37791. elements, enclosed in square brackets (<tt>"[]"</tt>). Adjacent
  37792. elements are Separated by the characters <tt>", "</tt> (a comma
  37793. followed by a space). Elements are Converted to strings as by
  37794. <tt>String.ValueOf(Object)</tt>, unless they are themselves
  37795. arrays.
  37796. If an element <tt>e</tt> is an array of a primitive type, it is
  37797. Converted to a string as by invoking the appropriate overloading of
  37798. <tt>Arrays.ToString(e)</tt>. If an element <tt>e</tt> is an array of a
  37799. reference type, it is Converted to a string as by invoking
  37800. this method recursively.
  37801. To avoid infInite recursion, if the specified array Contains itself
  37802. as an element, or Contains an indirect reference to itself through one
  37803. or more levels of arrays, the self-reference is Converted to the string
  37804. <tt>"[...]"</tt>. For example, an array Containing only a reference
  37805. to itself would be rendered as <tt>"[[...]]"</tt>.
  37806. This method returns <tt>"null"</tt> if the specified array
  37807. is <tt>null</tt>.
  37808. @param a the array whose string representation to return
  37809. @return a string representation of <tt>a</tt>
  37810. @see #ToString(Object[])
  37811. @since 1.5
  37812. </member>
  37813. <member name="M:NPOI.Util.Arrays.ToString(System.Object[])">
  37814. Returns a string representation of the contents of the specified array.
  37815. If the array contains other arrays as elements, they are converted to
  37816. strings by the {@link Object#toString} method inherited from
  37817. <tt>Object</tt>, which describes their <i>identities</i> rather than
  37818. their contents.
  37819. <p>The value returned by this method is equal to the value that would
  37820. be returned by <tt>Arrays.asList(a).toString()</tt>, unless <tt>a</tt>
  37821. is <tt>null</tt>, in which case <tt>"null"</tt> is returned.</p>
  37822. @param a the array whose string representation to return
  37823. @return a string representation of <tt>a</tt>
  37824. @see #deepToString(Object[])
  37825. @since 1.5
  37826. </member>
  37827. <member name="F:NPOI.Util.BigInteger.LONG_MASK">
  37828. This mask is used to obtain the value of an int as if it were unsigned.
  37829. </member>
  37830. <member name="F:NPOI.Util.BigInteger._signum">
  37831. The signum of this BigInteger: -1 for negative, 0 for zero, or
  37832. 1 for positive. Note that the BigInteger zero <i>must</i> have
  37833. a signum of 0. This is necessary to ensures that there is exactly one
  37834. representation for each BigInteger value.
  37835. @serial
  37836. </member>
  37837. <member name="F:NPOI.Util.BigInteger.mag">
  37838. The magnitude of this BigInteger, in <i>big-endian</i> order: the
  37839. zeroth element of this array is the most-significant int of the
  37840. magnitude. The magnitude must be "minimal" in that the most-significant
  37841. int ({@code mag[0]}) must be non-zero. This is necessary to
  37842. ensure that there is exactly one representation for each BigInteger
  37843. value. Note that this implies that the BigInteger zero has a
  37844. zero-length mag array.
  37845. </member>
  37846. <member name="F:NPOI.Util.BigInteger.bitCount">
  37847. One plus the bitCount of this BigInteger. Zeros means unitialized.
  37848. @serial
  37849. @see #bitCount
  37850. @deprecated Deprecated since logical value is offset from stored
  37851. value and correction factor is applied in accessor method.
  37852. </member>
  37853. <member name="F:NPOI.Util.BigInteger.bitLength">
  37854. One plus the bitLength of this BigInteger. Zeros means unitialized.
  37855. (either value is acceptable).
  37856. @serial
  37857. @see #bitLength()
  37858. @deprecated Deprecated since logical value is offset from stored
  37859. value and correction factor is applied in accessor method.
  37860. </member>
  37861. <member name="F:NPOI.Util.BigInteger.firstNonzeroIntNum">
  37862. Two plus the index of the lowest-order int in the magnitude of this
  37863. BigInteger that contains a nonzero int, or -2 (either value is acceptable).
  37864. The least significant int has int-number 0, the next int in order of
  37865. increasing significance has int-number 1, and so forth.
  37866. @deprecated Deprecated since logical value is offset from stored
  37867. value and correction factor is applied in accessor method.
  37868. </member>
  37869. <member name="M:NPOI.Util.BigInteger.#ctor(System.Int32[],System.Int32)">
  37870. This internal constructor differs from its public cousin
  37871. with the arguments reversed in two ways: it assumes that its
  37872. arguments are correct, and it doesn't copy the magnitude array.
  37873. </member>
  37874. <member name="M:NPOI.Util.BigInteger.#ctor(System.Byte[])">
  37875. Translates a byte array containing the two's-complement binary
  37876. representation of a BigInteger into a BigInteger. The input array is
  37877. assumed to be in <i>big-endian</i> byte-order: the most significant
  37878. byte is in the zeroth element.
  37879. @param val big-endian two's-complement binary representation of
  37880. BigInteger.
  37881. @throws NumberFormatException {@code val} is zero bytes long.
  37882. </member>
  37883. <member name="M:NPOI.Util.BigInteger.#ctor(System.Int32[])">
  37884. This private constructor translates an int array containing the
  37885. two's-complement binary representation of a BigInteger into a
  37886. BigInteger. The input array is assumed to be in <i>big-endian</i>
  37887. int-order: the most significant int is in the zeroth element.
  37888. </member>
  37889. <member name="M:NPOI.Util.BigInteger.#ctor(System.Int64)">
  37890. Constructs a BigInteger with the specified value, which may not be zero.
  37891. </member>
  37892. <member name="M:NPOI.Util.BigInteger.TrustedStripLeadingZeroInts(System.Int32[])">
  37893. Returns the input array stripped of any leading zero bytes.
  37894. Since the source is trusted the copying may be skipped.
  37895. </member>
  37896. <member name="M:NPOI.Util.BigInteger.ToString(System.Int32)">
  37897. Returns the String representation of this BigInteger in the
  37898. given radix. If the radix is outside the range from {@link
  37899. Character#Min_RADIX} to {@link Character#Max_RADIX} inclusive,
  37900. it will default to 10 (as is the case for
  37901. {@code Integer.toString}). The digit-to-character mapping
  37902. provided by {@code Character.forDigit} is used, and a minus
  37903. sign is prepended if appropriate. (This representation is
  37904. compatible with the {@link #BigInteger(String, int) (String,
  37905. int)} constructor.)
  37906. @param radix radix of the String representation.
  37907. @return String representation of this BigInteger in the given radix.
  37908. @see Integer#toString
  37909. @see Character#forDigit
  37910. @see #BigInteger(java.lang.String, int)
  37911. </member>
  37912. <member name="F:NPOI.Util.BigInteger.ZERO">
  37913. The BigInteger constant zero.
  37914. @since 1.2
  37915. </member>
  37916. <member name="F:NPOI.Util.BigInteger.One">
  37917. The BigInteger constant one.
  37918. @since 1.2
  37919. </member>
  37920. <member name="F:NPOI.Util.BigInteger.Two">
  37921. The BigInteger constant two. (Not exported.)
  37922. </member>
  37923. <member name="F:NPOI.Util.BigInteger.TEN">
  37924. The BigInteger constant ten.
  37925. @since 1.5
  37926. </member>
  37927. <member name="M:NPOI.Util.BigInteger.ValueOf(System.Int64)">
  37928. Returns a BigInteger whose value is equal to that of the
  37929. specified {@code long}. This "static factory method" is
  37930. provided in preference to a ({@code long}) constructor
  37931. because it allows for reuse of frequently used BigIntegers.
  37932. @param val value of the BigInteger to return.
  37933. @return a BigInteger with the specified value.
  37934. </member>
  37935. <member name="M:NPOI.Util.BigInteger.ValueOf(System.Int32[])">
  37936. Returns a BigInteger with the given two's complement representation.
  37937. Assumes that the input array will not be modified (the returned
  37938. BigInteger will reference the input array if feasible).
  37939. </member>
  37940. <member name="M:NPOI.Util.BigInteger.BitLengthForInt(System.Int32)">
  37941. Package private method to return bit length for an integer.
  37942. </member>
  37943. <member name="M:NPOI.Util.BigInteger.BitCount">
  37944. Returns the number of bits in the two's complement representation
  37945. of this BigInteger that differ from its sign bit. This method is
  37946. useful when implementing bit-vector style sets atop BigIntegers.
  37947. @return number of bits in the two's complement representation
  37948. of this BigInteger that differ from its sign bit.
  37949. </member>
  37950. <member name="M:NPOI.Util.BigInteger.Abs">
  37951. Returns a BigInteger whose value is the absolute value of this
  37952. BigInteger.
  37953. @return {@code abs(this)}
  37954. </member>
  37955. <member name="M:NPOI.Util.BigInteger.Negate">
  37956. Returns a BigInteger whose value is {@code (-this)}.
  37957. @return {@code -this}
  37958. </member>
  37959. <member name="M:NPOI.Util.BigInteger.Pow(System.Int32)">
  37960. Returns a BigInteger whose value is <c>(this<sup>exponent</sup>)</c>.
  37961. Note that {@code exponent} is an integer rather than a BigInteger.
  37962. @param exponent exponent to which this BigInteger is to be raised.
  37963. @return <c>this<sup>exponent</sup></c>
  37964. @throws ArithmeticException {@code exponent} is negative. (This would
  37965. cause the operation to yield a non-integer value.)
  37966. </member>
  37967. <member name="M:NPOI.Util.BigInteger.MultiplyToLen(System.Int32[],System.Int32,System.Int32[],System.Int32,System.Int32[])">
  37968. Multiplies int arrays x and y to the specified lengths and places
  37969. the result into z. There will be no leading zeros in the resultant array.
  37970. </member>
  37971. <member name="M:NPOI.Util.BigInteger.mulAdd(System.Int32[],System.Int32[],System.Int32,System.Int32,System.Int32)">
  37972. Multiply an array by one word k and add to result, return the carry
  37973. </member>
  37974. <member name="M:NPOI.Util.BigInteger.squareToLen(System.Int32[],System.Int32,System.Int32[])">
  37975. Squares the contents of the int array x. The result is placed into the
  37976. int array z. The contents of x are not changed.
  37977. </member>
  37978. <member name="M:NPOI.Util.BigInteger.addOne(System.Int32[],System.Int32,System.Int32,System.Int32)">
  37979. Add one word to the number a mlen words into a. Return the resulting
  37980. carry.
  37981. </member>
  37982. <member name="M:NPOI.Util.BigInteger.Signum">
  37983. Returns the signum function of this BigInteger.
  37984. @return -1, 0 or 1 as the value of this BigInteger is negative, zero or
  37985. positive.
  37986. </member>
  37987. <member name="M:NPOI.Util.BigInteger.ToByteArray">
  37988. Returns a byte array containing the two's-complement
  37989. representation of this BigInteger. The byte array will be in
  37990. <i>big-endian</i> byte-order: the most significant byte is in
  37991. the zeroth element. The array will contain the minimum number
  37992. of bytes required to represent this BigInteger, including at
  37993. least one sign bit, which is {@code (ceil((this.bitLength() +
  37994. 1)/8))}. (This representation is compatible with the
  37995. {@link #BigInteger(byte[]) (byte[])} constructor.)
  37996. @return a byte array containing the two's-complement representation of
  37997. this BigInteger.
  37998. @see #BigInteger(byte[])
  37999. </member>
  38000. <member name="M:NPOI.Util.BigInteger.intLength">
  38001. Returns the length of the two's complement representation in ints,
  38002. including space for at least one sign bit.
  38003. </member>
  38004. <member name="M:NPOI.Util.BigInteger.GetInt(System.Int32)">
  38005. Returns the specified int of the little-endian two's complement
  38006. representation (int 0 is the least significant). The int number can
  38007. be arbitrarily high (values are logically preceded by infinitely many
  38008. sign ints).
  38009. </member>
  38010. <member name="M:NPOI.Util.BigInteger.FirstNonzeroIntNum">
  38011. Returns the index of the int that contains the first nonzero int in the
  38012. little-endian binary representation of the magnitude (int 0 is the
  38013. least significant). If the magnitude is zero, return value is undefined.
  38014. </member>
  38015. <member name="M:NPOI.Util.BigInteger.stripLeadingZeroBytes(System.Byte[])">
  38016. Returns a copy of the input array stripped of any leading zero bytes.
  38017. </member>
  38018. <member name="M:NPOI.Util.BigInteger.makePositive(System.Byte[])">
  38019. Takes an array a representing a negative 2's-complement number and
  38020. returns the minimal (no leading zero bytes) unsigned whose value is -a.
  38021. </member>
  38022. <member name="M:NPOI.Util.BigInteger.makePositive(System.Int32[])">
  38023. Takes an array a representing a negative 2's-complement number and
  38024. returns the minimal (no leading zero ints) unsigned whose value is -a.
  38025. </member>
  38026. <member name="M:NPOI.Util.BigInteger.NumberOfLeadingZeros(System.Int32)">
  38027. Returns the number of zero bits preceding the highest-order
  38028. ("leftmost") one-bit in the two's complement binary representation
  38029. of the specified {@code int} value. Returns 32 if the
  38030. specified value has no one-bits in its two's complement representation,
  38031. in other words if it is equal to zero.
  38032. Note that this method is closely related to the logarithm base 2.
  38033. For all positive {@code int} values x:
  38034. <ul>
  38035. <li>floor(log<sub>2</sub>(x)) = {@code 31 - numberOfLeadingZeros(x)}</li>
  38036. <li>ceil(log<sub>2</sub>(x)) = {@code 32 - numberOfLeadingZeros(x - 1)}</li>
  38037. </ul>
  38038. @return the number of zero bits preceding the highest-order
  38039. ("leftmost") one-bit in the two's complement binary representation
  38040. of the specified {@code int} value, or 32 if the value
  38041. is equal to zero.
  38042. @since 1.5
  38043. </member>
  38044. <member name="M:NPOI.Util.BigInteger.NumberOfTrailingZeros(System.Int32)">
  38045. Returns the number of zero bits following the lowest-order ("rightmost")
  38046. one-bit in the two's complement binary representation of the specified
  38047. {@code int} value. Returns 32 if the specified value has no
  38048. one-bits in its two's complement representation, in other words if it is
  38049. equal to zero.
  38050. @return the number of zero bits following the lowest-order ("rightmost")
  38051. one-bit in the two's complement binary representation of the
  38052. specified {@code int} value, or 32 if the value is equal
  38053. to zero.
  38054. @since 1.5
  38055. </member>
  38056. <member name="M:NPOI.Util.BigInteger.BitCountForInt(System.Int32)">
  38057. Returns the number of one-bits in the two's complement binary
  38058. representation of the specified {@code int} value. This function is
  38059. sometimes referred to as the <i>population count</i>.
  38060. @return the number of one-bits in the two's complement binary
  38061. representation of the specified {@code int} value.
  38062. @since 1.5
  38063. </member>
  38064. <member name="M:NPOI.Util.BigInteger.compareMagnitude(NPOI.Util.BigInteger)">
  38065. Compares the magnitude array of this BigInteger with the specified
  38066. BigInteger's. This is the version of compareTo ignoring sign.
  38067. @param val BigInteger whose magnitude array to be compared.
  38068. @return -1, 0 or 1 as this magnitude array is less than, equal to or
  38069. greater than the magnitude aray for the specified BigInteger's.
  38070. </member>
  38071. <member name="M:NPOI.Util.BigInteger.Equals(System.Object)">
  38072. Compares this BigInteger with the specified Object for equality.
  38073. @param x Object to which this BigInteger is to be compared.
  38074. @return {@code true} if and only if the specified Object is a
  38075. BigInteger whose value is numerically equal to this BigInteger.
  38076. </member>
  38077. <member name="M:NPOI.Util.BigInteger.Min(NPOI.Util.BigInteger)">
  38078. Returns the minimum of this BigInteger and {@code val}.
  38079. @param val value with which the minimum is to be computed.
  38080. @return the BigInteger whose value is the lesser of this BigInteger and
  38081. {@code val}. If they are equal, either may be returned.
  38082. </member>
  38083. <member name="M:NPOI.Util.BigInteger.Max(NPOI.Util.BigInteger)">
  38084. Returns the maximum of this BigInteger and {@code val}.
  38085. @param val value with which the maximum is to be computed.
  38086. @return the BigInteger whose value is the greater of this and
  38087. {@code val}. If they are equal, either may be returned.
  38088. </member>
  38089. <member name="M:NPOI.Util.BigInteger.GetHashCode">
  38090. Returns the hash code for this BigInteger.
  38091. @return hash code for this BigInteger.
  38092. </member>
  38093. <member name="M:NPOI.Util.BigInteger.IntValue">
  38094. Converts this BigInteger to an {@code int}. This
  38095. conversion is analogous to a
  38096. <i>narrowing primitive conversion</i> from {@code long} to
  38097. {@code int} as defined in section 5.1.3 of
  38098. <cite>The Java(TM) Language Specification</cite>:
  38099. if this BigInteger is too big to fit in an
  38100. {@code int}, only the low-order 32 bits are returned.
  38101. Note that this conversion can lose information about the
  38102. overall magnitude of the BigInteger value as well as return a
  38103. result with the opposite sign.
  38104. @return this BigInteger converted to an {@code int}.
  38105. </member>
  38106. <member name="M:NPOI.Util.BigInteger.LongValue">
  38107. Converts this BigInteger to a {@code long}. This
  38108. conversion is analogous to a
  38109. <i>narrowing primitive conversion</i> from {@code long} to
  38110. {@code int} as defined in section 5.1.3 of
  38111. <cite>The Java(TM) Language Specification</cite>:
  38112. if this BigInteger is too big to fit in a
  38113. {@code long}, only the low-order 64 bits are returned.
  38114. Note that this conversion can lose information about the
  38115. overall magnitude of the BigInteger value as well as return a
  38116. result with the opposite sign.
  38117. @return this BigInteger converted to a {@code long}.
  38118. </member>
  38119. <member name="M:NPOI.Util.BigInteger.ShiftRight(System.Int32)">
  38120. Returns a BigInteger whose value is {@code (this >> n)}. Sign
  38121. extension is performed. The shift distance, {@code n}, may be
  38122. negative, in which case this method performs a left shift.
  38123. (Computes <c>floor(this / 2<sup>n</sup>)</c>.)
  38124. @param n shift distance, in bits.
  38125. @return {@code this >> n}
  38126. @throws ArithmeticException if the shift distance is {@code
  38127. Integer.Min_VALUE}.
  38128. @see #shiftLeft
  38129. </member>
  38130. <member name="M:NPOI.Util.BigInteger.Not">
  38131. Returns a BigInteger whose value is {@code (~this)}. (This method
  38132. returns a negative value if and only if this BigInteger is
  38133. non-negative.)
  38134. @return {@code ~this}
  38135. </member>
  38136. <member name="M:NPOI.Util.BigInteger.Or(NPOI.Util.BigInteger)">
  38137. Returns a BigInteger whose value is {@code (this | val)}. (This method
  38138. returns a negative BigInteger if and only if either this or val is
  38139. negative.)
  38140. @param val value to be OR'ed with this BigInteger.
  38141. @return {@code this | val}
  38142. </member>
  38143. <member name="M:NPOI.Util.BigInteger.Multiply(System.Int64)">
  38144. Package private methods used by BigDecimal code to multiply a BigInteger
  38145. with a long. Assumes v is not equal to INFLATED.
  38146. </member>
  38147. <member name="M:NPOI.Util.BigInteger.Multiply(NPOI.Util.BigInteger)">
  38148. Returns a BigInteger whose value is {@code (this * val)}.
  38149. @param val value to be multiplied by this BigInteger.
  38150. @return {@code this * val}
  38151. </member>
  38152. <member name="M:NPOI.Util.BigInteger.Add(NPOI.Util.BigInteger)">
  38153. Returns a BigInteger whose value is {@code (this + val)}.
  38154. @param val value to be added to this BigInteger.
  38155. @return {@code this + val}
  38156. </member>
  38157. <member name="M:NPOI.Util.BigInteger.add(System.Int32[],System.Int32[])">
  38158. Adds the contents of the int arrays x and y. This method allocates
  38159. a new int array to hold the answer and returns a reference to that
  38160. array.
  38161. </member>
  38162. <member name="M:NPOI.Util.BigInteger.Subtract(NPOI.Util.BigInteger)">
  38163. Returns a BigInteger whose value is {@code (this - val)}.
  38164. @param val value to be subtracted from this BigInteger.
  38165. @return {@code this - val}
  38166. </member>
  38167. <member name="M:NPOI.Util.BigInteger.Subtract(System.Int32[],System.Int32[])">
  38168. Subtracts the contents of the second int arrays (little) from the
  38169. first (big). The first int array (big) must represent a larger number
  38170. than the second. This method allocates the space necessary to hold the
  38171. answer.
  38172. </member>
  38173. <member name="M:NPOI.Util.BigInteger.Divide(NPOI.Util.BigInteger)">
  38174. Returns a BigInteger whose value is {@code (this / val)}.
  38175. @param val value by which this BigInteger is to be divided.
  38176. @return {@code this / val}
  38177. @throws ArithmeticException if {@code val} is zero.
  38178. </member>
  38179. <member name="F:NPOI.Util.MutableBigInteger._value">
  38180. Holds the magnitude of this MutableBigInteger in big endian order.
  38181. The magnitude may start at an offset into the value array, and it may
  38182. end before the length of the value array.
  38183. </member>
  38184. <member name="F:NPOI.Util.MutableBigInteger.intLen">
  38185. The number of ints of the value array that are currently used
  38186. to hold the magnitude of this MutableBigInteger. The magnitude starts
  38187. at an offset and offset + intLen may be less than value.Length.
  38188. </member>
  38189. <member name="F:NPOI.Util.MutableBigInteger.offset">
  38190. The offset into the value array where the magnitude of this
  38191. MutableBigInteger begins.
  38192. </member>
  38193. <member name="F:NPOI.Util.MutableBigInteger.One">
  38194. MutableBigInteger with one element value array with the value 1. Used by
  38195. BigDecimal divideAndRound to increment the quotient. Use this constant
  38196. only when the method is not going to modify this object.
  38197. </member>
  38198. <member name="M:NPOI.Util.MutableBigInteger.#ctor">
  38199. The default constructor. An empty MutableBigInteger is created with
  38200. a one word capacity.
  38201. </member>
  38202. <member name="M:NPOI.Util.MutableBigInteger.#ctor(System.Int32)">
  38203. Construct a new MutableBigInteger with a magnitude specified by
  38204. the int val.
  38205. </member>
  38206. <member name="M:NPOI.Util.MutableBigInteger.#ctor(System.Int32[])">
  38207. Construct a new MutableBigInteger with the specified value array
  38208. up to the length of the array supplied.
  38209. </member>
  38210. <member name="M:NPOI.Util.MutableBigInteger.#ctor(NPOI.Util.BigInteger)">
  38211. Construct a new MutableBigInteger with a magnitude equal to the
  38212. specified BigInteger.
  38213. </member>
  38214. <member name="M:NPOI.Util.MutableBigInteger.#ctor(NPOI.Util.MutableBigInteger)">
  38215. Construct a new MutableBigInteger with a magnitude equal to the
  38216. specified MutableBigInteger.
  38217. </member>
  38218. <member name="M:NPOI.Util.MutableBigInteger.getMagnitudeArray">
  38219. Internal helper method to return the magnitude array. The caller is not
  38220. supposed to modify the returned array.
  38221. </member>
  38222. <member name="M:NPOI.Util.MutableBigInteger.toLong">
  38223. Convert this MutableBigInteger to a long value. The caller has to make
  38224. sure this MutableBigInteger can be fit into long.
  38225. </member>
  38226. <member name="M:NPOI.Util.MutableBigInteger.toBigInteger(System.Int32)">
  38227. Convert this MutableBigInteger to a BigInteger object.
  38228. </member>
  38229. <member name="M:NPOI.Util.MutableBigInteger.clear">
  38230. Clear out a MutableBigInteger for reuse.
  38231. </member>
  38232. <member name="M:NPOI.Util.MutableBigInteger.reset">
  38233. Set a MutableBigInteger to zero, removing its offset.
  38234. </member>
  38235. <member name="M:NPOI.Util.MutableBigInteger.compare(NPOI.Util.MutableBigInteger)">
  38236. Compare the magnitude of two MutableBigIntegers. Returns -1, 0 or 1
  38237. as this MutableBigInteger is numerically less than, equal to, or
  38238. greater than <c>b</c>.
  38239. </member>
  38240. <member name="M:NPOI.Util.MutableBigInteger.compareHalf(NPOI.Util.MutableBigInteger)">
  38241. Compare this against half of a MutableBigInteger object (Needed for
  38242. remainder tests).
  38243. Assumes no leading unnecessary zeros, which holds for results
  38244. from divide().
  38245. </member>
  38246. <member name="M:NPOI.Util.MutableBigInteger.getLowestSetBit">
  38247. Return the index of the lowest set bit in this MutableBigInteger. If the
  38248. magnitude of this MutableBigInteger is zero, -1 is returned.
  38249. </member>
  38250. <member name="M:NPOI.Util.MutableBigInteger.getInt(System.Int32)">
  38251. Return the int in use in this MutableBigInteger at the specified
  38252. index. This method is not used because it is not inlined on all
  38253. platforms.
  38254. </member>
  38255. <member name="M:NPOI.Util.MutableBigInteger.getLong(System.Int32)">
  38256. Return a long which is equal to the unsigned value of the int in
  38257. use in this MutableBigInteger at the specified index. This method is
  38258. not used because it is not inlined on all platforms.
  38259. </member>
  38260. <member name="M:NPOI.Util.MutableBigInteger.normalize">
  38261. Ensure that the MutableBigInteger is in normal form, specifically
  38262. making sure that there are no leading zeros, and that if the
  38263. magnitude is zero, then intLen is zero.
  38264. </member>
  38265. <member name="M:NPOI.Util.MutableBigInteger.ensureCapacity(System.Int32)">
  38266. If this MutableBigInteger cannot hold len words, increase the size
  38267. of the value array to len words.
  38268. </member>
  38269. <member name="M:NPOI.Util.MutableBigInteger.toIntArray">
  38270. Convert this MutableBigInteger into an int array with no leading
  38271. zeros, of a length that is equal to this MutableBigInteger's intLen.
  38272. </member>
  38273. <member name="M:NPOI.Util.MutableBigInteger.setInt(System.Int32,System.Int32)">
  38274. Sets the int at index+offset in this MutableBigInteger to val.
  38275. This does not get inlined on all platforms so it is not used
  38276. as often as originally intended.
  38277. </member>
  38278. <member name="M:NPOI.Util.MutableBigInteger.setValue(System.Int32[],System.Int32)">
  38279. Sets this MutableBigInteger's value array to the specified array.
  38280. The intLen is set to the specified length.
  38281. </member>
  38282. <member name="M:NPOI.Util.MutableBigInteger.copyValue(NPOI.Util.MutableBigInteger)">
  38283. Sets this MutableBigInteger's value array to a copy of the specified
  38284. array. The intLen is set to the length of the new array.
  38285. </member>
  38286. <member name="M:NPOI.Util.MutableBigInteger.copyValue(System.Int32[])">
  38287. Sets this MutableBigInteger's value array to a copy of the specified
  38288. array. The intLen is set to the length of the specified array.
  38289. </member>
  38290. <member name="M:NPOI.Util.MutableBigInteger.isOne">
  38291. Returns true iff this MutableBigInteger has a value of one.
  38292. </member>
  38293. <member name="M:NPOI.Util.MutableBigInteger.isZero">
  38294. Returns true iff this MutableBigInteger has a value of zero.
  38295. </member>
  38296. <member name="M:NPOI.Util.MutableBigInteger.isEven">
  38297. Returns true iff this MutableBigInteger is even.
  38298. </member>
  38299. <member name="M:NPOI.Util.MutableBigInteger.isOdd">
  38300. Returns true iff this MutableBigInteger is odd.
  38301. </member>
  38302. <member name="M:NPOI.Util.MutableBigInteger.isNormal">
  38303. Returns true iff this MutableBigInteger is in normal form. A
  38304. MutableBigInteger is in normal form if it has no leading zeros
  38305. after the offset, and intLen + offset &lt;= value.Length.
  38306. </member>
  38307. <member name="M:NPOI.Util.MutableBigInteger.toString">
  38308. Returns a String representation of this MutableBigInteger in radix 10.
  38309. </member>
  38310. <member name="M:NPOI.Util.MutableBigInteger.rightShift(System.Int32)">
  38311. Right shift this MutableBigInteger n bits. The MutableBigInteger is left
  38312. in normal form.
  38313. </member>
  38314. <member name="M:NPOI.Util.MutableBigInteger.leftShift(System.Int32)">
  38315. Left shift this MutableBigInteger n bits.
  38316. </member>
  38317. <member name="M:NPOI.Util.MutableBigInteger.divadd(System.Int32[],System.Int32[],System.Int32)">
  38318. A primitive used for division. This method adds in one multiple of the
  38319. divisor a back to the dividend result at a specified offset. It is used
  38320. when qhat was estimated too large, and must be adjusted.
  38321. </member>
  38322. <member name="M:NPOI.Util.MutableBigInteger.mulsub(System.Int32[],System.Int32[],System.Int32,System.Int32,System.Int32)">
  38323. This method is used for division. It multiplies an n word input a by one
  38324. word input x, and subtracts the n word product from q. This is needed
  38325. when subtracting qhat*divisor from dividend.
  38326. </member>
  38327. <member name="M:NPOI.Util.MutableBigInteger.primitiveRightShift(System.Int32)">
  38328. Right shift this MutableBigInteger n bits, where n is
  38329. less than 32.
  38330. Assumes that intLen > 0, n > 0 for speed
  38331. </member>
  38332. <member name="M:NPOI.Util.MutableBigInteger.primitiveLeftShift(System.Int32)">
  38333. Left shift this MutableBigInteger n bits, where n is
  38334. less than 32.
  38335. Assumes that intLen > 0, n > 0 for speed
  38336. </member>
  38337. <member name="M:NPOI.Util.MutableBigInteger.add(NPOI.Util.MutableBigInteger)">
  38338. Adds the contents of two MutableBigInteger objects.The result
  38339. is placed within this MutableBigInteger.
  38340. The contents of the addend are not changed.
  38341. </member>
  38342. <member name="M:NPOI.Util.MutableBigInteger.subtract(NPOI.Util.MutableBigInteger)">
  38343. Subtracts the smaller of this and b from the larger and places the
  38344. result into this MutableBigInteger.
  38345. </member>
  38346. <member name="M:NPOI.Util.MutableBigInteger.difference(NPOI.Util.MutableBigInteger)">
  38347. Subtracts the smaller of a and b from the larger and places the result
  38348. into the larger. Returns 1 if the answer is in a, -1 if in b, 0 if no
  38349. operation was performed.
  38350. </member>
  38351. <member name="M:NPOI.Util.MutableBigInteger.multiply(NPOI.Util.MutableBigInteger,NPOI.Util.MutableBigInteger)">
  38352. Multiply the contents of two MutableBigInteger objects. The result is
  38353. placed into MutableBigInteger z. The contents of y are not changed.
  38354. </member>
  38355. <member name="M:NPOI.Util.MutableBigInteger.mul(System.Int32,NPOI.Util.MutableBigInteger)">
  38356. Multiply the contents of this MutableBigInteger by the word y. The
  38357. result is placed into z.
  38358. </member>
  38359. <member name="M:NPOI.Util.MutableBigInteger.divideOneWord(System.Int32,NPOI.Util.MutableBigInteger)">
  38360. This method is used for division of an n word dividend by a one word
  38361. divisor. The quotient is placed into quotient. The one word divisor is
  38362. specified by divisor.
  38363. @return the remainder of the division is returned.
  38364. </member>
  38365. <member name="M:NPOI.Util.MutableBigInteger.divide(NPOI.Util.MutableBigInteger,NPOI.Util.MutableBigInteger)">
  38366. Calculates the quotient of this div b and places the quotient in the
  38367. provided MutableBigInteger objects and the remainder object is returned.
  38368. Uses Algorithm D in Knuth section 4.3.1.
  38369. Many optimizations to that algorithm have been adapted from the Colin
  38370. Plumb C library.
  38371. It special cases one word divisors for speed. The content of b is not
  38372. changed.
  38373. </member>
  38374. <member name="M:NPOI.Util.MutableBigInteger.divide(System.Int64,NPOI.Util.MutableBigInteger)">
  38375. Internally used to calculate the quotient of this div v and places the
  38376. quotient in the provided MutableBigInteger object and the remainder is
  38377. returned.
  38378. @return the remainder of the division will be returned.
  38379. </member>
  38380. <member name="M:NPOI.Util.MutableBigInteger.divideMagnitude(System.Int32[],NPOI.Util.MutableBigInteger)">
  38381. Divide this MutableBigInteger by the divisor represented by its magnitude
  38382. array. The quotient will be placed into the provided quotient object &amp;
  38383. the remainder object is returned.
  38384. </member>
  38385. <member name="M:NPOI.Util.MutableBigInteger.unsignedLongCompare(System.Int64,System.Int64)">
  38386. Compare two longs as if they were unsigned.
  38387. Returns true iff one is bigger than two.
  38388. </member>
  38389. <member name="M:NPOI.Util.MutableBigInteger.divWord(System.Int32[],System.Int64,System.Int32)">
  38390. This method divides a long quantity by an int to estimate
  38391. qhat for two multi precision numbers. It is used when
  38392. the signed value of n is less than zero.
  38393. </member>
  38394. <member name="M:NPOI.Util.MutableBigInteger.hybridGCD(NPOI.Util.MutableBigInteger)">
  38395. Calculate GCD of this and b. This and b are changed by the computation.
  38396. </member>
  38397. <member name="M:NPOI.Util.MutableBigInteger.binaryGCD(NPOI.Util.MutableBigInteger)">
  38398. Calculate GCD of this and v.
  38399. Assumes that this and v are not zero.
  38400. </member>
  38401. <member name="M:NPOI.Util.MutableBigInteger.binaryGcd(System.Int32,System.Int32)">
  38402. Calculate GCD of a and b interpreted as unsigned integers.
  38403. </member>
  38404. <member name="M:NPOI.Util.MutableBigInteger.mutableModInverse(NPOI.Util.MutableBigInteger)">
  38405. Returns the modInverse of this mod p. This and p are not affected by
  38406. the operation.
  38407. </member>
  38408. <member name="M:NPOI.Util.MutableBigInteger.modInverse(NPOI.Util.MutableBigInteger)">
  38409. Calculate the multiplicative inverse of this mod mod, where mod is odd.
  38410. This and mod are not changed by the calculation.
  38411. This method implements an algorithm due to Richard Schroeppel, that uses
  38412. the same intermediate representation as Montgomery Reduction
  38413. ("Montgomery Form"). The algorithm is described in an unpublished
  38414. manuscript entitled "Fast Modular Reciprocals."
  38415. </member>
  38416. <member name="M:NPOI.Util.MutableBigInteger.euclidModInverse(System.Int32)">
  38417. Uses the extended Euclidean algorithm to compute the modInverse of base
  38418. mod a modulus that is a power of 2. The modulus is 2^k.
  38419. </member>
  38420. <member name="T:NPOI.Util.BitField">
  38421. <summary>
  38422. Manage operations dealing with bit-mapped fields.
  38423. @author Marc Johnson (mjohnson at apache dot org)
  38424. @author Andrew C. Oliver (acoliver at apache dot org)
  38425. </summary>
  38426. </member>
  38427. <member name="M:NPOI.Util.BitField.#ctor(System.Int32)">
  38428. <summary>
  38429. Create a <see cref="T:NPOI.Util.BitField"/> instance
  38430. </summary>
  38431. <param name="mask">
  38432. the mask specifying which bits apply to this
  38433. BitField. Bits that are set in this mask are the
  38434. bits that this BitField operates on
  38435. </param>
  38436. </member>
  38437. <member name="M:NPOI.Util.BitField.#ctor(System.UInt32)">
  38438. <summary>
  38439. Create a <see cref="T:NPOI.Util.BitField"/> instance
  38440. </summary>
  38441. <param name="mask">
  38442. the mask specifying which bits apply to this
  38443. BitField. Bits that are set in this mask are the
  38444. bits that this BitField operates on
  38445. </param>
  38446. </member>
  38447. <member name="M:NPOI.Util.BitField.Clear(System.Int32)">
  38448. <summary>
  38449. Clear the bits.
  38450. </summary>
  38451. <param name="holder">the int data containing the bits we're interested in</param>
  38452. <returns>the value of holder with the specified bits cleared (set to 0)</returns>
  38453. </member>
  38454. <member name="M:NPOI.Util.BitField.ClearShort(System.Int16)">
  38455. <summary>
  38456. Clear the bits.
  38457. </summary>
  38458. <param name="holder">the short data containing the bits we're interested in</param>
  38459. <returns>the value of holder with the specified bits cleared (set to 0)</returns>
  38460. </member>
  38461. <member name="M:NPOI.Util.BitField.GetRawValue(System.Int32)">
  38462. <summary>
  38463. Obtain the value for the specified BitField, appropriately
  38464. shifted right. Many users of a BitField will want to treat the
  38465. specified bits as an int value, and will not want to be aware
  38466. that the value is stored as a BitField (and so shifted left so
  38467. many bits)
  38468. </summary>
  38469. <param name="holder">the int data containing the bits we're interested in</param>
  38470. <returns>the selected bits, shifted right appropriately</returns>
  38471. </member>
  38472. <member name="M:NPOI.Util.BitField.GetShortRawValue(System.Int16)">
  38473. <summary>
  38474. Obtain the value for the specified BitField, unshifted
  38475. </summary>
  38476. <param name="holder">the short data containing the bits we're interested in</param>
  38477. <returns>the selected bits</returns>
  38478. </member>
  38479. <member name="M:NPOI.Util.BitField.GetShortValue(System.Int16)">
  38480. <summary>
  38481. Obtain the value for the specified BitField, appropriately
  38482. shifted right, as a short. Many users of a BitField will want
  38483. to treat the specified bits as an int value, and will not want
  38484. to be aware that the value is stored as a BitField (and so
  38485. shifted left so many bits)
  38486. </summary>
  38487. <param name="holder">the short data containing the bits we're interested in</param>
  38488. <returns>the selected bits, shifted right appropriately</returns>
  38489. </member>
  38490. <member name="M:NPOI.Util.BitField.GetValue(System.Int32)">
  38491. <summary>
  38492. Obtain the value for the specified BitField, appropriately
  38493. shifted right. Many users of a BitField will want to treat the
  38494. specified bits as an int value, and will not want to be aware
  38495. that the value is stored as a BitField (and so shifted left so
  38496. many bits)
  38497. </summary>
  38498. <param name="holder">the int data containing the bits we're interested in</param>
  38499. <returns>the selected bits, shifted right appropriately</returns>
  38500. </member>
  38501. <member name="M:NPOI.Util.BitField.IsAllSet(System.Int32)">
  38502. <summary>
  38503. Are all of the bits set or not? This is a stricter test than
  38504. isSet, in that all of the bits in a multi-bit set must be set
  38505. for this method to return true
  38506. </summary>
  38507. <param name="holder">the int data containing the bits we're interested in</param>
  38508. <returns>
  38509. <c>true</c> if all of the bits are set otherwise, <c>false</c>.
  38510. </returns>
  38511. </member>
  38512. <member name="M:NPOI.Util.BitField.IsSet(System.Int32)">
  38513. <summary>
  38514. is the field set or not? This is most commonly used for a
  38515. single-bit field, which is often used to represent a boolean
  38516. value; the results of using it for a multi-bit field is to
  38517. determine whether *any* of its bits are set
  38518. </summary>
  38519. <param name="holder">the int data containing the bits we're interested in</param>
  38520. <returns>
  38521. <c>true</c> if any of the bits are set; otherwise, <c>false</c>.
  38522. </returns>
  38523. </member>
  38524. <member name="M:NPOI.Util.BitField.Set(System.Int32)">
  38525. <summary>
  38526. Set the bits.
  38527. </summary>
  38528. <param name="holder">the int data containing the bits we're interested in</param>
  38529. <returns>the value of holder with the specified bits set to 1</returns>
  38530. </member>
  38531. <member name="M:NPOI.Util.BitField.SetBoolean(System.Int32,System.Boolean)">
  38532. <summary>
  38533. Set a boolean BitField
  38534. </summary>
  38535. <param name="holder">the int data containing the bits we're interested in</param>
  38536. <param name="flag">indicating whether to set or clear the bits</param>
  38537. <returns>the value of holder with the specified bits set or cleared</returns>
  38538. </member>
  38539. <member name="M:NPOI.Util.BitField.SetShort(System.Int16)">
  38540. <summary>
  38541. Set the bits.
  38542. </summary>
  38543. <param name="holder">the short data containing the bits we're interested in</param>
  38544. <returns>the value of holder with the specified bits set to 1</returns>
  38545. </member>
  38546. <member name="M:NPOI.Util.BitField.SetShortBoolean(System.Int16,System.Boolean)">
  38547. <summary>
  38548. Set a boolean BitField
  38549. </summary>
  38550. <param name="holder">the short data containing the bits we're interested in</param>
  38551. <param name="flag">indicating whether to set or clear the bits</param>
  38552. <returns>the value of holder with the specified bits set or cleared</returns>
  38553. </member>
  38554. <member name="M:NPOI.Util.BitField.SetShortValue(System.Int16,System.Int16)">
  38555. <summary>
  38556. Obtain the value for the specified BitField, appropriately
  38557. shifted right, as a short. Many users of a BitField will want
  38558. to treat the specified bits as an int value, and will not want
  38559. to be aware that the value is stored as a BitField (and so
  38560. shifted left so many bits)
  38561. </summary>
  38562. <param name="holder">the short data containing the bits we're interested in</param>
  38563. <param name="value">the new value for the specified bits</param>
  38564. <returns>the selected bits, shifted right appropriately</returns>
  38565. </member>
  38566. <member name="M:NPOI.Util.BitField.SetValue(System.Int32,System.Int32)">
  38567. <summary>
  38568. Sets the value.
  38569. </summary>
  38570. <param name="holder">the byte data containing the bits we're interested in</param>
  38571. <param name="value">The value.</param>
  38572. <returns></returns>
  38573. </member>
  38574. <member name="M:NPOI.Util.BitField.SetByteBoolean(System.Byte,System.Boolean)">
  38575. <summary>
  38576. Set a boolean BitField
  38577. </summary>
  38578. <param name="holder"> the byte data containing the bits we're interested in</param>
  38579. <param name="flag">indicating whether to set or clear the bits</param>
  38580. <returns>the value of holder with the specified bits set or cleared</returns>
  38581. </member>
  38582. <member name="M:NPOI.Util.BitField.ClearByte(System.Byte)">
  38583. <summary>
  38584. Clears the bits.
  38585. </summary>
  38586. <param name="holder">the byte data containing the bits we're interested in</param>
  38587. <returns>the value of holder with the specified bits cleared</returns>
  38588. </member>
  38589. <member name="M:NPOI.Util.BitField.SetByte(System.Byte)">
  38590. <summary>
  38591. Set the bits.
  38592. </summary>
  38593. <param name="holder">the byte data containing the bits we're interested in</param>
  38594. <returns>the value of holder with the specified bits set to 1</returns>
  38595. </member>
  38596. <member name="T:NPOI.Util.BitFieldFactory">
  38597. <summary>
  38598. Returns immutable Btfield instances.
  38599. @author Jason Height (jheight at apache dot org)
  38600. </summary>
  38601. </member>
  38602. <member name="M:NPOI.Util.BitFieldFactory.GetInstance(System.Int32)">
  38603. <summary>
  38604. Gets the instance.
  38605. </summary>
  38606. <param name="mask">The mask.</param>
  38607. <returns></returns>
  38608. </member>
  38609. <member name="T:NPOI.Util.ByteField">
  38610. <summary>
  38611. representation of a byte (8-bit) field at a fixed location within a
  38612. byte array
  38613. @author Marc Johnson (mjohnson at apache dot org
  38614. </summary>
  38615. </member>
  38616. <member name="T:NPOI.Util.FixedField">
  38617. <summary>
  38618. behavior of a field at a fixed location within a byte array
  38619. @author Marc Johnson (mjohnson at apache dot org
  38620. </summary>
  38621. </member>
  38622. <member name="M:NPOI.Util.FixedField.ReadFromBytes(System.Byte[])">
  38623. <summary>
  38624. set the value from its offset into an array of bytes
  38625. </summary>
  38626. <param name="data">the byte array from which the value is to be read</param>
  38627. </member>
  38628. <member name="M:NPOI.Util.FixedField.ReadFromStream(System.IO.Stream)">
  38629. <summary>
  38630. set the value from an Stream
  38631. </summary>
  38632. <param name="stream">the Stream from which the value is to be read</param>
  38633. </member>
  38634. <member name="M:NPOI.Util.FixedField.ToString">
  38635. <summary>
  38636. return the value as a String
  38637. </summary>
  38638. <returns></returns>
  38639. </member>
  38640. <member name="M:NPOI.Util.FixedField.WriteToBytes(System.Byte[])">
  38641. <summary>
  38642. write the value out to an array of bytes at the appropriate offset
  38643. </summary>
  38644. <param name="data">the array of bytes to which the value is to be written</param>
  38645. </member>
  38646. <member name="M:NPOI.Util.ByteField.#ctor(System.Int32)">
  38647. <summary>
  38648. Initializes a new instance of the <see cref="T:NPOI.Util.ByteField"/> class.
  38649. </summary>
  38650. <param name="offset">The offset.</param>
  38651. </member>
  38652. <member name="M:NPOI.Util.ByteField.#ctor(System.Int32,System.Byte)">
  38653. <summary>
  38654. Initializes a new instance of the <see cref="T:NPOI.Util.ByteField"/> class.
  38655. </summary>
  38656. <param name="offset">The offset.</param>
  38657. <param name="value">The value.</param>
  38658. </member>
  38659. <member name="M:NPOI.Util.ByteField.#ctor(System.Int32,System.Byte[])">
  38660. <summary>
  38661. Initializes a new instance of the <see cref="T:NPOI.Util.ByteField"/> class.
  38662. </summary>
  38663. <param name="offset">The offset.</param>
  38664. <param name="data">The data.</param>
  38665. </member>
  38666. <member name="M:NPOI.Util.ByteField.#ctor(System.Int32,System.Byte,System.Byte[])">
  38667. <summary>
  38668. Initializes a new instance of the <see cref="T:NPOI.Util.ByteField"/> class.
  38669. </summary>
  38670. <param name="offset">The offset.</param>
  38671. <param name="_value">The _value.</param>
  38672. <param name="data">The data.</param>
  38673. </member>
  38674. <member name="M:NPOI.Util.ByteField.ReadFromBytes(System.Byte[])">
  38675. <summary>
  38676. set the value from its offset into an array of bytes
  38677. </summary>
  38678. <param name="data">the byte array from which the value is to be read</param>
  38679. </member>
  38680. <member name="M:NPOI.Util.ByteField.ReadFromStream(System.IO.Stream)">
  38681. <summary>
  38682. set the value from an Stream
  38683. </summary>
  38684. <param name="stream">the Stream from which the value is to be read</param>
  38685. </member>
  38686. <member name="M:NPOI.Util.ByteField.Set(System.Byte,System.Byte[])">
  38687. <summary>
  38688. set the ByteField's current value and write it to a byte array
  38689. </summary>
  38690. <param name="value">value to be set</param>
  38691. <param name="data">the byte array to write the value to</param>
  38692. </member>
  38693. <member name="M:NPOI.Util.ByteField.ToString">
  38694. <summary>
  38695. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  38696. </summary>
  38697. <returns>
  38698. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  38699. </returns>
  38700. </member>
  38701. <member name="M:NPOI.Util.ByteField.WriteToBytes(System.Byte[])">
  38702. <summary>
  38703. write the value out to an array of bytes at the appropriate offset
  38704. </summary>
  38705. <param name="data">the array of bytes to which the value is to be written</param>
  38706. </member>
  38707. <member name="P:NPOI.Util.ByteField.Value">
  38708. <summary>
  38709. Gets or sets the value.
  38710. </summary>
  38711. <value>The value.</value>
  38712. </member>
  38713. <member name="T:NPOI.Util.CodePageUtil">
  38714. Utilities for working with Microsoft CodePages.
  38715. <p>Provides constants for understanding numeric codepages,
  38716. along with utilities to translate these into Java Character Sets.</p>
  38717. </member>
  38718. <member name="F:NPOI.Util.CodePageUtil.CP_037">
  38719. <p>Codepage 037, a special case</p>
  38720. </member>
  38721. <member name="F:NPOI.Util.CodePageUtil.CP_SJIS">
  38722. <p>Codepage for SJIS</p>
  38723. </member>
  38724. <member name="F:NPOI.Util.CodePageUtil.CP_GBK">
  38725. <p>Codepage for GBK, aka MS936</p>
  38726. </member>
  38727. <member name="F:NPOI.Util.CodePageUtil.CP_MS949">
  38728. <p>Codepage for MS949</p>
  38729. </member>
  38730. <member name="F:NPOI.Util.CodePageUtil.CP_UTF16">
  38731. <p>Codepage for UTF-16</p>
  38732. </member>
  38733. <member name="F:NPOI.Util.CodePageUtil.CP_UTF16_BE">
  38734. <p>Codepage for UTF-16 big-endian</p>
  38735. </member>
  38736. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1250">
  38737. <p>Codepage for Windows 1250</p>
  38738. </member>
  38739. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1251">
  38740. <p>Codepage for Windows 1251</p>
  38741. </member>
  38742. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1252">
  38743. <p>Codepage for Windows 1252</p>
  38744. </member>
  38745. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1253">
  38746. <p>Codepage for Windows 1253</p>
  38747. </member>
  38748. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1254">
  38749. <p>Codepage for Windows 1254</p>
  38750. </member>
  38751. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1255">
  38752. <p>Codepage for Windows 1255</p>
  38753. </member>
  38754. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1256">
  38755. <p>Codepage for Windows 1256</p>
  38756. </member>
  38757. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1257">
  38758. <p>Codepage for Windows 1257</p>
  38759. </member>
  38760. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1258">
  38761. <p>Codepage for Windows 1258</p>
  38762. </member>
  38763. <member name="F:NPOI.Util.CodePageUtil.CP_JOHAB">
  38764. <p>Codepage for Johab</p>
  38765. </member>
  38766. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_ROMAN">
  38767. <p>Codepage for Macintosh Roman (Java: MacRoman)</p>
  38768. </member>
  38769. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_JAPAN">
  38770. <p>Codepage for Macintosh Japan (Java: unknown - use SJIS, cp942 or
  38771. cp943)</p>
  38772. </member>
  38773. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_CHINESE_TRADITIONAL">
  38774. <p>Codepage for Macintosh Chinese Traditional (Java: unknown - use Big5,
  38775. MS950, or cp937)</p>
  38776. </member>
  38777. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_KOREAN">
  38778. <p>Codepage for Macintosh Korean (Java: unknown - use EUC_KR or
  38779. cp949)</p>
  38780. </member>
  38781. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_ARABIC">
  38782. <p>Codepage for Macintosh Arabic (Java: MacArabic)</p>
  38783. </member>
  38784. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_HEBREW">
  38785. <p>Codepage for Macintosh Hebrew (Java: MacHebrew)</p>
  38786. </member>
  38787. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_GREEK">
  38788. <p>Codepage for Macintosh Greek (Java: MacGreek)</p>
  38789. </member>
  38790. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_CYRILLIC">
  38791. <p>Codepage for Macintosh Cyrillic (Java: MacCyrillic)</p>
  38792. </member>
  38793. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_CHINESE_SIMPLE">
  38794. <p>Codepage for Macintosh Chinese Simplified (Java: unknown - use
  38795. EUC_CN, ISO2022_CN_GB, MS936 or cp935)</p>
  38796. </member>
  38797. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_ROMANIA">
  38798. <p>Codepage for Macintosh Romanian (Java: MacRomania)</p>
  38799. </member>
  38800. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_UKRAINE">
  38801. <p>Codepage for Macintosh Ukrainian (Java: MacUkraine)</p>
  38802. </member>
  38803. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_THAI">
  38804. <p>Codepage for Macintosh Thai (Java: MacThai)</p>
  38805. </member>
  38806. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_CENTRAL_EUROPE">
  38807. <p>Codepage for Macintosh Central Europe (Latin-2)
  38808. (Java: MacCentralEurope)</p>
  38809. </member>
  38810. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_ICELAND">
  38811. <p>Codepage for Macintosh Iceland (Java: MacIceland)</p>
  38812. </member>
  38813. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_TURKISH">
  38814. <p>Codepage for Macintosh Turkish (Java: MacTurkish)</p>
  38815. </member>
  38816. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_CROATIAN">
  38817. <p>Codepage for Macintosh Croatian (Java: MacCroatian)</p>
  38818. </member>
  38819. <member name="F:NPOI.Util.CodePageUtil.CP_US_ACSII">
  38820. <p>Codepage for US-ASCII</p>
  38821. </member>
  38822. <member name="F:NPOI.Util.CodePageUtil.CP_KOI8_R">
  38823. <p>Codepage for KOI8-R</p>
  38824. </member>
  38825. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_1">
  38826. <p>Codepage for ISO-8859-1</p>
  38827. </member>
  38828. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_2">
  38829. <p>Codepage for ISO-8859-2</p>
  38830. </member>
  38831. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_3">
  38832. <p>Codepage for ISO-8859-3</p>
  38833. </member>
  38834. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_4">
  38835. <p>Codepage for ISO-8859-4</p>
  38836. </member>
  38837. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_5">
  38838. <p>Codepage for ISO-8859-5</p>
  38839. </member>
  38840. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_6">
  38841. <p>Codepage for ISO-8859-6</p>
  38842. </member>
  38843. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_7">
  38844. <p>Codepage for ISO-8859-7</p>
  38845. </member>
  38846. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_8">
  38847. <p>Codepage for ISO-8859-8</p>
  38848. </member>
  38849. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_9">
  38850. <p>Codepage for ISO-8859-9</p>
  38851. </member>
  38852. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_2022_JP1">
  38853. <p>Codepage for ISO-2022-JP</p>
  38854. </member>
  38855. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_2022_JP2">
  38856. <p>Another codepage for ISO-2022-JP</p>
  38857. </member>
  38858. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_2022_JP3">
  38859. <p>Yet another codepage for ISO-2022-JP</p>
  38860. </member>
  38861. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_2022_KR">
  38862. <p>Codepage for ISO-2022-KR</p>
  38863. </member>
  38864. <member name="F:NPOI.Util.CodePageUtil.CP_EUC_JP">
  38865. <p>Codepage for EUC-JP</p>
  38866. </member>
  38867. <member name="F:NPOI.Util.CodePageUtil.CP_EUC_KR">
  38868. <p>Codepage for EUC-KR</p>
  38869. </member>
  38870. <member name="F:NPOI.Util.CodePageUtil.CP_GB2312">
  38871. <p>Codepage for GB2312</p>
  38872. </member>
  38873. <member name="F:NPOI.Util.CodePageUtil.CP_GB18030">
  38874. <p>Codepage for GB18030</p>
  38875. </member>
  38876. <member name="F:NPOI.Util.CodePageUtil.CP_US_ASCII2">
  38877. <p>Another codepage for US-ASCII</p>
  38878. </member>
  38879. <member name="F:NPOI.Util.CodePageUtil.CP_UTF8">
  38880. <p>Codepage for UTF-8</p>
  38881. </member>
  38882. <member name="F:NPOI.Util.CodePageUtil.CP_UNICODE">
  38883. <p>Codepage for Unicode</p>
  38884. </member>
  38885. <member name="M:NPOI.Util.CodePageUtil.GetBytesInCodePage(System.String,System.Int32)">
  38886. Converts a string into bytes, in the equivalent character encoding
  38887. to the supplied codepage number.
  38888. @param string The string to convert
  38889. @param codepage The codepage number
  38890. </member>
  38891. <member name="M:NPOI.Util.CodePageUtil.GetStringFromCodePage(System.Byte[],System.Int32)">
  38892. Converts the bytes into a String, based on the equivalent character encoding
  38893. to the supplied codepage number.
  38894. @param string The byte of the string to convert
  38895. @param codepage The codepage number
  38896. </member>
  38897. <member name="M:NPOI.Util.CodePageUtil.GetStringFromCodePage(System.Byte[],System.Int32,System.Int32,System.Int32)">
  38898. Converts the bytes into a String, based on the equivalent character encoding
  38899. to the supplied codepage number.
  38900. @param string The byte of the string to convert
  38901. @param codepage The codepage number
  38902. </member>
  38903. <member name="M:NPOI.Util.CodePageUtil.CodepageToEncoding(System.Int32)">
  38904. <p>Turns a codepage number into the equivalent character encoding's
  38905. name.</p>
  38906. @param codepage The codepage number
  38907. @return The character encoding's name. If the codepage number is 65001,
  38908. the encoding name is "UTF-8". All other positive numbers are mapped to
  38909. "cp" followed by the number, e.g. if the codepage number is 1252 the
  38910. returned character encoding name will be "cp1252".
  38911. @exception UnsupportedEncodingException if the specified codepage is
  38912. less than zero.
  38913. </member>
  38914. <member name="T:NPOI.Util.Collections.HashSet`1">
  38915. <summary>
  38916. This class comes from Java
  38917. </summary>
  38918. </member>
  38919. <member name="M:NPOI.Util.Collections.HashSet`1.#ctor">
  38920. <summary>
  38921. Initializes a new instance of the <see cref="!:HashSet"/> class.
  38922. </summary>
  38923. </member>
  38924. <member name="M:NPOI.Util.Collections.HashSet`1.Add(`0)">
  38925. <summary>
  38926. Adds the specified o.
  38927. </summary>
  38928. <param name="o">The o.</param>
  38929. </member>
  38930. <member name="M:NPOI.Util.Collections.HashSet`1.Contains(`0)">
  38931. <summary>
  38932. Determines whether [contains] [the specified o].
  38933. </summary>
  38934. <param name="o">The o.</param>
  38935. <returns>
  38936. <c>true</c> if [contains] [the specified o]; otherwise, <c>false</c>.
  38937. </returns>
  38938. </member>
  38939. <member name="M:NPOI.Util.Collections.HashSet`1.CopyTo(`0[],System.Int32)">
  38940. <summary>
  38941. Copies the elements of the <see cref="T:System.Collections.ICollection"/> to an <see cref="T:System.Array"/>, starting at a particular <see cref="T:System.Array"/> index.
  38942. </summary>
  38943. <param name="array">The one-dimensional <see cref="T:System.Array"/> that is the destination of the elements copied from <see cref="T:System.Collections.ICollection"/>. The <see cref="T:System.Array"/> must have zero-based indexing.</param>
  38944. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  38945. <exception cref="T:System.ArgumentNullException">
  38946. <paramref name="array"/> is null.
  38947. </exception>
  38948. <exception cref="T:System.ArgumentOutOfRangeException">
  38949. <paramref name="index"/> is less than zero.
  38950. </exception>
  38951. <exception cref="T:System.ArgumentException">
  38952. <paramref name="array"/> is multidimensional.
  38953. -or-
  38954. <paramref name="index"/> is equal to or greater than the length of <paramref name="array"/>.
  38955. -or-
  38956. The number of elements in the source <see cref="T:System.Collections.ICollection"/> is greater than the available space from <paramref name="index"/> to the end of the destination <paramref name="array"/>.
  38957. </exception>
  38958. <exception cref="T:System.ArgumentException">
  38959. The type of the source <see cref="T:System.Collections.ICollection"/> cannot be cast automatically to the type of the destination <paramref name="array"/>.
  38960. </exception>
  38961. </member>
  38962. <member name="M:NPOI.Util.Collections.HashSet`1.GetEnumerator">
  38963. <summary>
  38964. Returns an enumerator that iterates through a collection.
  38965. </summary>
  38966. <returns>
  38967. An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection.
  38968. </returns>
  38969. </member>
  38970. <member name="M:NPOI.Util.Collections.HashSet`1.Remove(`0)">
  38971. <summary>
  38972. Removes the specified o.
  38973. </summary>
  38974. <param name="o">The o.</param>
  38975. </member>
  38976. <member name="M:NPOI.Util.Collections.HashSet`1.Clear">
  38977. <summary>
  38978. Removes all of the elements from this set.
  38979. The set will be empty after this call returns.
  38980. </summary>
  38981. </member>
  38982. <member name="P:NPOI.Util.Collections.HashSet`1.Count">
  38983. <summary>
  38984. Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  38985. </summary>
  38986. <value></value>
  38987. <returns>
  38988. The number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  38989. </returns>
  38990. </member>
  38991. <member name="T:NPOI.Util.Collections.Properties">
  38992. <summary>
  38993. This class comes from Java
  38994. </summary>
  38995. </member>
  38996. <member name="M:NPOI.Util.Collections.Properties.#ctor">
  38997. <summary>
  38998. Initializes a new instance of the <see cref="T:NPOI.Util.Collections.Properties"/> class.
  38999. </summary>
  39000. </member>
  39001. <member name="M:NPOI.Util.Collections.Properties.Remove(System.String)">
  39002. <summary>
  39003. Removes the specified key.
  39004. </summary>
  39005. <param name="key">The key.</param>
  39006. <returns></returns>
  39007. </member>
  39008. <member name="M:NPOI.Util.Collections.Properties.GetEnumerator">
  39009. <summary>
  39010. Gets the enumerator.
  39011. </summary>
  39012. <returns></returns>
  39013. </member>
  39014. <member name="M:NPOI.Util.Collections.Properties.ContainsKey(System.String)">
  39015. <summary>
  39016. Determines whether the specified key contains key.
  39017. </summary>
  39018. <param name="key">The key.</param>
  39019. <returns>
  39020. <c>true</c> if the specified key contains key; otherwise, <c>false</c>.
  39021. </returns>
  39022. </member>
  39023. <member name="M:NPOI.Util.Collections.Properties.Add(System.String,System.String)">
  39024. <summary>
  39025. Adds the specified key.
  39026. </summary>
  39027. <param name="key">The key.</param>
  39028. <param name="value">The value.</param>
  39029. </member>
  39030. <member name="M:NPOI.Util.Collections.Properties.Clear">
  39031. <summary>
  39032. Clears this instance.
  39033. </summary>
  39034. </member>
  39035. <member name="M:NPOI.Util.Collections.Properties.Load(System.IO.Stream)">
  39036. <summary>
  39037. Loads the specified in stream.
  39038. </summary>
  39039. <param name="inStream">The in stream.</param>
  39040. </member>
  39041. <member name="M:NPOI.Util.Collections.Properties.LoadConvert(System.String)">
  39042. <summary>
  39043. Loads the convert.
  39044. </summary>
  39045. <param name="theString">The string.</param>
  39046. <returns></returns>
  39047. <remarks>
  39048. Converts encoded &#92;uxxxx to unicode chars
  39049. and changes special saved chars to their original forms
  39050. </remarks>
  39051. </member>
  39052. <member name="M:NPOI.Util.Collections.Properties.ContinueLine(System.String)">
  39053. <summary>
  39054. Continues the line.
  39055. </summary>
  39056. <param name="line">The line.</param>
  39057. <returns></returns>
  39058. </member>
  39059. <member name="P:NPOI.Util.Collections.Properties.Count">
  39060. <summary>
  39061. Gets the count.
  39062. </summary>
  39063. <value>The count.</value>
  39064. </member>
  39065. <member name="P:NPOI.Util.Collections.Properties.Item(System.String)">
  39066. <summary>
  39067. Gets or sets the <see cref="T:System.String"/> with the specified key.
  39068. </summary>
  39069. <value></value>
  39070. </member>
  39071. <member name="P:NPOI.Util.Collections.Properties.Keys">
  39072. <summary>
  39073. Gets the keys.
  39074. </summary>
  39075. <value>The keys.</value>
  39076. </member>
  39077. <member name="T:NPOI.Util.CRC32">
  39078. <summary>
  39079. CRC Verification
  39080. </summary>
  39081. </member>
  39082. <member name="M:NPOI.Util.CRC32.#ctor">
  39083. <summary>
  39084. Initializes a new instance of the <see cref="T:NPOI.Util.CRC32"/> class.
  39085. </summary>
  39086. </member>
  39087. <member name="M:NPOI.Util.CRC32.ByteCRC(System.Byte[]@)">
  39088. <summary>
  39089. CRC Bytes.
  39090. </summary>
  39091. <param name="buffer">The buffer.</param>
  39092. <returns></returns>
  39093. </member>
  39094. <member name="M:NPOI.Util.CRC32.StringCRC(System.String)">
  39095. <summary>
  39096. String CRC
  39097. </summary>
  39098. <param name="sInputString">the string</param>
  39099. <returns></returns>
  39100. </member>
  39101. <member name="M:NPOI.Util.CRC32.FileCRC(System.String)">
  39102. <summary>
  39103. File CRC
  39104. </summary>
  39105. <param name="sInputFilename">the input file</param>
  39106. <returns></returns>
  39107. </member>
  39108. <member name="M:NPOI.Util.CRC32.StreamCRC(System.IO.Stream)">
  39109. <summary>
  39110. Stream CRC
  39111. </summary>
  39112. <param name="inFile">the input stream</param>
  39113. <returns></returns>
  39114. </member>
  39115. <member name="T:NPOI.Util.HexDump">
  39116. <summary>
  39117. dump data in hexadecimal format; derived from a HexDump utility I
  39118. wrote in June 2001.
  39119. @author Marc Johnson
  39120. @author Glen Stampoultzis (glens at apache.org)
  39121. </summary>
  39122. </member>
  39123. <member name="M:NPOI.Util.HexDump.Dump(System.IO.Stream,System.IO.Stream,System.Int32,System.Int32)">
  39124. Dumps <code>bytesToDump</code> bytes to an output stream.
  39125. @param in The stream to read from
  39126. @param out The output stream
  39127. @param start The index to use as the starting position for the left hand side label
  39128. @param bytesToDump The number of bytes to output. Use -1 to read until the end of file.
  39129. </member>
  39130. <member name="M:NPOI.Util.HexDump.ShortToHex(System.Int32)">
  39131. <summary>
  39132. Shorts to hex.
  39133. </summary>
  39134. <param name="value">The value.</param>
  39135. <returns>char array of 2 (zero padded) uppercase hex chars and prefixed with '0x'</returns>
  39136. </member>
  39137. <member name="M:NPOI.Util.HexDump.ByteToHex(System.Int32)">
  39138. <summary>
  39139. Bytes to hex.
  39140. </summary>
  39141. <param name="value">The value.</param>
  39142. <returns>char array of 1 (zero padded) uppercase hex chars and prefixed with '0x'</returns>
  39143. </member>
  39144. <member name="M:NPOI.Util.HexDump.IntToHex(System.Int32)">
  39145. <summary>
  39146. Ints to hex.
  39147. </summary>
  39148. <param name="value">The value.</param>
  39149. <returns>char array of 4 (zero padded) uppercase hex chars and prefixed with '0x'</returns>
  39150. </member>
  39151. <member name="M:NPOI.Util.HexDump.LongToHex(System.Int64)">
  39152. <summary>
  39153. char array of 4 (zero padded) uppercase hex chars and prefixed with '0x'
  39154. </summary>
  39155. <param name="value">The value.</param>
  39156. <returns>char array of 4 (zero padded) uppercase hex chars and prefixed with '0x'</returns>
  39157. </member>
  39158. <member name="M:NPOI.Util.HexDump.ToHexChars(System.Int64,System.Int32)">
  39159. <summary>
  39160. Toes the hex chars.
  39161. </summary>
  39162. <param name="pValue">The p value.</param>
  39163. <param name="nBytes">The n bytes.</param>
  39164. <returns>char array of uppercase hex chars, zero padded and prefixed with '0x'</returns>
  39165. </member>
  39166. <member name="M:NPOI.Util.HexRead.ReadData(System.String)">
  39167. <summary>
  39168. This method reads hex data from a filename and returns a byte array.
  39169. The file may contain line comments that are preceeded with a # symbol.
  39170. </summary>
  39171. <param name="filename">The filename to read</param>
  39172. <returns>The bytes read from the file.</returns>
  39173. <exception cref="T:System.IO.IOException">If there was a problem while reading the file.</exception>
  39174. </member>
  39175. <member name="M:NPOI.Util.HexRead.ReadData(System.IO.Stream,System.String)">
  39176. <summary>
  39177. Same as ReadData(String) except that this method allows you to specify sections within
  39178. a file. Sections are referenced using section headers in the form:
  39179. </summary>
  39180. <param name="stream">The stream.</param>
  39181. <param name="section">The section.</param>
  39182. <returns></returns>
  39183. </member>
  39184. <member name="M:NPOI.Util.HexRead.ReadData(System.String,System.String)">
  39185. <summary>
  39186. Reads the data.
  39187. </summary>
  39188. <param name="filename">The filename.</param>
  39189. <param name="section">The section.</param>
  39190. <returns></returns>
  39191. </member>
  39192. <member name="M:NPOI.Util.HexRead.ReadData(System.IO.Stream,System.Int32)">
  39193. <summary>
  39194. Reads the data.
  39195. </summary>
  39196. <param name="stream">The stream.</param>
  39197. <param name="eofChar">The EOF char.</param>
  39198. <returns></returns>
  39199. </member>
  39200. <member name="M:NPOI.Util.HexRead.ReadFromString(System.String)">
  39201. <summary>
  39202. Reads from string.
  39203. </summary>
  39204. <param name="data">The data.</param>
  39205. <returns></returns>
  39206. </member>
  39207. <member name="M:NPOI.Util.HexRead.ReadToEOL(System.IO.Stream)">
  39208. <summary>
  39209. Reads to EOL.
  39210. </summary>
  39211. <param name="stream">The stream.</param>
  39212. </member>
  39213. <member name="M:NPOI.Util.IntegerField.#ctor(System.Int32)">
  39214. <summary>
  39215. construct the <see cref="T:NPOI.Util.IntegerField"/> with its offset into its containing byte array class.
  39216. </summary>
  39217. <param name="offset">offset of the field within its byte array.</param>
  39218. </member>
  39219. <member name="M:NPOI.Util.IntegerField.#ctor(System.Int32,System.Int32)">
  39220. <summary>
  39221. construct the <see cref="T:NPOI.Util.IntegerField"/> with its offset into its containing
  39222. byte array and initialize its value
  39223. </summary>
  39224. <param name="offset">offset of the field within its byte array</param>
  39225. <param name="value">the initial value</param>
  39226. </member>
  39227. <member name="M:NPOI.Util.IntegerField.#ctor(System.Int32,System.Byte[])">
  39228. <summary>
  39229. Construct the <see cref="T:NPOI.Util.IntegerField"/> with its offset into its containing
  39230. byte array and initialize its value from its byte array
  39231. </summary>
  39232. <param name="offset">offset of the field within its byte array</param>
  39233. <param name="data">the byte array to Read the value from</param>
  39234. </member>
  39235. <member name="M:NPOI.Util.IntegerField.#ctor(System.Int32,System.Int32,System.Byte[])">
  39236. <summary>
  39237. construct the <see cref="T:NPOI.Util.IntegerField"/> with its offset into its containing
  39238. byte array, initialize its value, and write the value to a byte
  39239. </summary>
  39240. <param name="offset">offset of the field within its byte array</param>
  39241. <param name="value">the initial value</param>
  39242. <param name="data">the byte array to write the value to</param>
  39243. </member>
  39244. <member name="M:NPOI.Util.IntegerField.Set(System.Int32,System.Byte[])">
  39245. <summary>
  39246. Set the IntegerField's current value and write it to a byte array
  39247. </summary>
  39248. <param name="value">value to be Set</param>
  39249. <param name="data">the byte array to write the value to</param>
  39250. </member>
  39251. <member name="M:NPOI.Util.IntegerField.ReadFromBytes(System.Byte[])">
  39252. <summary>
  39253. Set the value from its offset into an array of bytes
  39254. </summary>
  39255. <param name="data">The data.</param>
  39256. </member>
  39257. <member name="M:NPOI.Util.IntegerField.ReadFromStream(System.IO.Stream)">
  39258. <summary>
  39259. Set the value from an Stream
  39260. </summary>
  39261. <param name="stream">the Stream from which the value is to be Read</param>
  39262. </member>
  39263. <member name="M:NPOI.Util.IntegerField.WriteToBytes(System.Byte[])">
  39264. <summary>
  39265. write the value out to an array of bytes at the appropriate offset
  39266. </summary>
  39267. <param name="data"> the array of bytes to which the value is to be written </param>
  39268. </member>
  39269. <member name="M:NPOI.Util.IntegerField.Write(System.Int32,System.Int32,System.Byte[])">
  39270. <summary>
  39271. Same as using the constructor <see cref="T:NPOI.Util.IntegerField"/> with the same
  39272. parameter list. Avoid creation of an useless object.
  39273. </summary>
  39274. <param name="offset">offset of the field within its byte array</param>
  39275. <param name="value">the initial value</param>
  39276. <param name="data">the byte array to write the value to</param>
  39277. </member>
  39278. <member name="M:NPOI.Util.IntegerField.ToString">
  39279. <summary>
  39280. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  39281. </summary>
  39282. <returns>
  39283. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  39284. </returns>
  39285. </member>
  39286. <member name="P:NPOI.Util.IntegerField.Value">
  39287. <summary>
  39288. get or Set the IntegerField's current value
  39289. </summary>
  39290. <value>The value.</value>
  39291. <returns></returns>
  39292. </member>
  39293. <member name="T:NPOI.Util.IntList">
  39294. <summary>
  39295. A List of int's; as full an implementation of the java.Util.List interface as possible, with an eye toward minimal creation of objects
  39296. the mimicry of List is as follows:
  39297. <ul>
  39298. <li> if possible, operations designated 'optional' in the List
  39299. interface are attempted</li>
  39300. <li> wherever the List interface refers to an Object, substitute
  39301. int</li>
  39302. <li> wherever the List interface refers to a Collection or List,
  39303. substitute IntList</li>
  39304. </ul>
  39305. the mimicry is not perfect, however:
  39306. <ul>
  39307. <li> operations involving Iterators or ListIterators are not
  39308. supported</li>
  39309. <li> Remove(Object) becomes RemoveValue to distinguish it from
  39310. Remove(int index)</li>
  39311. <li> subList is not supported</li>
  39312. </ul>
  39313. @author Marc Johnson
  39314. </summary>
  39315. </member>
  39316. <member name="M:NPOI.Util.IntList.#ctor">
  39317. <summary>
  39318. create an IntList of default size
  39319. </summary>
  39320. </member>
  39321. <member name="M:NPOI.Util.IntList.#ctor(NPOI.Util.IntList)">
  39322. <summary>
  39323. create a copy of an existing IntList
  39324. </summary>
  39325. <param name="list">the existing IntList</param>
  39326. </member>
  39327. <member name="M:NPOI.Util.IntList.#ctor(System.Int32,System.Int32)">
  39328. <summary>
  39329. create an IntList with a predefined Initial size
  39330. </summary>
  39331. <param name="initialCapacity">the size for the internal array</param>
  39332. <param name="fillvalue"></param>
  39333. </member>
  39334. <member name="M:NPOI.Util.IntList.Add(System.Int32,System.Int32)">
  39335. <summary>
  39336. add the specfied value at the specified index
  39337. </summary>
  39338. <param name="index">the index where the new value is to be Added</param>
  39339. <param name="value">the new value</param>
  39340. </member>
  39341. <member name="M:NPOI.Util.IntList.Add(System.Int32)">
  39342. <summary>
  39343. Appends the specified element to the end of this list
  39344. </summary>
  39345. <param name="value">element to be Appended to this list.</param>
  39346. <returns>return true (as per the general contract of the Collection.add method</returns>
  39347. </member>
  39348. <member name="M:NPOI.Util.IntList.AddAll(NPOI.Util.IntList)">
  39349. <summary>
  39350. Appends all of the elements in the specified collection to the
  39351. end of this list, in the order that they are returned by the
  39352. specified collection's iterator. The behavior of this
  39353. operation is unspecified if the specified collection is
  39354. modified while the operation is in progress. (Note that this
  39355. will occur if the specified collection is this list, and it's
  39356. nonempty.)
  39357. </summary>
  39358. <param name="c">collection whose elements are to be Added to this list.</param>
  39359. <returns>return true if this list Changed as a result of the call.</returns>
  39360. </member>
  39361. <member name="M:NPOI.Util.IntList.AddAll(System.Int32,NPOI.Util.IntList)">
  39362. <summary>
  39363. Inserts all of the elements in the specified collection into
  39364. this list at the specified position. Shifts the element
  39365. currently at that position (if any) and any subsequent elements
  39366. to the right (increases their indices). The new elements will
  39367. appear in this list in the order that they are returned by the
  39368. specified collection's iterator. The behavior of this
  39369. operation is unspecified if the specified collection is
  39370. modified while the operation is in progress. (Note that this
  39371. will occur if the specified collection is this list, and it's
  39372. nonempty.)
  39373. </summary>
  39374. <param name="index">index at which to insert first element from the specified collection.</param>
  39375. <param name="c">elements to be inserted into this list.</param>
  39376. <returns>return true if this list Changed as a result of the call.</returns>
  39377. </member>
  39378. <member name="M:NPOI.Util.IntList.Clear">
  39379. <summary>
  39380. Removes all of the elements from this list. This list will be
  39381. empty After this call returns (unless it throws an exception).
  39382. </summary>
  39383. </member>
  39384. <member name="M:NPOI.Util.IntList.Contains(System.Int32)">
  39385. <summary>
  39386. Returns true if this list Contains the specified element. More
  39387. formally, returns true if and only if this list Contains at
  39388. least one element e such that o == e
  39389. </summary>
  39390. <param name="o">element whose presence in this list is to be Tested.</param>
  39391. <returns>return true if this list Contains the specified element.</returns>
  39392. </member>
  39393. <member name="M:NPOI.Util.IntList.ContainsAll(NPOI.Util.IntList)">
  39394. <summary>
  39395. Returns true if this list Contains all of the elements of the
  39396. specified collection.
  39397. </summary>
  39398. <param name="c">collection to be Checked for Containment in this list.</param>
  39399. <returns>return true if this list Contains all of the elements of the specified collection.</returns>
  39400. </member>
  39401. <member name="M:NPOI.Util.IntList.Equals(System.Object)">
  39402. <summary>
  39403. Compares the specified object with this list for Equality.
  39404. Returns true if and only if the specified object is also a
  39405. list, both lists have the same size, and all corresponding
  39406. pairs of elements in the two lists are Equal. (Two elements e1
  39407. and e2 are equal if e1 == e2.) In other words, two lists are
  39408. defined to be equal if they contain the same elements in the
  39409. same order. This defInition ensures that the Equals method
  39410. works properly across different implementations of the List
  39411. interface.
  39412. </summary>
  39413. <param name="o">the object to be Compared for Equality with this list.</param>
  39414. <returns>return true if the specified object is equal to this list.</returns>
  39415. </member>
  39416. <member name="M:NPOI.Util.IntList.Get(System.Int32)">
  39417. <summary>
  39418. Returns the element at the specified position in this list.
  39419. </summary>
  39420. <param name="index">index of element to return.</param>
  39421. <returns>return the element at the specified position in this list.</returns>
  39422. </member>
  39423. <member name="M:NPOI.Util.IntList.GetHashCode">
  39424. <summary>
  39425. Returns the hash code value for this list. The hash code of a
  39426. list is defined to be the result of the following calculation:
  39427. <code>
  39428. hashCode = 1;
  39429. Iterator i = list.Iterator();
  39430. while (i.HasNext()) {
  39431. Object obj = i.Next();
  39432. hashCode = 31*hashCode + (obj==null ? 0 : obj.HashCode());
  39433. }
  39434. </code>
  39435. This ensures that list1.Equals(list2) implies that
  39436. list1.HashCode()==list2.HashCode() for any two lists, list1 and
  39437. list2, as required by the general contract of Object.HashCode.
  39438. </summary>
  39439. <returns>return the hash code value for this list.</returns>
  39440. </member>
  39441. <member name="M:NPOI.Util.IntList.IndexOf(System.Int32)">
  39442. <summary>
  39443. Returns the index in this list of the first occurrence of the
  39444. specified element, or -1 if this list does not contain this
  39445. element. More formally, returns the lowest index i such that
  39446. (o == Get(i)), or -1 if there is no such index.
  39447. </summary>
  39448. <param name="o">element to search for.</param>
  39449. <returns>return the index in this list of the first occurrence of the
  39450. specified element, or -1 if this list does not contain
  39451. this element.</returns>
  39452. </member>
  39453. <member name="M:NPOI.Util.IntList.IsEmpty">
  39454. <summary>
  39455. Returns true if this list Contains no elements.
  39456. </summary>
  39457. <returns>return true if this list Contains no elements.</returns>
  39458. </member>
  39459. <member name="M:NPOI.Util.IntList.LastIndexOf(System.Int32)">
  39460. <summary>
  39461. Returns the index in this list of the last occurrence of the
  39462. specified element, or -1 if this list does not contain this
  39463. element. More formally, returns the highest index i such that
  39464. (o == Get(i)), or -1 if there is no such index.
  39465. </summary>
  39466. <param name="o">element to search for.</param>
  39467. <returns>the index in this list of the last occurrence of the
  39468. specified element, or -1 if this list does not contain
  39469. this element.
  39470. </returns>
  39471. </member>
  39472. <member name="M:NPOI.Util.IntList.Remove(System.Int32)">
  39473. <summary>
  39474. Removes the element at the specified position in this list.
  39475. Shifts any subsequent elements to the left (subtracts one from
  39476. their indices). Returns the element that was Removed from the
  39477. list.
  39478. </summary>
  39479. <param name="index">the index of the element to Removed.</param>
  39480. <returns>return the element previously at the specified position.</returns>
  39481. </member>
  39482. <member name="M:NPOI.Util.IntList.RemoveValue(System.Int32)">
  39483. <summary>
  39484. Removes the first occurrence in this list of the specified
  39485. element (optional operation). If this list does not contain
  39486. the element, it is unChanged. More formally, Removes the
  39487. element with the lowest index i such that (o.Equals(get(i)))
  39488. (if such an element exists).
  39489. </summary>
  39490. <param name="o">element to be Removed from this list, if present.</param>
  39491. <returns>return true if this list Contained the specified element.</returns>
  39492. </member>
  39493. <member name="M:NPOI.Util.IntList.RemoveAll(NPOI.Util.IntList)">
  39494. <summary>
  39495. Removes from this list all the elements that are Contained in
  39496. the specified collection
  39497. </summary>
  39498. <param name="c">collection that defines which elements will be Removed from the list.</param>
  39499. <returns>return true if this list Changed as a result of the call.</returns>
  39500. </member>
  39501. <member name="M:NPOI.Util.IntList.RetainAll(NPOI.Util.IntList)">
  39502. <summary>
  39503. Retains only the elements in this list that are Contained in
  39504. the specified collection. In other words, Removes from this
  39505. list all the elements that are not Contained in the specified
  39506. collection.
  39507. </summary>
  39508. <param name="c">collection that defines which elements this Set will retain.</param>
  39509. <returns>return true if this list Changed as a result of the call.</returns>
  39510. </member>
  39511. <member name="M:NPOI.Util.IntList.Set(System.Int32,System.Int32)">
  39512. <summary>
  39513. Replaces the element at the specified position in this list with the specified element
  39514. </summary>
  39515. <param name="index">index of element to Replace.</param>
  39516. <param name="element">element to be stored at the specified position.</param>
  39517. <returns>the element previously at the specified position.</returns>
  39518. </member>
  39519. <member name="M:NPOI.Util.IntList.Size">
  39520. <summary>
  39521. Returns the number of elements in this list. If this list
  39522. Contains more than Int32.MaxValue elements, returns
  39523. Int32.MaxValue.
  39524. </summary>
  39525. <returns>the number of elements in this IntList</returns>
  39526. </member>
  39527. <member name="M:NPOI.Util.IntList.ToArray">
  39528. <summary>
  39529. Returns an array Containing all of the elements in this list in
  39530. proper sequence. Obeys the general contract of the
  39531. Collection.ToArray method.
  39532. </summary>
  39533. <returns>an array Containing all of the elements in this list in proper sequence.</returns>
  39534. </member>
  39535. <member name="M:NPOI.Util.IntList.ToArray(System.Int32[])">
  39536. <summary>
  39537. Returns an array Containing all of the elements in this list in
  39538. proper sequence. Obeys the general contract of the
  39539. Collection.ToArray(Object[]) method.
  39540. </summary>
  39541. <param name="a">the array into which the elements of this list are to
  39542. be stored, if it is big enough; otherwise, a new array
  39543. is allocated for this purpose.</param>
  39544. <returns>return an array Containing the elements of this list.</returns>
  39545. </member>
  39546. <member name="P:NPOI.Util.IntList.Count">
  39547. <summary>
  39548. the number of elements in this IntList
  39549. </summary>
  39550. </member>
  39551. <member name="T:NPOI.Util.IntMapper`1">
  39552. <summary>
  39553. A List of objects that are indexed AND keyed by an int; also allows for Getting
  39554. the index of a value in the list
  39555. <p>I am happy is someone wants to re-implement this without using the
  39556. internal list and hashmap. If so could you please make sure that
  39557. you can add elements half way into the list and have the value-key mappings
  39558. update</p>
  39559. </summary>
  39560. <typeparam name="T"></typeparam>
  39561. <remarks>@author Jason Height</remarks>
  39562. </member>
  39563. <member name="M:NPOI.Util.IntMapper`1.#ctor">
  39564. <summary>
  39565. create an IntMapper of default size
  39566. </summary>
  39567. </member>
  39568. <member name="M:NPOI.Util.IntMapper`1.Add(`0)">
  39569. <summary>
  39570. Appends the specified element to the end of this list
  39571. </summary>
  39572. <param name="value">element to be Appended to this list.</param>
  39573. <returns>return true (as per the general contract of the Collection.add method)</returns>
  39574. </member>
  39575. <member name="M:NPOI.Util.IntMapper`1.GetIndex(`0)">
  39576. <summary>
  39577. Gets the index of T object.
  39578. </summary>
  39579. <param name="o">The o.</param>
  39580. <returns></returns>
  39581. </member>
  39582. <member name="M:NPOI.Util.IntMapper`1.GetEnumerator">
  39583. <summary>
  39584. Gets the enumerator.
  39585. </summary>
  39586. <returns></returns>
  39587. </member>
  39588. <member name="P:NPOI.Util.IntMapper`1.Size">
  39589. <summary>
  39590. Gets the size.
  39591. </summary>
  39592. </member>
  39593. <member name="P:NPOI.Util.IntMapper`1.Item(System.Int32)">
  39594. <summary>
  39595. Gets the T object at the specified index.
  39596. </summary>
  39597. <param name="index"></param>
  39598. <returns></returns>
  39599. </member>
  39600. <member name="M:NPOI.Util.IOUtils.ToByteArray(System.IO.Stream)">
  39601. <summary>
  39602. Reads all the data from the input stream, and returns
  39603. the bytes Read.
  39604. </summary>
  39605. <param name="stream">The stream.</param>
  39606. <returns></returns>
  39607. <remarks>Tony Qu changed the code</remarks>
  39608. </member>
  39609. <member name="M:NPOI.Util.IOUtils.ReadFully(System.IO.Stream,System.Byte[])">
  39610. <summary>
  39611. Reads the fully.
  39612. </summary>
  39613. <param name="stream">The stream.</param>
  39614. <param name="b">The b.</param>
  39615. <returns></returns>
  39616. </member>
  39617. <member name="M:NPOI.Util.IOUtils.ReadFully(System.IO.Stream,System.Byte[],System.Int32,System.Int32)">
  39618. <summary>
  39619. Same as the normal
  39620. <c>in.Read(b, off, len)</c>
  39621. , but tries to ensure that the entire len number of bytes is Read.
  39622. If the end of file is reached before any bytes are Read, returns -1.
  39623. If the end of the file is reached after some bytes are
  39624. Read, returns the number of bytes Read.
  39625. If the end of the file isn't reached before len
  39626. bytes have been Read, will return len bytes.
  39627. </summary>
  39628. <param name="stream">The stream.</param>
  39629. <param name="b">The b.</param>
  39630. <param name="off">The off.</param>
  39631. <param name="len">The len.</param>
  39632. <returns></returns>
  39633. </member>
  39634. <member name="M:NPOI.Util.IOUtils.Copy(System.IO.Stream,System.IO.Stream)">
  39635. <summary>
  39636. Copies all the data from the given InputStream to the OutputStream. It
  39637. leaves both streams open, so you will still need to close them once done.
  39638. </summary>
  39639. <param name="inp"></param>
  39640. <param name="out1"></param>
  39641. </member>
  39642. <member name="T:NPOI.Util.LittleEndianByteArrayInputStream">
  39643. <summary>
  39644. Adapts a plain byte array to <see cref="T:NPOI.Util.ILittleEndianInput"/>
  39645. </summary>
  39646. <remarks>@author Josh Micich</remarks>
  39647. </member>
  39648. <member name="T:NPOI.Util.LittleEndianByteArrayOutputStream">
  39649. <summary>
  39650. Adapts a plain byte array to <see cref="T:NPOI.Util.ILittleEndianOutput"/>
  39651. </summary>
  39652. <remarks>@author Josh Micich</remarks>
  39653. </member>
  39654. <member name="T:NPOI.Util.LittleEndianInputStream">
  39655. <summary>
  39656. Wraps an <see cref="T:System.IO.Stream"/> providing <see cref="T:NPOI.Util.ILittleEndianInput"/><p/>
  39657. This class does not buffer any input, so the stream Read position maintained
  39658. by this class is consistent with that of the inner stream.
  39659. </summary>
  39660. <remarks>
  39661. @author Josh Micich
  39662. </remarks>
  39663. </member>
  39664. <member name="T:NPOI.Util.LittleEndianOutputStream">
  39665. <summary>
  39666. Wraps an <see cref="T:System.IO.Stream"/> providing <see cref="T:NPOI.Util.ILittleEndianOutput"/>
  39667. </summary>
  39668. <remarks>@author Josh Micich</remarks>
  39669. </member>
  39670. <member name="T:NPOI.Util.LittleEndian">
  39671. <summary>
  39672. a utility class for handling little-endian numbers, which the 80x86 world is
  39673. replete with. The methods are all static, and input/output is from/to byte
  39674. arrays, or from InputStreams.
  39675. </summary>
  39676. <remarks>
  39677. @author Marc Johnson (mjohnson at apache dot org)
  39678. @author Andrew Oliver (acoliver at apache dot org)
  39679. </remarks>
  39680. </member>
  39681. <member name="M:NPOI.Util.LittleEndian.#ctor">
  39682. <summary>
  39683. Initializes a new instance of the <see cref="T:NPOI.Util.LittleEndian"/> class.
  39684. </summary>
  39685. </member>
  39686. <member name="M:NPOI.Util.LittleEndian.GetShort(System.Byte[],System.Int32)">
  39687. <summary>
  39688. get a short value from a byte array
  39689. </summary>
  39690. <param name="data">the byte array</param>
  39691. <param name="offset">a starting offset into the byte array</param>
  39692. <returns>the short (16-bit) value</returns>
  39693. </member>
  39694. <member name="M:NPOI.Util.LittleEndian.GetUShort(System.Byte[],System.Int32)">
  39695. <summary>
  39696. get an unsigned short value from a byte array
  39697. </summary>
  39698. <param name="data">the byte array</param>
  39699. <param name="offset">a starting offset into the byte array</param>
  39700. <returns>the unsigned short (16-bit) value in an integer</returns>
  39701. </member>
  39702. <member name="M:NPOI.Util.LittleEndian.GetShort(System.Byte[])">
  39703. <summary>
  39704. get a short value from a byte array
  39705. </summary>
  39706. <param name="data">a starting offset into the byte array</param>
  39707. <returns>the short (16-bit) value</returns>
  39708. </member>
  39709. <member name="M:NPOI.Util.LittleEndian.GetUShort(System.Byte[])">
  39710. <summary>
  39711. get a short value from a byte array
  39712. </summary>
  39713. <param name="data">the unsigned short (16-bit) value in an integer</param>
  39714. <returns></returns>
  39715. </member>
  39716. <member name="M:NPOI.Util.LittleEndian.GetInt(System.Byte[],System.Int32)">
  39717. <summary>
  39718. get an int value from a byte array
  39719. </summary>
  39720. <param name="data">the byte array</param>
  39721. <param name="offset">a starting offset into the byte array</param>
  39722. <returns>the int (32-bit) value</returns>
  39723. </member>
  39724. <member name="M:NPOI.Util.LittleEndian.GetInt(System.Byte[])">
  39725. <summary>
  39726. get an int value from the beginning of a byte array
  39727. </summary>
  39728. <param name="data">the byte array</param>
  39729. <returns>the int (32-bit) value</returns>
  39730. </member>
  39731. <member name="M:NPOI.Util.LittleEndian.GetUInt(System.Byte[],System.Int32)">
  39732. <summary>
  39733. Gets the U int.
  39734. </summary>
  39735. <param name="data">the byte array</param>
  39736. <param name="offset">a starting offset into the byte array</param>
  39737. <returns>the unsigned int (32-bit) value in a long</returns>
  39738. </member>
  39739. <member name="M:NPOI.Util.LittleEndian.GetUInt(System.Byte[])">
  39740. <summary>
  39741. Gets the U int.
  39742. </summary>
  39743. <param name="data">the byte array</param>
  39744. <returns>the unsigned int (32-bit) value in a long</returns>
  39745. </member>
  39746. <member name="M:NPOI.Util.LittleEndian.GetLong(System.Byte[],System.Int32)">
  39747. <summary>
  39748. get a long value from a byte array
  39749. </summary>
  39750. <param name="data">the byte array</param>
  39751. <param name="offset">a starting offset into the byte array</param>
  39752. <returns>the long (64-bit) value</returns>
  39753. </member>
  39754. <member name="M:NPOI.Util.LittleEndian.GetDouble(System.Byte[],System.Int32)">
  39755. <summary>
  39756. get a double value from a byte array, reads it in little endian format
  39757. then converts the resulting revolting IEEE 754 (curse them) floating
  39758. point number to a c# double
  39759. </summary>
  39760. <param name="data">the byte array</param>
  39761. <param name="offset">a starting offset into the byte array</param>
  39762. <returns>the double (64-bit) value</returns>
  39763. </member>
  39764. <member name="M:NPOI.Util.LittleEndian.PutShort(System.Byte[],System.Int32,System.Int16)">
  39765. <summary>
  39766. Puts the short.
  39767. </summary>
  39768. <param name="data">the byte array</param>
  39769. <param name="offset">a starting offset into the byte array</param>
  39770. <param name="value">The value.</param>
  39771. </member>
  39772. <member name="M:NPOI.Util.LittleEndian.PutByte(System.Byte[],System.Int32,System.Int32)">
  39773. <summary>
  39774. Added for consistency with other put~() methods
  39775. </summary>
  39776. <param name="data">the byte array</param>
  39777. <param name="offset">a starting offset into the byte array</param>
  39778. <param name="value">The value.</param>
  39779. </member>
  39780. <member name="M:NPOI.Util.LittleEndian.PutUShort(System.Byte[],System.Int32,System.Int32)">
  39781. <summary>
  39782. Puts the U short.
  39783. </summary>
  39784. <param name="data">the byte array</param>
  39785. <param name="offset">a starting offset into the byte array</param>
  39786. <param name="value">The value.</param>
  39787. </member>
  39788. <member name="M:NPOI.Util.LittleEndian.PutShort(System.Byte[],System.Int16)">
  39789. <summary>
  39790. put a short value into beginning of a byte array
  39791. </summary>
  39792. <param name="data">the byte array</param>
  39793. <param name="value">the short (16-bit) value</param>
  39794. </member>
  39795. <member name="M:NPOI.Util.LittleEndian.PutShort(System.IO.Stream,System.Int16)">
  39796. Put signed short into output stream
  39797. @param value
  39798. the short (16-bit) value
  39799. @param outputStream
  39800. output stream
  39801. @throws IOException
  39802. if an I/O error occurs
  39803. </member>
  39804. <member name="M:NPOI.Util.LittleEndian.PutInt(System.Byte[],System.Int32,System.Int32)">
  39805. <summary>
  39806. put an int value into a byte array
  39807. </summary>
  39808. <param name="data">the byte array</param>
  39809. <param name="offset">a starting offset into the byte array</param>
  39810. <param name="value">the int (32-bit) value</param>
  39811. </member>
  39812. <member name="M:NPOI.Util.LittleEndian.PutInt(System.Byte[],System.Int32)">
  39813. <summary>
  39814. put an int value into beginning of a byte array
  39815. </summary>
  39816. <param name="data">the byte array</param>
  39817. <param name="value">the int (32-bit) value</param>
  39818. </member>
  39819. <member name="M:NPOI.Util.LittleEndian.PutInt(System.Int32,System.IO.Stream)">
  39820. <summary>
  39821. Put int into output stream
  39822. </summary>
  39823. <param name="value">the int (32-bit) value</param>
  39824. <param name="outputStream">output stream</param>
  39825. </member>
  39826. <member name="M:NPOI.Util.LittleEndian.PutLong(System.Byte[],System.Int32,System.Int64)">
  39827. <summary>
  39828. put a long value into a byte array
  39829. </summary>
  39830. <param name="data">the byte array</param>
  39831. <param name="offset">a starting offset into the byte array</param>
  39832. <param name="value">the long (64-bit) value</param>
  39833. </member>
  39834. <member name="M:NPOI.Util.LittleEndian.PutDouble(System.Byte[],System.Int32,System.Double)">
  39835. <summary>
  39836. put a double value into a byte array
  39837. </summary>
  39838. <param name="data">the byte array</param>
  39839. <param name="offset">a starting offset into the byte array</param>
  39840. <param name="value">the double (64-bit) value</param>
  39841. </member>
  39842. <member name="M:NPOI.Util.LittleEndian.ReadShort(System.IO.Stream)">
  39843. <summary>
  39844. Reads the short.
  39845. </summary>
  39846. <param name="stream">The stream.</param>
  39847. <returns></returns>
  39848. </member>
  39849. <member name="M:NPOI.Util.LittleEndian.ReadInt(System.IO.Stream)">
  39850. <summary>
  39851. get an int value from an Stream
  39852. </summary>
  39853. <param name="stream">the Stream from which the int is to be read</param>
  39854. <returns>the int (32-bit) value</returns>
  39855. <exception cref="T:System.IO.IOException">will be propagated back to the caller</exception>
  39856. <exception cref="T:NPOI.Util.BufferUnderrunException">if the stream cannot provide enough bytes</exception>
  39857. </member>
  39858. <member name="M:NPOI.Util.LittleEndian.ReadLong(System.IO.Stream)">
  39859. <summary>
  39860. get a long value from a Stream
  39861. </summary>
  39862. <param name="stream">the Stream from which the long is to be read</param>
  39863. <returns>the long (64-bit) value</returns>
  39864. <exception cref="T:System.IO.IOException">will be propagated back to the caller</exception>
  39865. <exception cref="T:NPOI.Util.BufferUnderrunException">if the stream cannot provide enough bytes</exception>
  39866. </member>
  39867. <member name="M:NPOI.Util.LittleEndian.UByteToInt(System.Byte)">
  39868. <summary>
  39869. Us the byte to int.
  39870. </summary>
  39871. <param name="b">The b.</param>
  39872. <returns></returns>
  39873. </member>
  39874. <member name="M:NPOI.Util.LittleEndian.GetUnsignedByte(System.Byte[],System.Int32)">
  39875. <summary>
  39876. get the unsigned value of a byte.
  39877. </summary>
  39878. <param name="data">the byte array.</param>
  39879. <param name="offset">a starting offset into the byte array.</param>
  39880. <returns>the unsigned value of the byte as a 32 bit integer</returns>
  39881. </member>
  39882. <member name="M:NPOI.Util.LittleEndian.GetByteArray(System.Byte[],System.Int32,System.Int32)">
  39883. <summary>
  39884. Copy a portion of a byte array
  39885. </summary>
  39886. <param name="data"> the original byte array</param>
  39887. <param name="offset">Where to start copying from.</param>
  39888. <param name="size">Number of bytes to copy.</param>
  39889. <returns>The byteArray value</returns>
  39890. <exception cref="T:System.IndexOutOfRangeException">
  39891. if copying would cause access ofdata outside array bounds.
  39892. </exception>
  39893. </member>
  39894. <member name="M:NPOI.Util.LittleEndian.GetUByte(System.Byte[])">
  39895. <summary>
  39896. Gets the unsigned byte.
  39897. </summary>
  39898. <param name="data">the byte array</param>
  39899. <returns></returns>
  39900. </member>
  39901. <member name="M:NPOI.Util.LittleEndian.GetUByte(System.Byte[],System.Int32)">
  39902. <summary>
  39903. Gets the unsigned byte.
  39904. </summary>
  39905. <param name="data">the byte array</param>
  39906. <param name="offset">a starting offset into the byte array</param>
  39907. <returns></returns>
  39908. </member>
  39909. <member name="M:NPOI.Util.LittleEndian.PutDouble(System.Byte[],System.Double)">
  39910. <summary>
  39911. Puts the double.
  39912. </summary>
  39913. <param name="data">the byte array</param>
  39914. <param name="value">The value.</param>
  39915. </member>
  39916. <member name="M:NPOI.Util.LittleEndian.PutDouble(System.Double,System.IO.Stream)">
  39917. put a double value into a byte array
  39918. @param value
  39919. the double (64-bit) value
  39920. @param outputStream
  39921. output stream
  39922. @throws IOException
  39923. if an I/O error occurs
  39924. </member>
  39925. <member name="M:NPOI.Util.LittleEndian.PutUInt(System.Byte[],System.UInt32)">
  39926. <summary>
  39927. Puts the uint.
  39928. </summary>
  39929. <param name="data">the byte array</param>
  39930. <param name="value">The value.</param>
  39931. </member>
  39932. <member name="M:NPOI.Util.LittleEndian.PutUInt(System.Int64,System.IO.Stream)">
  39933. Put unsigned int into output stream
  39934. @param value
  39935. the int (32-bit) value
  39936. @param outputStream
  39937. output stream
  39938. @throws IOException
  39939. if an I/O error occurs
  39940. </member>
  39941. <member name="M:NPOI.Util.LittleEndian.PutUInt(System.Byte[],System.Int32,System.UInt32)">
  39942. <summary>
  39943. Puts the uint.
  39944. </summary>
  39945. <param name="data">the byte array</param>
  39946. <param name="offset">a starting offset into the byte array</param>
  39947. <param name="value">The value.</param>
  39948. </member>
  39949. <member name="M:NPOI.Util.LittleEndian.PutLong(System.Byte[],System.Int64)">
  39950. <summary>
  39951. Puts the long.
  39952. </summary>
  39953. <param name="data">the byte array</param>
  39954. <param name="value">The value.</param>
  39955. </member>
  39956. <member name="M:NPOI.Util.LittleEndian.PutLong(System.Int64,System.IO.Stream)">
  39957. Put long into output stream
  39958. @param value
  39959. the long (64-bit) value
  39960. @param outputStream
  39961. output stream
  39962. @throws IOException
  39963. if an I/O error occurs
  39964. </member>
  39965. <member name="M:NPOI.Util.LittleEndian.PutULong(System.Byte[],System.UInt64)">
  39966. <summary>
  39967. Puts the long.
  39968. </summary>
  39969. <param name="data">the byte array</param>
  39970. <param name="value">The value.</param>
  39971. </member>
  39972. <member name="M:NPOI.Util.LittleEndian.PutULong(System.Byte[],System.Int32,System.UInt64)">
  39973. <summary>
  39974. Puts the ulong.
  39975. </summary>
  39976. <param name="data">the byte array</param>
  39977. <param name="offset">a starting offset into the byte array</param>
  39978. <param name="value">The value.</param>
  39979. </member>
  39980. <member name="M:NPOI.Util.LittleEndian.PutNumber(System.Byte[],System.Int32,System.Int64,System.Int32)">
  39981. <summary>
  39982. Puts the number.
  39983. </summary>
  39984. <param name="data">the byte array</param>
  39985. <param name="offset">a starting offset into the byte array</param>
  39986. <param name="value">The value.</param>
  39987. <param name="size">The size.</param>
  39988. </member>
  39989. <member name="M:NPOI.Util.LittleEndian.PutNumber(System.Byte[],System.Int32,System.UInt64,System.Int32)">
  39990. <summary>
  39991. Puts the number.
  39992. </summary>
  39993. <param name="data">the byte array</param>
  39994. <param name="offset">a starting offset into the byte array</param>
  39995. <param name="value">The value.</param>
  39996. <param name="size">The size.</param>
  39997. </member>
  39998. <member name="M:NPOI.Util.LittleEndian.PutShortArray(System.Byte[],System.Int32,System.Int16[])">
  39999. <summary>
  40000. Puts the short array.
  40001. </summary>
  40002. <param name="data">the byte array</param>
  40003. <param name="offset">a starting offset into the byte array</param>
  40004. <param name="value">The value.</param>
  40005. </member>
  40006. <member name="M:NPOI.Util.LittleEndian.PutUShort(System.Byte[],System.Int32)">
  40007. <summary>
  40008. Puts the U short.
  40009. </summary>
  40010. <param name="data">the byte array</param>
  40011. <param name="value">The value.</param>
  40012. </member>
  40013. <member name="M:NPOI.Util.LittleEndian.PutUShort(System.Int32,System.IO.Stream)">
  40014. Put unsigned short into output stream
  40015. @param value
  40016. the unsigned short (16-bit) value
  40017. @param outputStream
  40018. output stream
  40019. @throws IOException
  40020. if an I/O error occurs
  40021. </member>
  40022. <member name="M:NPOI.Util.LittleEndian.ReadFromStream(System.IO.Stream,System.Int32)">
  40023. <summary>
  40024. Reads from stream.
  40025. </summary>
  40026. <param name="stream">The stream.</param>
  40027. <param name="size">The size.</param>
  40028. <returns></returns>
  40029. </member>
  40030. <member name="M:NPOI.Util.LittleEndian.ReadULong(System.IO.Stream)">
  40031. <summary>
  40032. Reads the long.
  40033. </summary>
  40034. <param name="stream">The stream.</param>
  40035. <returns></returns>
  40036. </member>
  40037. <member name="M:NPOI.Util.LongField.#ctor(System.Int32)">
  40038. <summary>
  40039. construct the <see cref="T:NPOI.Util.LongField"/> with its offset into its containing byte array
  40040. </summary>
  40041. <param name="offset">The offset.</param>
  40042. </member>
  40043. <member name="M:NPOI.Util.LongField.#ctor(System.Int32,System.Int64)">
  40044. <summary>
  40045. construct the LongField with its offset into its containing
  40046. byte array and initialize its value
  40047. </summary>
  40048. <param name="offset">offset of the field within its byte array</param>
  40049. <param name="value">the initial value</param>
  40050. </member>
  40051. <member name="M:NPOI.Util.LongField.#ctor(System.Int32,System.Byte[])">
  40052. <summary>
  40053. Construct the <see cref="T:NPOI.Util.LongField"/> class with its offset into its containing
  40054. byte array and initialize its value from its byte array
  40055. </summary>
  40056. <param name="offset">The offset of the field within its byte array</param>
  40057. <param name="data">the byte array to read the value from</param>
  40058. </member>
  40059. <member name="M:NPOI.Util.LongField.#ctor(System.Int32,System.Int64,System.Byte[])">
  40060. <summary>
  40061. construct the <see cref="T:NPOI.Util.LongField"/> class with its offset into its containing
  40062. byte array, initialize its value, and write the value to a byte
  40063. array
  40064. </summary>
  40065. <param name="offset">offset of the field within its byte array</param>
  40066. <param name="value">the initial value</param>
  40067. <param name="data">the byte array to write the value to</param>
  40068. </member>
  40069. <member name="M:NPOI.Util.LongField.Set(System.Int64,System.Byte[])">
  40070. <summary>
  40071. set the LongField's current value and write it to a byte array
  40072. </summary>
  40073. <param name="value">value to be set</param>
  40074. <param name="data">the byte array to write the value to</param>
  40075. </member>
  40076. <member name="M:NPOI.Util.LongField.ReadFromBytes(System.Byte[])">
  40077. <summary>
  40078. set the value from its offset into an array of bytes
  40079. </summary>
  40080. <param name="data">the byte array from which the value is to be read</param>
  40081. </member>
  40082. <member name="M:NPOI.Util.LongField.ReadFromStream(System.IO.Stream)">
  40083. <summary>
  40084. set the value from an Stream
  40085. </summary>
  40086. <param name="stream">the Stream from which the value is to be</param>
  40087. </member>
  40088. <member name="M:NPOI.Util.LongField.WriteToBytes(System.Byte[])">
  40089. <summary>
  40090. write the value out to an array of bytes at the appropriate offset
  40091. </summary>
  40092. <param name="data">the array of bytes to which the value is to be written</param>
  40093. </member>
  40094. <member name="M:NPOI.Util.LongField.Write(System.Int32,System.Int64,System.Byte[])">
  40095. <summary>
  40096. Same as using the constructor <see cref="T:NPOI.Util.LongField"/> with the same
  40097. parameter list. Avoid creation of an useless object.
  40098. </summary>
  40099. <param name="offset">offset of the field within its byte array</param>
  40100. <param name="value">the initial value</param>
  40101. <param name="data">the byte array to write the value to</param>
  40102. </member>
  40103. <member name="M:NPOI.Util.LongField.ToString">
  40104. <summary>
  40105. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  40106. </summary>
  40107. <returns>
  40108. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  40109. </returns>
  40110. </member>
  40111. <member name="P:NPOI.Util.LongField.Value">
  40112. <summary>
  40113. Getg or sets the LongField's current value
  40114. </summary>
  40115. <value>The current value</value>
  40116. </member>
  40117. <member name="T:NPOI.Util.LZWDecompresser">
  40118. This class provides common functionality for the
  40119. various LZW implementations in the different file
  40120. formats.
  40121. It's currently used by HDGF and HMEF.
  40122. Two good resources on LZW are:
  40123. http://en.wikipedia.org/wiki/LZW
  40124. http://marknelson.us/1989/10/01/lzw-data-compression/
  40125. </member>
  40126. <member name="F:NPOI.Util.LZWDecompresser.maskMeansCompressed">
  40127. Does the mask bit mean it's compressed or uncompressed?
  40128. </member>
  40129. <member name="F:NPOI.Util.LZWDecompresser.codeLengthIncrease">
  40130. How much to append to the code length in the stream
  40131. to Get the real code length? Normally 2 or 3
  40132. </member>
  40133. <member name="F:NPOI.Util.LZWDecompresser.positionIsBigEndian">
  40134. Does the 12 bits of the position Get stored in
  40135. Little Endian or Big Endian form?
  40136. This controls whether a pos+length of 0x12 0x34
  40137. becomes a position of 0x123 or 0x312
  40138. </member>
  40139. <member name="M:NPOI.Util.LZWDecompresser.populateDictionary(System.Byte[])">
  40140. Populates the dictionary, and returns where in it
  40141. to begin writing new codes.
  40142. Generally, if the dictionary is pre-populated, then new
  40143. codes should be placed at the end of that block.
  40144. Equally, if the dictionary is left with all zeros, then
  40145. usually the new codes can go in at the start.
  40146. </member>
  40147. <member name="M:NPOI.Util.LZWDecompresser.adjustDictionaryOffset(System.Int32)">
  40148. Adjusts the position offset if needed when looking
  40149. something up in the dictionary.
  40150. </member>
  40151. <member name="M:NPOI.Util.LZWDecompresser.decompress(System.IO.Stream)">
  40152. Decompresses the given input stream, returning the array of bytes
  40153. of the decompressed input.
  40154. </member>
  40155. <member name="M:NPOI.Util.LZWDecompresser.decompress(System.IO.Stream,System.IO.Stream)">
  40156. Perform a streaming decompression of the input.
  40157. Works by:
  40158. 1) Reading a flag byte, the 8 bits of which tell you if the
  40159. following 8 codes are compressed our un-compressed
  40160. 2) Consider the 8 bits in turn
  40161. 3) If the bit is Set, the next code is un-compressed, so
  40162. add it to the dictionary and output it
  40163. 4) If the bit isn't Set, then read in the length and start
  40164. position in the dictionary, and output the bytes there
  40165. 5) Loop until we've done all 8 bits, then read in the next
  40166. flag byte
  40167. </member>
  40168. <member name="M:NPOI.Util.LZWDecompresser.fromInt(System.Int32)">
  40169. Given an integer, turn it into a java byte, handling
  40170. the wrapping.
  40171. This is a convenience method
  40172. </member>
  40173. <member name="M:NPOI.Util.LZWDecompresser.fromByte(System.Byte)">
  40174. Given a java byte, turn it into an integer between 0
  40175. and 255 (i.e. handle the unwrapping).
  40176. This is a convenience method
  40177. </member>
  40178. <member name="T:NPOI.Util.NullLogger">
  40179. <summary>
  40180. A Logger class that strives to make it as easy as possible for
  40181. developers to write Log calls, while simultaneously making those
  40182. calls as cheap as possible by performing lazy evaluation of the Log
  40183. message.
  40184. @author Marc Johnson (mjohnson at apache dot org)
  40185. @author Glen Stampoultzis (glens at apache.org)
  40186. @author Nicola Ken Barozzi (nicolaken at apache.org)
  40187. </summary>
  40188. </member>
  40189. <member name="M:NPOI.Util.POILogger.#ctor">
  40190. package scope so it cannot be instantiated outside of the util
  40191. package. You need a POILogger? Go to the POILogFactory for one
  40192. </member>
  40193. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object)">
  40194. Log a message
  40195. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40196. @param obj1 The object to Log. This is converted to a string.
  40197. </member>
  40198. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Exception)">
  40199. Log a message
  40200. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40201. @param obj1 The object to Log. This is converted to a string.
  40202. @param exception An exception to be Logged
  40203. </member>
  40204. <member name="M:NPOI.Util.POILogger.Check(System.Int32)">
  40205. Check if a Logger is enabled to Log at the specified level
  40206. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40207. </member>
  40208. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object)">
  40209. Log a message. Lazily appends Object parameters together.
  40210. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40211. @param obj1 first object to place in the message
  40212. @param obj2 second object to place in the message
  40213. </member>
  40214. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object)">
  40215. Log a message. Lazily appends Object parameters together.
  40216. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40217. @param obj1 first Object to place in the message
  40218. @param obj2 second Object to place in the message
  40219. @param obj3 third Object to place in the message
  40220. </member>
  40221. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object)">
  40222. Log a message. Lazily appends Object parameters together.
  40223. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40224. @param obj1 first Object to place in the message
  40225. @param obj2 second Object to place in the message
  40226. @param obj3 third Object to place in the message
  40227. @param obj4 fourth Object to place in the message
  40228. </member>
  40229. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object)">
  40230. Log a message. Lazily appends Object parameters together.
  40231. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40232. @param obj1 first Object to place in the message
  40233. @param obj2 second Object to place in the message
  40234. @param obj3 third Object to place in the message
  40235. @param obj4 fourth Object to place in the message
  40236. @param obj5 fifth Object to place in the message
  40237. </member>
  40238. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  40239. Log a message. Lazily appends Object parameters together.
  40240. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40241. @param obj1 first Object to place in the message
  40242. @param obj2 second Object to place in the message
  40243. @param obj3 third Object to place in the message
  40244. @param obj4 fourth Object to place in the message
  40245. @param obj5 fifth Object to place in the message
  40246. @param obj6 sixth Object to place in the message
  40247. </member>
  40248. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  40249. Log a message. Lazily appends Object parameters together.
  40250. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40251. @param obj1 first Object to place in the message
  40252. @param obj2 second Object to place in the message
  40253. @param obj3 third Object to place in the message
  40254. @param obj4 fourth Object to place in the message
  40255. @param obj5 fifth Object to place in the message
  40256. @param obj6 sixth Object to place in the message
  40257. @param obj7 seventh Object to place in the message
  40258. </member>
  40259. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  40260. Log a message. Lazily appends Object parameters together.
  40261. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40262. @param obj1 first Object to place in the message
  40263. @param obj2 second Object to place in the message
  40264. @param obj3 third Object to place in the message
  40265. @param obj4 fourth Object to place in the message
  40266. @param obj5 fifth Object to place in the message
  40267. @param obj6 sixth Object to place in the message
  40268. @param obj7 seventh Object to place in the message
  40269. @param obj8 eighth Object to place in the message
  40270. </member>
  40271. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Exception)">
  40272. Log an exception, without a message
  40273. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40274. @param exception An exception to be Logged
  40275. </member>
  40276. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Exception)">
  40277. Log a message. Lazily appends Object parameters together.
  40278. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40279. @param obj1 first Object to place in the message
  40280. @param obj2 second Object to place in the message
  40281. @param exception An exception to be Logged
  40282. </member>
  40283. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Exception)">
  40284. Log a message. Lazily appends Object parameters together.
  40285. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40286. @param obj1 first Object to place in the message
  40287. @param obj2 second Object to place in the message
  40288. @param obj3 third object to place in the message
  40289. @param exception An error message to be Logged
  40290. </member>
  40291. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  40292. Log a message. Lazily appends Object parameters together.
  40293. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40294. @param obj1 first Object to place in the message
  40295. @param obj2 second Object to place in the message
  40296. @param obj3 third object to place in the message
  40297. @param obj4 fourth object to place in the message
  40298. @param exception An exception to be Logged
  40299. </member>
  40300. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  40301. Log a message. Lazily appends Object parameters together.
  40302. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40303. @param obj1 first Object to place in the message
  40304. @param obj2 second Object to place in the message
  40305. @param obj3 third object to place in the message
  40306. @param obj4 fourth object to place in the message
  40307. @param obj5 fifth object to place in the message
  40308. @param exception An exception to be Logged
  40309. </member>
  40310. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  40311. Log a message. Lazily appends Object parameters together.
  40312. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40313. @param obj1 first Object to place in the message
  40314. @param obj2 second Object to place in the message
  40315. @param obj3 third object to place in the message
  40316. @param obj4 fourth object to place in the message
  40317. @param obj5 fifth object to place in the message
  40318. @param obj6 sixth object to place in the message
  40319. @param exception An exception to be Logged
  40320. </member>
  40321. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  40322. Log a message. Lazily appends Object parameters together.
  40323. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40324. @param obj1 first Object to place in the message
  40325. @param obj2 second Object to place in the message
  40326. @param obj3 third object to place in the message
  40327. @param obj4 fourth object to place in the message
  40328. @param obj5 fifth object to place in the message
  40329. @param obj6 sixth object to place in the message
  40330. @param obj7 seventh object to place in the message
  40331. @param exception An exception to be Logged
  40332. </member>
  40333. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  40334. Log a message. Lazily appends Object parameters together.
  40335. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40336. @param obj1 first Object to place in the message
  40337. @param obj2 second Object to place in the message
  40338. @param obj3 third object to place in the message
  40339. @param obj4 fourth object to place in the message
  40340. @param obj5 fifth object to place in the message
  40341. @param obj6 sixth object to place in the message
  40342. @param obj7 seventh object to place in the message
  40343. @param obj8 eighth object to place in the message
  40344. @param exception An exception to be Logged
  40345. </member>
  40346. <member name="M:NPOI.Util.POILogger.LogFormatted(System.Int32,System.String,System.Object)">
  40347. Logs a formated message. The message itself may contain %
  40348. characters as place holders. This routine will attempt to match
  40349. the placeholder by looking at the type of parameter passed to
  40350. obj1.
  40351. If the parameter is an array, it traverses the array first and
  40352. matches parameters sequentially against the array items.
  40353. Otherwise the parameters after <c>message</c> are matched
  40354. in order.
  40355. If the place holder matches against a number it is printed as a
  40356. whole number. This can be overridden by specifying a precision
  40357. in the form %n.m where n is the padding for the whole part and
  40358. m is the number of decimal places to display. n can be excluded
  40359. if desired. n and m may not be more than 9.
  40360. If the last parameter (after flattening) is a Exception it is
  40361. Logged specially.
  40362. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40363. @param message The message to Log.
  40364. @param obj1 The first object to match against.
  40365. </member>
  40366. <member name="M:NPOI.Util.POILogger.LogFormatted(System.Int32,System.String,System.Object,System.Object)">
  40367. Logs a formated message. The message itself may contain %
  40368. characters as place holders. This routine will attempt to match
  40369. the placeholder by looking at the type of parameter passed to
  40370. obj1.
  40371. If the parameter is an array, it traverses the array first and
  40372. matches parameters sequentially against the array items.
  40373. Otherwise the parameters after <c>message</c> are matched
  40374. in order.
  40375. If the place holder matches against a number it is printed as a
  40376. whole number. This can be overridden by specifying a precision
  40377. in the form %n.m where n is the padding for the whole part and
  40378. m is the number of decimal places to display. n can be excluded
  40379. if desired. n and m may not be more than 9.
  40380. If the last parameter (after flattening) is a Exception it is
  40381. Logged specially.
  40382. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40383. @param message The message to Log.
  40384. @param obj1 The first object to match against.
  40385. @param obj2 The second object to match against.
  40386. </member>
  40387. <member name="M:NPOI.Util.POILogger.LogFormatted(System.Int32,System.String,System.Object,System.Object,System.Object)">
  40388. Logs a formated message. The message itself may contain %
  40389. characters as place holders. This routine will attempt to match
  40390. the placeholder by looking at the type of parameter passed to
  40391. obj1.
  40392. If the parameter is an array, it traverses the array first and
  40393. matches parameters sequentially against the array items.
  40394. Otherwise the parameters after <c>message</c> are matched
  40395. in order.
  40396. If the place holder matches against a number it is printed as a
  40397. whole number. This can be overridden by specifying a precision
  40398. in the form %n.m where n is the padding for the whole part and
  40399. m is the number of decimal places to display. n can be excluded
  40400. if desired. n and m may not be more than 9.
  40401. If the last parameter (after flattening) is a Exception it is
  40402. Logged specially.
  40403. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40404. @param message The message to Log.
  40405. @param obj1 The first object to match against.
  40406. @param obj2 The second object to match against.
  40407. @param obj3 The third object to match against.
  40408. </member>
  40409. <member name="M:NPOI.Util.POILogger.LogFormatted(System.Int32,System.String,System.Object,System.Object,System.Object,System.Object)">
  40410. Logs a formated message. The message itself may contain %
  40411. characters as place holders. This routine will attempt to match
  40412. the placeholder by looking at the type of parameter passed to
  40413. obj1.
  40414. If the parameter is an array, it traverses the array first and
  40415. matches parameters sequentially against the array items.
  40416. Otherwise the parameters after <c>message</c> are matched
  40417. in order.
  40418. If the place holder matches against a number it is printed as a
  40419. whole number. This can be overridden by specifying a precision
  40420. in the form %n.m where n is the padding for the whole part and
  40421. m is the number of decimal places to display. n can be excluded
  40422. if desired. n and m may not be more than 9.
  40423. If the last parameter (after flattening) is a Exception it is
  40424. Logged specially.
  40425. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40426. @param message The message to Log.
  40427. @param obj1 The first object to match against.
  40428. @param obj2 The second object to match against.
  40429. @param obj3 The third object to match against.
  40430. @param obj4 The forth object to match against.
  40431. </member>
  40432. <member name="M:NPOI.Util.POILogger.FlattenArrays(System.Object[])">
  40433. Flattens any contained objects. Only tranverses one level deep.
  40434. </member>
  40435. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object)">
  40436. Log a message
  40437. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40438. @param obj1 The object to Log.
  40439. </member>
  40440. <member name="M:NPOI.Util.NullLogger.Check(System.Int32)">
  40441. Check if a Logger is enabled to Log at the specified level
  40442. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40443. </member>
  40444. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object)">
  40445. Log a message. Lazily appends Object parameters together.
  40446. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40447. @param obj1 first object to place in the message
  40448. @param obj2 second object to place in the message
  40449. </member>
  40450. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object)">
  40451. Log a message. Lazily appends Object parameters together.
  40452. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40453. @param obj1 first Object to place in the message
  40454. @param obj2 second Object to place in the message
  40455. @param obj3 third Object to place in the message
  40456. </member>
  40457. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object)">
  40458. Log a message. Lazily appends Object parameters together.
  40459. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40460. @param obj1 first Object to place in the message
  40461. @param obj2 second Object to place in the message
  40462. @param obj3 third Object to place in the message
  40463. @param obj4 fourth Object to place in the message
  40464. </member>
  40465. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object)">
  40466. Log a message. Lazily appends Object parameters together.
  40467. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40468. @param obj1 first Object to place in the message
  40469. @param obj2 second Object to place in the message
  40470. @param obj3 third Object to place in the message
  40471. @param obj4 fourth Object to place in the message
  40472. @param obj5 fifth Object to place in the message
  40473. </member>
  40474. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  40475. Log a message. Lazily appends Object parameters together.
  40476. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40477. @param obj1 first Object to place in the message
  40478. @param obj2 second Object to place in the message
  40479. @param obj3 third Object to place in the message
  40480. @param obj4 fourth Object to place in the message
  40481. @param obj5 fifth Object to place in the message
  40482. @param obj6 sixth Object to place in the message
  40483. </member>
  40484. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  40485. Log a message. Lazily appends Object parameters together.
  40486. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40487. @param obj1 first Object to place in the message
  40488. @param obj2 second Object to place in the message
  40489. @param obj3 third Object to place in the message
  40490. @param obj4 fourth Object to place in the message
  40491. @param obj5 fifth Object to place in the message
  40492. @param obj6 sixth Object to place in the message
  40493. @param obj7 seventh Object to place in the message
  40494. </member>
  40495. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  40496. Log a message. Lazily appends Object parameters together.
  40497. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40498. @param obj1 first Object to place in the message
  40499. @param obj2 second Object to place in the message
  40500. @param obj3 third Object to place in the message
  40501. @param obj4 fourth Object to place in the message
  40502. @param obj5 fifth Object to place in the message
  40503. @param obj6 sixth Object to place in the message
  40504. @param obj7 seventh Object to place in the message
  40505. @param obj8 eighth Object to place in the message
  40506. </member>
  40507. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Exception)">
  40508. Log a message
  40509. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40510. @param obj1 The object to Log. This is converted to a string.
  40511. @param exception An exception to be Logged
  40512. </member>
  40513. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Exception)">
  40514. Log a message. Lazily appends Object parameters together.
  40515. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40516. @param obj1 first Object to place in the message
  40517. @param obj2 second Object to place in the message
  40518. @param exception An exception to be Logged
  40519. </member>
  40520. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Exception)">
  40521. Log a message. Lazily appends Object parameters together.
  40522. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40523. @param obj1 first Object to place in the message
  40524. @param obj2 second Object to place in the message
  40525. @param obj3 third object to place in the message
  40526. @param exception An error message to be Logged
  40527. </member>
  40528. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  40529. Log a message. Lazily appends Object parameters together.
  40530. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40531. @param obj1 first Object to place in the message
  40532. @param obj2 second Object to place in the message
  40533. @param obj3 third object to place in the message
  40534. @param obj4 fourth object to place in the message
  40535. @param exception An exception to be Logged
  40536. </member>
  40537. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  40538. Log a message. Lazily appends Object parameters together.
  40539. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40540. @param obj1 first Object to place in the message
  40541. @param obj2 second Object to place in the message
  40542. @param obj3 third object to place in the message
  40543. @param obj4 fourth object to place in the message
  40544. @param obj5 fifth object to place in the message
  40545. @param exception An exception to be Logged
  40546. </member>
  40547. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  40548. Log a message. Lazily appends Object parameters together.
  40549. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40550. @param obj1 first Object to place in the message
  40551. @param obj2 second Object to place in the message
  40552. @param obj3 third object to place in the message
  40553. @param obj4 fourth object to place in the message
  40554. @param obj5 fifth object to place in the message
  40555. @param obj6 sixth object to place in the message
  40556. @param exception An exception to be Logged
  40557. </member>
  40558. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  40559. Log a message. Lazily appends Object parameters together.
  40560. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40561. @param obj1 first Object to place in the message
  40562. @param obj2 second Object to place in the message
  40563. @param obj3 third object to place in the message
  40564. @param obj4 fourth object to place in the message
  40565. @param obj5 fifth object to place in the message
  40566. @param obj6 sixth object to place in the message
  40567. @param obj7 seventh object to place in the message
  40568. @param exception An exception to be Logged
  40569. </member>
  40570. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  40571. Log a message. Lazily appends Object parameters together.
  40572. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40573. @param obj1 first Object to place in the message
  40574. @param obj2 second Object to place in the message
  40575. @param obj3 third object to place in the message
  40576. @param obj4 fourth object to place in the message
  40577. @param obj5 fifth object to place in the message
  40578. @param obj6 sixth object to place in the message
  40579. @param obj7 seventh object to place in the message
  40580. @param obj8 eighth object to place in the message
  40581. @param exception An exception to be Logged
  40582. </member>
  40583. <member name="M:NPOI.Util.NullLogger.LogFormatted(System.Int32,System.String,System.Object)">
  40584. Logs a formated message. The message itself may contain %
  40585. characters as place holders. This routine will attempt to match
  40586. the placeholder by looking at the type of parameter passed to
  40587. obj1.
  40588. If the parameter is an array, it traverses the array first and
  40589. matches parameters sequentially against the array items.
  40590. Otherwise the parameters after <c>message</c> are matched
  40591. in order.
  40592. If the place holder matches against a number it is printed as a
  40593. whole number. This can be overridden by specifying a precision
  40594. in the form %n.m where n is the padding for the whole part and
  40595. m is the number of decimal places to display. n can be excluded
  40596. if desired. n and m may not be more than 9.
  40597. If the last parameter (after flattening) is a Exception it is
  40598. Logged specially.
  40599. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40600. @param message The message to Log.
  40601. @param obj1 The first object to match against.
  40602. </member>
  40603. <member name="M:NPOI.Util.NullLogger.LogFormatted(System.Int32,System.String,System.Object,System.Object)">
  40604. Logs a formated message. The message itself may contain %
  40605. characters as place holders. This routine will attempt to match
  40606. the placeholder by looking at the type of parameter passed to
  40607. obj1.
  40608. If the parameter is an array, it traverses the array first and
  40609. matches parameters sequentially against the array items.
  40610. Otherwise the parameters after <c>message</c> are matched
  40611. in order.
  40612. If the place holder matches against a number it is printed as a
  40613. whole number. This can be overridden by specifying a precision
  40614. in the form %n.m where n is the padding for the whole part and
  40615. m is the number of decimal places to display. n can be excluded
  40616. if desired. n and m may not be more than 9.
  40617. If the last parameter (after flattening) is a Exception it is
  40618. Logged specially.
  40619. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40620. @param message The message to Log.
  40621. @param obj1 The first object to match against.
  40622. @param obj2 The second object to match against.
  40623. </member>
  40624. <member name="M:NPOI.Util.NullLogger.LogFormatted(System.Int32,System.String,System.Object,System.Object,System.Object)">
  40625. Logs a formated message. The message itself may contain %
  40626. characters as place holders. This routine will attempt to match
  40627. the placeholder by looking at the type of parameter passed to
  40628. obj1.
  40629. If the parameter is an array, it traverses the array first and
  40630. matches parameters sequentially against the array items.
  40631. Otherwise the parameters after <c>message</c> are matched
  40632. in order.
  40633. If the place holder matches against a number it is printed as a
  40634. whole number. This can be overridden by specifying a precision
  40635. in the form %n.m where n is the padding for the whole part and
  40636. m is the number of decimal places to display. n can be excluded
  40637. if desired. n and m may not be more than 9.
  40638. If the last parameter (after flattening) is a Exception it is
  40639. Logged specially.
  40640. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40641. @param message The message to Log.
  40642. @param obj1 The first object to match against.
  40643. @param obj2 The second object to match against.
  40644. @param obj3 The third object to match against.
  40645. </member>
  40646. <member name="M:NPOI.Util.NullLogger.LogFormatted(System.Int32,System.String,System.Object,System.Object,System.Object,System.Object)">
  40647. Logs a formated message. The message itself may contain %
  40648. characters as place holders. This routine will attempt to match
  40649. the placeholder by looking at the type of parameter passed to
  40650. obj1.
  40651. If the parameter is an array, it traverses the array first and
  40652. matches parameters sequentially against the array items.
  40653. Otherwise the parameters after <c>message</c> are matched
  40654. in order.
  40655. If the place holder matches against a number it is printed as a
  40656. whole number. This can be overridden by specifying a precision
  40657. in the form %n.m where n is the padding for the whole part and
  40658. m is the number of decimal places to display. n can be excluded
  40659. if desired. n and m may not be more than 9.
  40660. If the last parameter (after flattening) is a Exception it is
  40661. Logged specially.
  40662. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  40663. @param message The message to Log.
  40664. @param obj1 The first object to match against.
  40665. @param obj2 The second object to match against.
  40666. @param obj3 The third object to match against.
  40667. @param obj4 The forth object to match against.
  40668. </member>
  40669. <member name="F:NPOI.Util.PngUtils.PNG_FILE_HEADER">
  40670. File header for PNG format.
  40671. </member>
  40672. <member name="M:NPOI.Util.PngUtils.MatchesPngHeader(System.Byte[],System.Int32)">
  40673. Checks if the offset matches the PNG header.
  40674. @param data the data to check.
  40675. @param offset the offset to check at.
  40676. @return {@code true} if the offset matches.
  40677. </member>
  40678. <member name="F:NPOI.Util.POILogFactory._loggers">
  40679. Map of POILogger instances, with classes as keys
  40680. </member>
  40681. <member name="F:NPOI.Util.POILogFactory._nullLogger">
  40682. A common instance of NullLogger, as it does nothing
  40683. we only need the one
  40684. </member>
  40685. <member name="F:NPOI.Util.POILogFactory._loggerClassName">
  40686. The name of the class to use. Initialised the
  40687. first time we need it
  40688. </member>
  40689. <member name="M:NPOI.Util.POILogFactory.#ctor">
  40690. <summary>
  40691. Initializes a new instance of the <see cref="T:NPOI.Util.POILogFactory"/> class.
  40692. </summary>
  40693. </member>
  40694. <member name="M:NPOI.Util.POILogFactory.GetLogger(System.Type)">
  40695. <summary>
  40696. Get a logger, based on a class name
  40697. </summary>
  40698. <param name="type">the class whose name defines the log</param>
  40699. <returns>a POILogger for the specified class</returns>
  40700. </member>
  40701. <member name="M:NPOI.Util.POILogFactory.GetLogger(System.String)">
  40702. <summary>
  40703. Get a logger, based on a String
  40704. </summary>
  40705. <param name="cat">the String that defines the log</param>
  40706. <returns>a POILogger for the specified class</returns>
  40707. </member>
  40708. <member name="M:NPOI.Util.PushbackStream.ReadByte">
  40709. <summary>
  40710. Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.
  40711. </summary>
  40712. <returns>
  40713. The unsigned byte cast to an Int32, or -1 if at the end of the stream.
  40714. </returns>
  40715. <exception cref="T:System.NotSupportedException">
  40716. The stream does not support reading.
  40717. </exception>
  40718. <exception cref="T:System.ObjectDisposedException">
  40719. Methods were called after the stream was closed.
  40720. </exception>
  40721. </member>
  40722. <member name="M:NPOI.Util.PushbackStream.Read(System.Byte[],System.Int32,System.Int32)">
  40723. <summary>
  40724. When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
  40725. </summary>
  40726. <param name="buffer">An array of bytes. When this method returns, the buffer contains the specified byte array with the values between <paramref name="offset"/> and (<paramref name="offset"/> + <paramref name="count"/> - 1) replaced by the bytes read from the current source.</param>
  40727. <param name="offset">The zero-based byte offset in <paramref name="buffer"/> at which to begin storing the data read from the current stream.</param>
  40728. <param name="count">The maximum number of bytes to be read from the current stream.</param>
  40729. <returns>
  40730. The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.
  40731. </returns>
  40732. <exception cref="T:System.ArgumentException">
  40733. The sum of <paramref name="offset"/> and <paramref name="count"/> is larger than the buffer length.
  40734. </exception>
  40735. <exception cref="T:System.ArgumentNullException">
  40736. <paramref name="buffer"/> is null.
  40737. </exception>
  40738. <exception cref="T:System.ArgumentOutOfRangeException">
  40739. <paramref name="offset"/> or <paramref name="count"/> is negative.
  40740. </exception>
  40741. <exception cref="T:System.IO.IOException">
  40742. An I/O error occurs.
  40743. </exception>
  40744. <exception cref="T:System.NotSupportedException">
  40745. The stream does not support reading.
  40746. </exception>
  40747. <exception cref="T:System.ObjectDisposedException">
  40748. Methods were called after the stream was closed.
  40749. </exception>
  40750. </member>
  40751. <member name="M:NPOI.Util.PushbackStream.Unread(System.Int32)">
  40752. <summary>
  40753. Unreads the specified b.
  40754. </summary>
  40755. <param name="b">The b.</param>
  40756. </member>
  40757. <member name="M:NPOI.Util.PushbackStream.Close">
  40758. <summary>
  40759. Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.
  40760. </summary>
  40761. </member>
  40762. <member name="M:NPOI.Util.PushbackStream.Flush">
  40763. <summary>
  40764. When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
  40765. </summary>
  40766. <exception cref="T:System.IO.IOException">
  40767. An I/O error occurs.
  40768. </exception>
  40769. </member>
  40770. <member name="M:NPOI.Util.PushbackStream.Seek(System.Int64,System.IO.SeekOrigin)">
  40771. <summary>
  40772. When overridden in a derived class, sets the position within the current stream.
  40773. </summary>
  40774. <param name="offset">A byte offset relative to the <paramref name="origin"/> parameter.</param>
  40775. <param name="origin">A value of type <see cref="T:System.IO.SeekOrigin"/> indicating the reference point used to obtain the new position.</param>
  40776. <returns>
  40777. The new position within the current stream.
  40778. </returns>
  40779. <exception cref="T:System.IO.IOException">
  40780. An I/O error occurs.
  40781. </exception>
  40782. <exception cref="T:System.NotSupportedException">
  40783. The stream does not support seeking, such as if the stream is constructed from a pipe or console output.
  40784. </exception>
  40785. <exception cref="T:System.ObjectDisposedException">
  40786. Methods were called after the stream was closed.
  40787. </exception>
  40788. </member>
  40789. <member name="M:NPOI.Util.PushbackStream.SetLength(System.Int64)">
  40790. <summary>
  40791. When overridden in a derived class, sets the length of the current stream.
  40792. </summary>
  40793. <param name="value">The desired length of the current stream in bytes.</param>
  40794. <exception cref="T:System.IO.IOException">
  40795. An I/O error occurs.
  40796. </exception>
  40797. <exception cref="T:System.NotSupportedException">
  40798. The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output.
  40799. </exception>
  40800. <exception cref="T:System.ObjectDisposedException">
  40801. Methods were called after the stream was closed.
  40802. </exception>
  40803. </member>
  40804. <member name="M:NPOI.Util.PushbackStream.Write(System.Byte[],System.Int32,System.Int32)">
  40805. <summary>
  40806. When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
  40807. </summary>
  40808. <param name="buffer">An array of bytes. This method copies <paramref name="count"/> bytes from <paramref name="buffer"/> to the current stream.</param>
  40809. <param name="offset">The zero-based byte offset in <paramref name="buffer"/> at which to begin copying bytes to the current stream.</param>
  40810. <param name="count">The number of bytes to be written to the current stream.</param>
  40811. <exception cref="T:System.ArgumentException">
  40812. The sum of <paramref name="offset"/> and <paramref name="count"/> is greater than the buffer length.
  40813. </exception>
  40814. <exception cref="T:System.ArgumentNullException">
  40815. <paramref name="buffer"/> is null.
  40816. </exception>
  40817. <exception cref="T:System.ArgumentOutOfRangeException">
  40818. <paramref name="offset"/> or <paramref name="count"/> is negative.
  40819. </exception>
  40820. <exception cref="T:System.IO.IOException">
  40821. An I/O error occurs.
  40822. </exception>
  40823. <exception cref="T:System.NotSupportedException">
  40824. The stream does not support writing.
  40825. </exception>
  40826. <exception cref="T:System.ObjectDisposedException">
  40827. Methods were called after the stream was closed.
  40828. </exception>
  40829. </member>
  40830. <member name="M:NPOI.Util.PushbackStream.WriteByte(System.Byte)">
  40831. <summary>
  40832. Writes a byte to the current position in the stream and advances the position within the stream by one byte.
  40833. </summary>
  40834. <param name="value">The byte to write to the stream.</param>
  40835. <exception cref="T:System.IO.IOException">
  40836. An I/O error occurs.
  40837. </exception>
  40838. <exception cref="T:System.NotSupportedException">
  40839. The stream does not support writing, or the stream is already closed.
  40840. </exception>
  40841. <exception cref="T:System.ObjectDisposedException">
  40842. Methods were called after the stream was closed.
  40843. </exception>
  40844. </member>
  40845. <member name="P:NPOI.Util.PushbackStream.CanRead">
  40846. <summary>
  40847. When overridden in a derived class, gets a value indicating whether the current stream supports reading.
  40848. </summary>
  40849. <value></value>
  40850. <returns>true if the stream supports reading; otherwise, false.
  40851. </returns>
  40852. </member>
  40853. <member name="P:NPOI.Util.PushbackStream.CanSeek">
  40854. <summary>
  40855. When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
  40856. </summary>
  40857. <value></value>
  40858. <returns>true if the stream supports seeking; otherwise, false.
  40859. </returns>
  40860. </member>
  40861. <member name="P:NPOI.Util.PushbackStream.CanWrite">
  40862. <summary>
  40863. When overridden in a derived class, gets a value indicating whether the current stream supports writing.
  40864. </summary>
  40865. <value></value>
  40866. <returns>true if the stream supports writing; otherwise, false.
  40867. </returns>
  40868. </member>
  40869. <member name="P:NPOI.Util.PushbackStream.Length">
  40870. <summary>
  40871. When overridden in a derived class, gets the length in bytes of the stream.
  40872. </summary>
  40873. <value></value>
  40874. <returns>
  40875. A long value representing the length of the stream in bytes.
  40876. </returns>
  40877. <exception cref="T:System.NotSupportedException">
  40878. A class derived from Stream does not support seeking.
  40879. </exception>
  40880. <exception cref="T:System.ObjectDisposedException">
  40881. Methods were called after the stream was closed.
  40882. </exception>
  40883. </member>
  40884. <member name="P:NPOI.Util.PushbackStream.Position">
  40885. <summary>
  40886. When overridden in a derived class, gets or sets the position within the current stream.
  40887. </summary>
  40888. <value></value>
  40889. <returns>
  40890. The current position within the stream.
  40891. </returns>
  40892. <exception cref="T:System.IO.IOException">
  40893. An I/O error occurs.
  40894. </exception>
  40895. <exception cref="T:System.NotSupportedException">
  40896. The stream does not support seeking.
  40897. </exception>
  40898. <exception cref="T:System.ObjectDisposedException">
  40899. Methods were called after the stream was closed.
  40900. </exception>
  40901. </member>
  40902. <member name="M:NPOI.Util.ShortField.#ctor(System.Int32)">
  40903. <summary>
  40904. construct the ShortField with its offset into its containing
  40905. byte array
  40906. </summary>
  40907. <param name="offset">offset of the field within its byte array</param>
  40908. <exception cref="T:System.IndexOutOfRangeException">if offset is negative</exception>
  40909. </member>
  40910. <member name="M:NPOI.Util.ShortField.#ctor(System.Int32,System.Int16)">
  40911. <summary>
  40912. construct the ShortField with its offset into its containing byte array and initialize its value
  40913. </summary>
  40914. <param name="offset">offset of the field within its byte array</param>
  40915. <param name="value">the initial value</param>
  40916. <exception cref="T:System.IndexOutOfRangeException">if offset is negative</exception>
  40917. </member>
  40918. <member name="M:NPOI.Util.ShortField.#ctor(System.Int32,System.Byte[])">
  40919. <summary>
  40920. Construct the ShortField with its offset into its containing
  40921. byte array and initialize its value from its byte array
  40922. </summary>
  40923. <param name="offset">offset of the field within its byte array</param>
  40924. <param name="data">the byte array to read the value from</param>
  40925. <exception cref="T:System.IndexOutOfRangeException">if the offset is not
  40926. within the range of 0..(data.length - 1)</exception>
  40927. </member>
  40928. <member name="M:NPOI.Util.ShortField.#ctor(System.Int32,System.Int16,System.Byte[]@)">
  40929. <summary>
  40930. construct the ShortField with its offset into its containing
  40931. byte array, initialize its value, and write its value to its
  40932. byte array
  40933. </summary>
  40934. <param name="offset">offset of the field within its byte array</param>
  40935. <param name="value">the initial value</param>
  40936. <param name="data">the byte array to write the value to</param>
  40937. <exception cref="T:System.IndexOutOfRangeException">if offset is negative</exception>
  40938. </member>
  40939. <member name="M:NPOI.Util.ShortField.Set(System.Int16,System.Byte[]@)">
  40940. <summary>
  40941. set the ShortField's current value and write it to a byte array
  40942. </summary>
  40943. <param name="value">value to be set</param>
  40944. <param name="data">the byte array to write the value to</param>
  40945. <exception cref="T:System.IndexOutOfRangeException">if the offset is out
  40946. of range</exception>
  40947. </member>
  40948. <member name="M:NPOI.Util.ShortField.ReadFromBytes(System.Byte[])">
  40949. <summary>
  40950. set the value from its offset into an array of bytes
  40951. </summary>
  40952. <param name="data">the byte array from which the value is to be read</param>
  40953. <exception cref="T:System.IndexOutOfRangeException">if the offset is out
  40954. of range</exception>
  40955. </member>
  40956. <member name="M:NPOI.Util.ShortField.ReadFromStream(System.IO.Stream)">
  40957. <summary>
  40958. set the value from an Stream
  40959. </summary>
  40960. <param name="stream">the Stream from which the value is to be
  40961. read</param>
  40962. <exception cref="T:System.IO.IOException">if an IOException is thrown from reading
  40963. the Stream</exception>
  40964. <exception cref="T:NPOI.Util.BufferUnderrunException">if there is not enough data
  40965. available from the Stream</exception>
  40966. </member>
  40967. <member name="M:NPOI.Util.ShortField.WriteToBytes(System.Byte[])">
  40968. <summary>
  40969. write the value out to an array of bytes at the appropriate
  40970. offset
  40971. </summary>
  40972. <param name="data">the array of bytes to which the value is to be
  40973. written</param>
  40974. <exception cref="T:System.IndexOutOfRangeException">if the offset is out
  40975. of range</exception>
  40976. </member>
  40977. <member name="M:NPOI.Util.ShortField.Write(System.Int32,System.Int16,System.Byte[]@)">
  40978. <summary>
  40979. Same as using the constructor <see cref="T:NPOI.Util.ShortField"/> with the same
  40980. parameter list. Avoid creation of an useless object.
  40981. </summary>
  40982. <param name="offset">offset of the field within its byte array</param>
  40983. <param name="value">the initial value</param>
  40984. <param name="data">the byte array to write the value to</param>
  40985. </member>
  40986. <member name="M:NPOI.Util.ShortField.ToString">
  40987. <summary>
  40988. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  40989. </summary>
  40990. <returns>
  40991. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  40992. </returns>
  40993. </member>
  40994. <member name="P:NPOI.Util.ShortField.Value">
  40995. <summary>
  40996. Gets or sets the value.
  40997. </summary>
  40998. <value>The value.</value>
  40999. </member>
  41000. <member name="T:NPOI.Util.ShortList">
  41001. <summary>
  41002. A List of short's; as full an implementation of the java.Util.List
  41003. interface as possible, with an eye toward minimal creation of
  41004. objects
  41005. the mimicry of List is as follows:
  41006. <ul>
  41007. <li> if possible, operations designated 'optional' in the List
  41008. interface are attempted</li>
  41009. <li> wherever the List interface refers to an Object, substitute
  41010. short</li>
  41011. <li> wherever the List interface refers to a Collection or List,
  41012. substitute shortList</li>
  41013. </ul>
  41014. the mimicry is not perfect, however:
  41015. <ul>
  41016. <li> operations involving Iterators or ListIterators are not
  41017. supported</li>
  41018. <li> Remove(Object) becomes RemoveValue to distinguish it from
  41019. Remove(short index)</li>
  41020. <li> subList is not supported</li>
  41021. </ul>
  41022. </summary>
  41023. </member>
  41024. <member name="M:NPOI.Util.ShortList.#ctor">
  41025. <summary>
  41026. create an shortList of default size
  41027. </summary>
  41028. </member>
  41029. <member name="M:NPOI.Util.ShortList.#ctor(NPOI.Util.ShortList)">
  41030. <summary>
  41031. create a copy of an existing shortList
  41032. </summary>
  41033. <param name="list">the existing shortList</param>
  41034. </member>
  41035. <member name="M:NPOI.Util.ShortList.#ctor(System.Int32)">
  41036. <summary>
  41037. create an shortList with a predefined Initial size
  41038. </summary>
  41039. <param name="InitialCapacity">the size for the internal array</param>
  41040. </member>
  41041. <member name="M:NPOI.Util.ShortList.Add(System.Int32,System.Int16)">
  41042. <summary>
  41043. add the specfied value at the specified index
  41044. </summary>
  41045. <param name="index">the index where the new value is to be Added</param>
  41046. <param name="value">the new value</param>
  41047. </member>
  41048. <member name="M:NPOI.Util.ShortList.Add(System.Int16)">
  41049. <summary>
  41050. Appends the specified element to the end of this list
  41051. </summary>
  41052. <param name="value">element to be Appended to this list.</param>
  41053. <returns>return true (as per the general contract of the Collection.add method).</returns>
  41054. </member>
  41055. <member name="M:NPOI.Util.ShortList.AddAll(NPOI.Util.ShortList)">
  41056. <summary>
  41057. Appends all of the elements in the specified collection to the
  41058. end of this list, in the order that they are returned by the
  41059. specified collection's iterator. The behavior of this
  41060. operation is unspecified if the specified collection is
  41061. modified while the operation is in progress. (Note that this
  41062. will occur if the specified collection is this list, and it's
  41063. nonempty.)
  41064. </summary>
  41065. <param name="c">collection whose elements are to be Added to this list.</param>
  41066. <returns>return true if this list Changed as a result of the call.</returns>
  41067. </member>
  41068. <member name="M:NPOI.Util.ShortList.AddAll(System.Int32,NPOI.Util.ShortList)">
  41069. <summary>
  41070. Inserts all of the elements in the specified collection into
  41071. this list at the specified position. Shifts the element
  41072. currently at that position (if any) and any subsequent elements
  41073. to the right (increases their indices). The new elements will
  41074. appear in this list in the order that they are returned by the
  41075. specified collection's iterator. The behavior of this
  41076. operation is unspecified if the specified collection is
  41077. modified while the operation is in progress. (Note that this
  41078. will occur if the specified collection is this list, and it's
  41079. nonempty.)
  41080. </summary>
  41081. <param name="index">index at which to insert first element from the specified collection.</param>
  41082. <param name="c">elements to be inserted into this list.</param>
  41083. <returns>return true if this list Changed as a result of the call.</returns>
  41084. <exception cref="T:System.IndexOutOfRangeException"> if the index is out of range (index &lt; 0 || index &gt; size())</exception>
  41085. </member>
  41086. <member name="M:NPOI.Util.ShortList.Clear">
  41087. <summary>
  41088. Removes all of the elements from this list. This list will be
  41089. empty After this call returns (unless it throws an exception).
  41090. </summary>
  41091. </member>
  41092. <member name="M:NPOI.Util.ShortList.Contains(System.Int16)">
  41093. <summary>
  41094. Returns true if this list Contains the specified element. More
  41095. formally, returns true if and only if this list Contains at
  41096. least one element e such that o == e
  41097. </summary>
  41098. <param name="o">element whose presence in this list is to be Tested.</param>
  41099. <returns>return true if this list Contains the specified element.</returns>
  41100. </member>
  41101. <member name="M:NPOI.Util.ShortList.ContainsAll(NPOI.Util.ShortList)">
  41102. <summary>
  41103. Returns true if this list Contains all of the elements of the specified collection.
  41104. </summary>
  41105. <param name="c">collection to be Checked for Containment in this list.</param>
  41106. <returns>return true if this list Contains all of the elements of the specified collection.</returns>
  41107. </member>
  41108. <member name="M:NPOI.Util.ShortList.Equals(System.Object)">
  41109. <summary>
  41110. Compares the specified object with this list for Equality.
  41111. Returns true if and only if the specified object is also a
  41112. list, both lists have the same size, and all corresponding
  41113. pairs of elements in the two lists are Equal. (Two elements e1
  41114. and e2 are equal if e1 == e2.) In other words, two lists are
  41115. defined to be equal if they contain the same elements in the
  41116. same order. This defInition ensures that the Equals method
  41117. works properly across different implementations of the List
  41118. interface.
  41119. </summary>
  41120. <param name="o">the object to be Compared for Equality with this list.</param>
  41121. <returns>return true if the specified object is equal to this list.</returns>
  41122. </member>
  41123. <member name="M:NPOI.Util.ShortList.Get(System.Int32)">
  41124. <summary>
  41125. Returns the element at the specified position in this list.
  41126. </summary>
  41127. <param name="index">index of element to return.</param>
  41128. <returns>return the element at the specified position in this list.</returns>
  41129. </member>
  41130. <member name="M:NPOI.Util.ShortList.GetHashCode">
  41131. <summary>
  41132. Returns the hash code value for this list. The hash code of a
  41133. list is defined to be the result of the following calculation:
  41134. <code>
  41135. hashCode = 1;
  41136. Iterator i = list.Iterator();
  41137. while (i.HasNext()) {
  41138. Object obj = i.Next();
  41139. hashCode = 31*hashCode + (obj==null ? 0 : obj.HashCode());
  41140. }
  41141. </code>
  41142. This ensures that list1.Equals(list2) implies that
  41143. list1.HashCode()==list2.HashCode() for any two lists, list1 and
  41144. list2, as required by the general contract of Object.HashCode.
  41145. </summary>
  41146. <returns>return the hash code value for this list.</returns>
  41147. </member>
  41148. <member name="M:NPOI.Util.ShortList.IndexOf(System.Int16)">
  41149. <summary>
  41150. Returns the index in this list of the first occurrence of the
  41151. specified element, or -1 if this list does not contain this
  41152. element. More formally, returns the lowest index i such that
  41153. (o == Get(i)), or -1 if there is no such index.
  41154. </summary>
  41155. <param name="o">element to search for.</param>
  41156. <returns>the index in this list of the first occurrence of the
  41157. specified element, or -1 if this list does not contain
  41158. this element.
  41159. </returns>
  41160. </member>
  41161. <member name="M:NPOI.Util.ShortList.IsEmpty">
  41162. <summary>
  41163. Returns true if this list Contains no elements.
  41164. </summary>
  41165. <returns>return true if this list Contains no elements.</returns>
  41166. </member>
  41167. <member name="M:NPOI.Util.ShortList.LastIndexOf(System.Int16)">
  41168. <summary>
  41169. Returns the index in this list of the last occurrence of the
  41170. specified element, or -1 if this list does not contain this
  41171. element. More formally, returns the highest index i such that
  41172. (o == Get(i)), or -1 if there is no such index.
  41173. </summary>
  41174. <param name="o">element to search for.</param>
  41175. <returns>return the index in this list of the last occurrence of the
  41176. specified element, or -1 if this list does not contain this element.</returns>
  41177. </member>
  41178. <member name="M:NPOI.Util.ShortList.Remove(System.Int32)">
  41179. <summary>
  41180. Removes the element at the specified position in this list.
  41181. Shifts any subsequent elements to the left (subtracts one from
  41182. their indices). Returns the element that was Removed from the
  41183. list.
  41184. </summary>
  41185. <param name="index">the index of the element to Removed.</param>
  41186. <returns>return the element previously at the specified position.</returns>
  41187. </member>
  41188. <member name="M:NPOI.Util.ShortList.RemoveValue(System.Int16)">
  41189. <summary>
  41190. Removes the first occurrence in this list of the specified
  41191. element (optional operation). If this list does not contain
  41192. the element, it is unChanged. More formally, Removes the
  41193. element with the lowest index i such that (o.Equals(get(i)))
  41194. (if such an element exists).
  41195. </summary>
  41196. <param name="o">element to be Removed from this list, if present.</param>
  41197. <returns>return true if this list Contained the specified element.</returns>
  41198. </member>
  41199. <member name="M:NPOI.Util.ShortList.RemoveAll(NPOI.Util.ShortList)">
  41200. <summary>
  41201. Removes from this list all the elements that are Contained in the specified collection
  41202. </summary>
  41203. <param name="c">collection that defines which elements will be removed from this list.</param>
  41204. <returns>return true if this list Changed as a result of the call.</returns>
  41205. </member>
  41206. <member name="M:NPOI.Util.ShortList.RetainAll(NPOI.Util.ShortList)">
  41207. <summary>
  41208. Retains only the elements in this list that are Contained in
  41209. the specified collection. In other words, Removes from this
  41210. list all the elements that are not Contained in the specified
  41211. collection.
  41212. </summary>
  41213. <param name="c">collection that defines which elements this Set will retain.</param>
  41214. <returns>return true if this list Changed as a result of the call.</returns>
  41215. </member>
  41216. <member name="M:NPOI.Util.ShortList.Set(System.Int32,System.Int16)">
  41217. <summary>
  41218. Replaces the element at the specified position in this list with the specified element
  41219. </summary>
  41220. <param name="index">index of element to Replace.</param>
  41221. <param name="element">element to be stored at the specified position.</param>
  41222. <returns>return the element previously at the specified position.</returns>
  41223. </member>
  41224. <member name="M:NPOI.Util.ShortList.Size">
  41225. <summary>
  41226. Returns the number of elements in this list. If this list
  41227. Contains more than Int32.MaxValue elements, returns
  41228. Int32.MaxValue.
  41229. </summary>
  41230. <returns>return the number of elements in this shortList</returns>
  41231. </member>
  41232. <member name="M:NPOI.Util.ShortList.ToArray">
  41233. <summary>
  41234. Returns an array Containing all of the elements in this list in
  41235. proper sequence. Obeys the general contract of the
  41236. Collection.ToArray method.
  41237. </summary>
  41238. <returns>an array Containing all of the elements in this list in
  41239. proper sequence.</returns>
  41240. </member>
  41241. <member name="M:NPOI.Util.ShortList.ToArray(System.Int16[])">
  41242. <summary>
  41243. Returns an array Containing all of the elements in this list in
  41244. proper sequence. Obeys the general contract of the
  41245. Collection.ToArray(Object[]) method.
  41246. </summary>
  41247. <param name="a">the array into which the elements of this list are to
  41248. be stored, if it is big enough; otherwise, a new array
  41249. is allocated for this purpose.</param>
  41250. <returns>return an array Containing the elements of this list.</returns>
  41251. </member>
  41252. <member name="P:NPOI.Util.ShortList.Count">
  41253. <summary>
  41254. the number of elements in this shortList
  41255. </summary>
  41256. </member>
  41257. <member name="T:NPOI.Util.StringUtil">
  41258. <summary>
  41259. Title: String Utility Description: Collection of string handling utilities
  41260. @author Andrew C. Oliver
  41261. @author Sergei Kozello (sergeikozello at mail.ru)
  41262. @author Toshiaki Kamoshida (kamoshida.toshiaki at future dot co dot jp)
  41263. @since May 10, 2002
  41264. @version 1.0
  41265. </summary>
  41266. </member>
  41267. <member name="M:NPOI.Util.StringUtil.#ctor">
  41268. Constructor for the StringUtil object
  41269. </member>
  41270. <member name="M:NPOI.Util.StringUtil.GetFromUnicodeLE(System.Byte[],System.Int32,System.Int32)">
  41271. <summary>
  41272. Given a byte array of 16-bit unicode characters in Little Endian
  41273. Format (most important byte last), return a Java String representation
  41274. of it.
  41275. { 0x16, 0x00 } -0x16
  41276. </summary>
  41277. <param name="str">the byte array to be converted</param>
  41278. <param name="offset">the initial offset into the
  41279. byte array. it is assumed that string[ offset ] and string[ offset + 1 ] contain the first 16-bit unicode character</param>
  41280. <param name="len">the Length of the string</param>
  41281. <returns>the converted string</returns>
  41282. </member>
  41283. <member name="M:NPOI.Util.StringUtil.GetFromUnicodeLE(System.Byte[])">
  41284. <summary>
  41285. Given a byte array of 16-bit unicode characters in little endian
  41286. Format (most important byte last), return a Java String representation
  41287. of it.
  41288. { 0x16, 0x00 } -0x16
  41289. </summary>
  41290. <param name="str">the byte array to be converted</param>
  41291. <returns>the converted string</returns>
  41292. </member>
  41293. <member name="M:NPOI.Util.StringUtil.GetToUnicodeLE(System.String)">
  41294. Convert String to 16-bit unicode characters in little endian format
  41295. @param string the string
  41296. @return the byte array of 16-bit unicode characters
  41297. </member>
  41298. <member name="M:NPOI.Util.StringUtil.GetFromUnicodeBE(System.Byte[],System.Int32,System.Int32)">
  41299. <summary>
  41300. Given a byte array of 16-bit unicode characters in big endian
  41301. Format (most important byte first), return a Java String representation
  41302. of it.
  41303. { 0x00, 0x16 } -0x16
  41304. </summary>
  41305. <param name="str">the byte array to be converted</param>
  41306. <param name="offset">the initial offset into the
  41307. byte array. it is assumed that string[ offset ] and string[ offset + 1 ] contain the first 16-bit unicode character</param>
  41308. <param name="len">the Length of the string</param>
  41309. <returns> the converted string</returns>
  41310. </member>
  41311. <member name="M:NPOI.Util.StringUtil.GetFromUnicodeBE(System.Byte[])">
  41312. <summary>
  41313. Given a byte array of 16-bit unicode characters in big endian
  41314. Format (most important byte first), return a Java String representation
  41315. of it.
  41316. { 0x00, 0x16 } -0x16
  41317. </summary>
  41318. <param name="str">the byte array to be converted</param>
  41319. <returns>the converted string</returns>
  41320. </member>
  41321. <member name="M:NPOI.Util.StringUtil.GetFromCompressedUnicode(System.Byte[],System.Int32,System.Int32)">
  41322. <summary>
  41323. Read 8 bit data (in IsO-8859-1 codepage) into a (unicode) Java
  41324. String and return.
  41325. (In Excel terms, read compressed 8 bit unicode as a string)
  41326. </summary>
  41327. <param name="str">byte array to read</param>
  41328. <param name="offset">offset to read byte array</param>
  41329. <param name="len">Length to read byte array</param>
  41330. <returns>generated String instance by reading byte array</returns>
  41331. </member>
  41332. <member name="M:NPOI.Util.StringUtil.PutCompressedUnicode(System.String,System.Byte[],System.Int32)">
  41333. <summary>
  41334. Takes a unicode (java) string, and returns it as 8 bit data (in IsO-8859-1
  41335. codepage).
  41336. (In Excel terms, write compressed 8 bit unicode)
  41337. </summary>
  41338. <param name="input">the String containing the data to be written</param>
  41339. <param name="output">the byte array to which the data Is to be written</param>
  41340. <param name="offset">an offset into the byte arrat at which the data Is start when written</param>
  41341. </member>
  41342. <member name="M:NPOI.Util.StringUtil.PutUnicodeLE(System.String,System.Byte[],System.Int32)">
  41343. <summary>
  41344. Takes a unicode string, and returns it as little endian (most
  41345. important byte last) bytes in the supplied byte array.
  41346. (In Excel terms, write uncompressed unicode)
  41347. </summary>
  41348. <param name="input">the String containing the unicode data to be written</param>
  41349. <param name="output">the byte array to hold the uncompressed unicode, should be twice the Length of the String</param>
  41350. <param name="offset">the offset to start writing into the byte array</param>
  41351. </member>
  41352. <member name="M:NPOI.Util.StringUtil.PutUnicodeBE(System.String,System.Byte[],System.Int32)">
  41353. <summary>
  41354. Takes a unicode string, and returns it as big endian (most
  41355. important byte first) bytes in the supplied byte array.
  41356. (In Excel terms, write uncompressed unicode)
  41357. </summary>
  41358. <param name="input">the String containing the unicode data to be written</param>
  41359. <param name="output">the byte array to hold the uncompressed unicode, should be twice the Length of the String.</param>
  41360. <param name="offset">the offset to start writing into the byte array</param>
  41361. </member>
  41362. <member name="M:NPOI.Util.StringUtil.GetPreferredEncoding">
  41363. <summary>
  41364. Gets the preferred encoding.
  41365. </summary>
  41366. <returns>the encoding we want to use, currently hardcoded to IsO-8859-1</returns>
  41367. </member>
  41368. <member name="M:NPOI.Util.StringUtil.HasMultibyte(System.String)">
  41369. <summary>
  41370. check the parameter Has multibyte character
  41371. </summary>
  41372. <param name="value"> string to check</param>
  41373. <returns>
  41374. <c>true</c> if Has at least one multibyte character; otherwise, <c>false</c>.
  41375. </returns>
  41376. </member>
  41377. <member name="M:NPOI.Util.StringUtil.ReadUnicodeString(NPOI.Util.ILittleEndianInput)">
  41378. InputStream <c>in</c> is expected to contain:
  41379. <ol>
  41380. <li>ushort nChars</li>
  41381. <li>byte is16BitFlag</li>
  41382. <li>byte[]/char[] characterData</li>
  41383. </ol>
  41384. For this encoding, the is16BitFlag is always present even if nChars==0.
  41385. </member>
  41386. <member name="M:NPOI.Util.StringUtil.ReadUnicodeString(NPOI.Util.ILittleEndianInput,System.Int32)">
  41387. InputStream <c>in</c> is expected to contain:
  41388. <ol>
  41389. <li>byte is16BitFlag</li>
  41390. <li>byte[]/char[] characterData</li>
  41391. </ol>
  41392. For this encoding, the is16BitFlag is always present even if nChars==0.
  41393. <br/>
  41394. This method should be used when the nChars field is <em>not</em> stored
  41395. as a ushort immediately before the is16BitFlag. Otherwise, {@link
  41396. #readUnicodeString(LittleEndianInput)} can be used.
  41397. </member>
  41398. <member name="M:NPOI.Util.StringUtil.WriteUnicodeString(NPOI.Util.ILittleEndianOutput,System.String)">
  41399. OutputStream <c>out</c> will get:
  41400. <ol>
  41401. <li>ushort nChars</li>
  41402. <li>byte is16BitFlag</li>
  41403. <li>byte[]/char[] characterData</li>
  41404. </ol>
  41405. For this encoding, the is16BitFlag is always present even if nChars==0.
  41406. </member>
  41407. <member name="M:NPOI.Util.StringUtil.WriteUnicodeStringFlagAndData(NPOI.Util.ILittleEndianOutput,System.String)">
  41408. OutputStream <c>out</c> will get:
  41409. <ol>
  41410. <li>byte is16BitFlag</li>
  41411. <li>byte[]/char[] characterData</li>
  41412. </ol>
  41413. For this encoding, the is16BitFlag is always present even if nChars==0.
  41414. <br/>
  41415. This method should be used when the nChars field is <em>not</em> stored
  41416. as a ushort immediately before the is16BitFlag. Otherwise, {@link
  41417. #writeUnicodeString(LittleEndianOutput, String)} can be used.
  41418. </member>
  41419. <member name="M:NPOI.Util.StringUtil.GetEncodedSize(System.String)">
  41420. <summary>
  41421. Gets the number of bytes that would be written by WriteUnicodeString(LittleEndianOutput, String)
  41422. </summary>
  41423. <param name="value">The value.</param>
  41424. <returns></returns>
  41425. </member>
  41426. <member name="M:NPOI.Util.StringUtil.IsUnicodeString(System.String)">
  41427. <summary>
  41428. Checks to see if a given String needs to be represented as Unicode
  41429. </summary>
  41430. <param name="value">The value.</param>
  41431. <returns>
  41432. <c>true</c> if string needs Unicode to be represented.; otherwise, <c>false</c>.
  41433. </returns>
  41434. <remarks>Tony Qu change the logic</remarks>
  41435. </member>
  41436. <member name="M:NPOI.Util.StringUtil.ToHexString(System.String)">
  41437. <summary>
  41438. Encodes non-US-ASCII characters in a string, good for encoding file names for download
  41439. http://www.acriticsreview.com/List.aspx?listid=42
  41440. </summary>
  41441. <param name="s"></param>
  41442. <returns></returns>
  41443. </member>
  41444. <member name="M:NPOI.Util.StringUtil.ToHexString(System.Char)">
  41445. <summary>
  41446. Encodes a non-US-ASCII character.
  41447. </summary>
  41448. <param name="chr"></param>
  41449. <returns></returns>
  41450. </member>
  41451. <member name="M:NPOI.Util.StringUtil.ToHexString(System.Int16)">
  41452. <summary>
  41453. Encodes a non-US-ASCII character.
  41454. </summary>
  41455. <param name="chr"></param>
  41456. <returns></returns>
  41457. </member>
  41458. <member name="M:NPOI.Util.StringUtil.ToHexString(System.Int32)">
  41459. <summary>
  41460. Encodes a non-US-ASCII character.
  41461. </summary>
  41462. <param name="chr"></param>
  41463. <returns></returns>
  41464. </member>
  41465. <member name="M:NPOI.Util.StringUtil.ToHexString(System.Int64)">
  41466. <summary>
  41467. Encodes a non-US-ASCII character.
  41468. </summary>
  41469. <param name="chr"></param>
  41470. <returns></returns>
  41471. </member>
  41472. <member name="M:NPOI.Util.StringUtil.NeedToEncode(System.Char)">
  41473. <summary>
  41474. Determines if the character needs to be encoded.
  41475. http://www.acriticsreview.com/List.aspx?listid=42
  41476. </summary>
  41477. <param name="chr"></param>
  41478. <returns></returns>
  41479. </member>
  41480. <member name="M:NPOI.Util.StringUtil.mapMsCodepointString(System.String)">
  41481. Some strings may contain encoded characters of the unicode private use area.
  41482. Currently the characters of the symbol fonts are mapped to the corresponding
  41483. characters in the normal unicode range.
  41484. @param string the original string
  41485. @return the string with mapped characters
  41486. @see <a href="http://www.alanwood.net/unicode/private_use_area.html#symbol">Private Use Area (symbol)</a>
  41487. @see <a href="http://www.alanwood.net/demos/symbol.html">Symbol font - Unicode alternatives for Greek and special characters in HTML</a>
  41488. </member>
  41489. <member name="F:NPOI.Util.StringUtil.MIN_HIGH_SURROGATE">
  41490. The minimum value of a
  41491. <a href="http://www.unicode.org/glossary/#high_surrogate_code_unit">
  41492. Unicode high-surrogate code unit</a>
  41493. in the UTF-16 encoding, constant {@code '\u005CuD800'}.
  41494. A high-surrogate is also known as a <i>leading-surrogate</i>.
  41495. @since 1.5
  41496. </member>
  41497. <member name="F:NPOI.Util.StringUtil.MAX_HIGH_SURROGATE">
  41498. The maximum value of a
  41499. <a href="http://www.unicode.org/glossary/#high_surrogate_code_unit">
  41500. Unicode high-surrogate code unit</a>
  41501. in the UTF-16 encoding, constant {@code '\u005CuDBFF'}.
  41502. A high-surrogate is also known as a <i>leading-surrogate</i>.
  41503. @since 1.5
  41504. </member>
  41505. <member name="F:NPOI.Util.StringUtil.MIN_LOW_SURROGATE">
  41506. The minimum value of a
  41507. <a href="http://www.unicode.org/glossary/#low_surrogate_code_unit">
  41508. Unicode low-surrogate code unit</a>
  41509. in the UTF-16 encoding, constant {@code '\u005CuDC00'}.
  41510. A low-surrogate is also known as a <i>trailing-surrogate</i>.
  41511. @since 1.5
  41512. </member>
  41513. <member name="F:NPOI.Util.StringUtil.MAX_LOW_SURROGATE">
  41514. The maximum value of a
  41515. <a href="http://www.unicode.org/glossary/#low_surrogate_code_unit">
  41516. Unicode low-surrogate code unit</a>
  41517. in the UTF-16 encoding, constant {@code '\u005CuDFFF'}.
  41518. A low-surrogate is also known as a <i>trailing-surrogate</i>.
  41519. @since 1.5
  41520. </member>
  41521. <member name="M:NPOI.Util.StringUtil.toCodePoint(System.Char,System.Char)">
  41522. Converts the specified surrogate pair to its supplementary code
  41523. point value. This method does not validate the specified
  41524. surrogate pair. The caller must validate it using {@link
  41525. #isSurrogatePair(char, char) isSurrogatePair} if necessary.
  41526. @param high the high-surrogate code unit
  41527. @param low the low-surrogate code unit
  41528. @return the supplementary code point composed from the
  41529. specified surrogate pair.
  41530. @since 1.5
  41531. </member>
  41532. <member name="M:NPOI.Util.StringUtil.CharCount(System.Int32)">
  41533. Determines the number of {@code char} values needed to
  41534. represent the specified character (Unicode code point). If the
  41535. specified character is equal to or greater than 0x10000, then
  41536. the method returns 2. Otherwise, the method returns 1.
  41537. This method doesn't validate the specified character to be a
  41538. valid Unicode code point. The caller must validate the
  41539. character value using {@link #isValidCodePoint(int) isValidCodePoint}
  41540. if necessary.
  41541. @param codePoint the character (Unicode code point) to be tested.
  41542. @return 2 if the character is a valid supplementary character; 1 otherwise.
  41543. @see Character#isSupplementaryCodePoint(int)
  41544. @since 1.5
  41545. </member>
  41546. <member name="T:NPOI.Util.SystemOutLogger">
  41547. <summary>
  41548. A logger class that strives to make it as easy as possible for
  41549. developers to write log calls, while simultaneously making those
  41550. calls as cheap as possible by performing lazy Evaluation of the log
  41551. message.
  41552. </summary>
  41553. <remarks>
  41554. @author Marc Johnson (mjohnson at apache dot org)
  41555. @author Glen Stampoultzis (glens at apache.org)
  41556. @author Nicola Ken Barozzi (nicolaken at apache.org)
  41557. </remarks>
  41558. </member>
  41559. <member name="M:NPOI.Util.SystemOutLogger.Log(System.Int32,System.Object)">
  41560. <summary>
  41561. Log a message
  41562. </summary>
  41563. <param name="level">One of DEBUG, INFO, WARN, ERROR, FATAL</param>
  41564. <param name="obj1">The object to log.</param>
  41565. </member>
  41566. <member name="M:NPOI.Util.SystemOutLogger.Log(System.Int32,System.Object,System.Exception)">
  41567. <summary>
  41568. Log a message
  41569. </summary>
  41570. <param name="level"> One of DEBUG, INFO, WARN, ERROR, FATAL</param>
  41571. <param name="obj1">The object to log. This is Converted to a string.</param>
  41572. <param name="exception">An exception to be logged</param>
  41573. </member>
  41574. <member name="M:NPOI.Util.SystemOutLogger.Check(System.Int32)">
  41575. <summary>
  41576. Check if a logger is enabled to log at the specified level
  41577. </summary>
  41578. <param name="level">One of DEBUG, INFO, WARN, ERROR, FATAL</param>
  41579. <returns></returns>
  41580. </member>
  41581. <member name="M:NPOI.Util.TempFile.CreateTempFile(System.String,System.String)">
  41582. Creates a temporary file. Files are collected into one directory and by default are
  41583. deleted on exit from the VM. Files can be kept by defining the system property
  41584. <c>poi.keep.tmp.files</c>.
  41585. Dont forget to close all files or it might not be possible to delete them.
  41586. </member>
  41587. <member name="T:NPOI.Util.ULongField">
  41588. <summary>
  41589. </summary>
  41590. </member>
  41591. <member name="M:NPOI.Util.ULongField.#ctor(System.Int32)">
  41592. <summary>
  41593. construct the <see cref="T:NPOI.Util.LongField"/> with its offset into its containing byte array
  41594. </summary>
  41595. <param name="offset">The offset.</param>
  41596. </member>
  41597. <member name="M:NPOI.Util.ULongField.#ctor(System.Int32,System.UInt64)">
  41598. <summary>
  41599. construct the LongField with its offset into its containing
  41600. byte array and initialize its value
  41601. </summary>
  41602. <param name="offset">offset of the field within its byte array</param>
  41603. <param name="value">the initial value</param>
  41604. </member>
  41605. <member name="M:NPOI.Util.ULongField.#ctor(System.Int32,System.Byte[])">
  41606. <summary>
  41607. Construct the <see cref="T:NPOI.Util.LongField"/> class with its offset into its containing
  41608. byte array and initialize its value from its byte array
  41609. </summary>
  41610. <param name="offset">The offset of the field within its byte array</param>
  41611. <param name="data">the byte array to read the value from</param>
  41612. </member>
  41613. <member name="M:NPOI.Util.ULongField.#ctor(System.Int32,System.UInt64,System.Byte[])">
  41614. <summary>
  41615. construct the <see cref="T:NPOI.Util.LongField"/> class with its offset into its containing
  41616. byte array, initialize its value, and write the value to a byte
  41617. array
  41618. </summary>
  41619. <param name="offset">offset of the field within its byte array</param>
  41620. <param name="value">the initial value</param>
  41621. <param name="data">the byte array to write the value to</param>
  41622. </member>
  41623. <member name="M:NPOI.Util.ULongField.Set(System.UInt64,System.Byte[])">
  41624. <summary>
  41625. set the LongField's current value and write it to a byte array
  41626. </summary>
  41627. <param name="value">value to be set</param>
  41628. <param name="data">the byte array to write the value to</param>
  41629. </member>
  41630. <member name="M:NPOI.Util.ULongField.ReadFromBytes(System.Byte[])">
  41631. <summary>
  41632. set the value from its offset into an array of bytes
  41633. </summary>
  41634. <param name="data">the byte array from which the value is to be read</param>
  41635. </member>
  41636. <member name="M:NPOI.Util.ULongField.ReadFromStream(System.IO.Stream)">
  41637. <summary>
  41638. set the value from an Stream
  41639. </summary>
  41640. <param name="stream">the Stream from which the value is to be</param>
  41641. </member>
  41642. <member name="M:NPOI.Util.ULongField.WriteToBytes(System.Byte[])">
  41643. <summary>
  41644. write the value out to an array of bytes at the appropriate offset
  41645. </summary>
  41646. <param name="data">the array of bytes to which the value is to be written</param>
  41647. </member>
  41648. <member name="M:NPOI.Util.ULongField.ToString">
  41649. <summary>
  41650. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  41651. </summary>
  41652. <returns>
  41653. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  41654. </returns>
  41655. </member>
  41656. <member name="P:NPOI.Util.ULongField.Value">
  41657. <summary>
  41658. Getg or sets the LongField's current value
  41659. </summary>
  41660. <value>The current value</value>
  41661. </member>
  41662. <member name="T:NPOI.SS.UserModel.FillPattern">
  41663. The enumeration value indicating the style of fill pattern being used for a cell format.
  41664. </member>
  41665. <member name="F:NPOI.SS.UserModel.FillPattern.NoFill">
  41666. No background
  41667. </member>
  41668. <member name="F:NPOI.SS.UserModel.FillPattern.SolidForeground">
  41669. Solidly Filled
  41670. </member>
  41671. <member name="F:NPOI.SS.UserModel.FillPattern.FineDots">
  41672. Small fine dots
  41673. </member>
  41674. <member name="F:NPOI.SS.UserModel.FillPattern.AltBars">
  41675. Wide dots
  41676. </member>
  41677. <member name="F:NPOI.SS.UserModel.FillPattern.SparseDots">
  41678. Sparse dots
  41679. </member>
  41680. <member name="F:NPOI.SS.UserModel.FillPattern.ThickHorizontalBands">
  41681. Thick horizontal bands
  41682. </member>
  41683. <member name="F:NPOI.SS.UserModel.FillPattern.ThickVerticalBands">
  41684. Thick vertical bands
  41685. </member>
  41686. <member name="F:NPOI.SS.UserModel.FillPattern.ThickBackwardDiagonals">
  41687. Thick backward facing diagonals
  41688. </member>
  41689. <member name="F:NPOI.SS.UserModel.FillPattern.ThickForwardDiagonals">
  41690. Thick forward facing diagonals
  41691. </member>
  41692. <member name="F:NPOI.SS.UserModel.FillPattern.BigSpots">
  41693. Large spots
  41694. </member>
  41695. <member name="F:NPOI.SS.UserModel.FillPattern.Bricks">
  41696. Brick-like layout
  41697. </member>
  41698. <member name="F:NPOI.SS.UserModel.FillPattern.ThinHorizontalBands">
  41699. Thin horizontal bands
  41700. </member>
  41701. <member name="F:NPOI.SS.UserModel.FillPattern.ThinVerticalBands">
  41702. Thin vertical bands
  41703. </member>
  41704. <member name="F:NPOI.SS.UserModel.FillPattern.ThinBackwardDiagonals">
  41705. Thin backward diagonal
  41706. </member>
  41707. <member name="F:NPOI.SS.UserModel.FillPattern.ThinForwardDiagonals">
  41708. Thin forward diagonal
  41709. </member>
  41710. <member name="F:NPOI.SS.UserModel.FillPattern.Squares">
  41711. Squares
  41712. </member>
  41713. <member name="F:NPOI.SS.UserModel.FillPattern.Diamonds">
  41714. Diamonds
  41715. </member>
  41716. <member name="F:NPOI.SS.UserModel.FillPattern.LessDots">
  41717. Less Dots
  41718. </member>
  41719. <member name="F:NPOI.SS.UserModel.FillPattern.LeastDots">
  41720. Least Dots
  41721. </member>
  41722. <member name="T:NPOI.Util.Units">
  41723. @author Yegor Kozlov
  41724. </member>
  41725. <member name="M:NPOI.Util.Units.FixedPointToDecimal(System.Int32)">
  41726. Converts a value of type FixedPoint to a decimal number
  41727. @param fixedPoint
  41728. @return decimal number
  41729. @see <a href="http://msdn.microsoft.com/en-us/library/dd910765(v=office.12).aspx">[MS-OSHARED] - 2.2.1.6 FixedPoint</a>
  41730. </member>
  41731. <member name="T:NPOI.WP.UserModel.ICharacterRun">
  41732. This class represents a run of text that share common properties.
  41733. </member>
  41734. <member name="P:NPOI.WP.UserModel.ICharacterRun.Text">
  41735. @return The text of the Run, including any tabs/spaces/etc
  41736. </member>
  41737. <member name="T:NPOI.WP.UserModel.IParagraph">
  41738. This class represents a paragraph, made up of one or more
  41739. Runs of text.
  41740. </member>
  41741. </members>
  41742. </doc>