宁虹看板
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.

8109 lines
407 KiB

  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>NPOI.OOXML</name>
  5. </assembly>
  6. <members>
  7. <member name="T:NPOI.POIXMLDocumentPart">
  8. Represents an entry of a OOXML namespace.
  9. <p>
  10. Each POIXMLDocumentPart keeps a reference to the underlying a {@link org.apache.poi.openxml4j.opc.PackagePart}.
  11. </p>
  12. @author Yegor Kozlov
  13. </member>
  14. <member name="F:NPOI.POIXMLDocumentPart.relationCounter">
  15. Counter that provides the amount of incoming relations from other parts
  16. to this part.
  17. </member>
  18. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage)">
  19. Construct POIXMLDocumentPart representing a "core document" namespace part.
  20. </member>
  21. <member name="M:NPOI.POIXMLDocumentPart.#ctor">
  22. Creates new POIXMLDocumentPart - called by client code to create new parts from scratch.
  23. @see #CreateRelationship(POIXMLRelation, POIXMLFactory, int, bool)
  24. </member>
  25. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  26. Creates an POIXMLDocumentPart representing the given namespace part and relationship.
  27. Called by {@link #read(POIXMLFactory, java.util.Map)} when Reading in an exisiting file.
  28. @param part - The namespace part that holds xml data represenring this sheet.
  29. @param rel - the relationship of the given namespace part
  30. @see #read(POIXMLFactory, java.util.Map)
  31. </member>
  32. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  33. Creates an POIXMLDocumentPart representing the given namespace part, relationship and parent
  34. Called by {@link #read(POIXMLFactory, java.util.Map)} when Reading in an exisiting file.
  35. @param parent - Parent part
  36. @param part - The namespace part that holds xml data represenring this sheet.
  37. @param rel - the relationship of the given namespace part
  38. @see #read(POIXMLFactory, java.util.Map)
  39. </member>
  40. <member name="M:NPOI.POIXMLDocumentPart.Rebase(NPOI.OpenXml4Net.OPC.OPCPackage)">
  41. When you open something like a theme, call this to
  42. re-base the XML Document onto the core child of the
  43. current core document
  44. </member>
  45. <member name="M:NPOI.POIXMLDocumentPart.GetPackagePart">
  46. Provides access to the underlying PackagePart
  47. @return the underlying PackagePart
  48. </member>
  49. <member name="M:NPOI.POIXMLDocumentPart.GetPackageRelationship">
  50. Provides access to the PackageRelationship that identifies this POIXMLDocumentPart
  51. @return the PackageRelationship that identifies this POIXMLDocumentPart
  52. </member>
  53. <member name="M:NPOI.POIXMLDocumentPart.GetRelations">
  54. Returns the list of child relations for this POIXMLDocumentPart
  55. @return child relations
  56. </member>
  57. <member name="M:NPOI.POIXMLDocumentPart.GetRelationById(System.String)">
  58. Returns the target {@link POIXMLDocumentPart}, where a
  59. {@link PackageRelationship} is set from the {@link PackagePart} of this
  60. {@link POIXMLDocumentPart} to the {@link PackagePart} of the target
  61. {@link POIXMLDocumentPart} with a {@link PackageRelationship#GetId()}
  62. matching the given parameter value.
  63. @param id
  64. The relation id to look for
  65. @return the target part of the relation, or null, if none exists
  66. </member>
  67. <member name="M:NPOI.POIXMLDocumentPart.GetRelationId(NPOI.POIXMLDocumentPart)">
  68. Returns the {@link PackageRelationship#GetId()} of the
  69. {@link PackageRelationship}, that sources from the {@link PackagePart} of
  70. this {@link POIXMLDocumentPart} to the {@link PackagePart} of the given
  71. parameter value.
  72. @param part
  73. The {@link POIXMLDocumentPart} for which the according
  74. relation-id shall be found.
  75. @return The value of the {@link PackageRelationship#GetId()} or null, if
  76. parts are not related.
  77. </member>
  78. <member name="M:NPOI.POIXMLDocumentPart.AddRelation(System.String,NPOI.POIXMLDocumentPart)">
  79. Add a new child POIXMLDocumentPart
  80. @param part the child to add
  81. </member>
  82. <member name="M:NPOI.POIXMLDocumentPart.RemoveRelation(NPOI.POIXMLDocumentPart)">
  83. Remove the relation to the specified part in this namespace and remove the
  84. part, if it is no longer needed.
  85. </member>
  86. <member name="M:NPOI.POIXMLDocumentPart.RemoveRelation(NPOI.POIXMLDocumentPart,System.Boolean)">
  87. Remove the relation to the specified part in this namespace and remove the
  88. part, if it is no longer needed and flag is set to true.
  89. @param part
  90. The related part, to which the relation shall be Removed.
  91. @param RemoveUnusedParts
  92. true, if the part shall be Removed from the namespace if not
  93. needed any longer.
  94. </member>
  95. <member name="M:NPOI.POIXMLDocumentPart.GetParent">
  96. Returns the parent POIXMLDocumentPart. All parts except root have not-null parent.
  97. @return the parent POIXMLDocumentPart or <code>null</code> for the root element.
  98. </member>
  99. <member name="M:NPOI.POIXMLDocumentPart.Commit">
  100. Save the content in the underlying namespace part.
  101. Default implementation is empty meaning that the namespace part is left unmodified.
  102. Sub-classes should override and add logic to marshal the "model" into Ooxml4J.
  103. For example, the code saving a generic XML entry may look as follows:
  104. <pre><code>
  105. protected void commit() {
  106. PackagePart part = GetPackagePart();
  107. Stream out = part.GetStream();
  108. XmlObject bean = GetXmlBean(); //the "model" which holds Changes in memory
  109. bean.save(out, DEFAULT_XML_OPTIONS);
  110. out.close();
  111. }
  112. </code></pre>
  113. </member>
  114. <member name="M:NPOI.POIXMLDocumentPart.OnSave(System.Collections.Generic.List{NPOI.OpenXml4Net.OPC.PackagePart})">
  115. Save Changes in the underlying OOXML namespace.
  116. Recursively fires {@link #commit()} for each namespace part
  117. @param alreadySaved context set Containing already visited nodes
  118. </member>
  119. <member name="M:NPOI.POIXMLDocumentPart.CreateRelationship(NPOI.POIXMLRelation,NPOI.POIXMLFactory)">
  120. Create a new child POIXMLDocumentPart
  121. @param descriptor the part descriptor
  122. @param factory the factory that will create an instance of the requested relation
  123. @return the Created child POIXMLDocumentPart
  124. </member>
  125. <member name="M:NPOI.POIXMLDocumentPart.CreateRelationship(NPOI.POIXMLRelation,NPOI.POIXMLFactory,System.Int32,System.Boolean)">
  126. Create a new child POIXMLDocumentPart
  127. @param descriptor the part descriptor
  128. @param factory the factory that will create an instance of the requested relation
  129. @param idx part number
  130. @param noRelation if true, then no relationship is Added.
  131. @return the Created child POIXMLDocumentPart
  132. </member>
  133. <member name="M:NPOI.POIXMLDocumentPart.Read(NPOI.POIXMLFactory,System.Collections.Generic.Dictionary{NPOI.OpenXml4Net.OPC.PackagePart,NPOI.POIXMLDocumentPart})">
  134. Iterate through the underlying PackagePart and create child POIXMLFactory instances
  135. using the specified factory
  136. @param factory the factory object that Creates POIXMLFactory instances
  137. @param context context map Containing already visited noted keyed by tarGetURI
  138. </member>
  139. <member name="M:NPOI.POIXMLDocumentPart.GetTargetPart(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  140. Get the PackagePart that is the target of a relationship.
  141. @param rel The relationship
  142. @return The target part
  143. @throws InvalidFormatException
  144. </member>
  145. <member name="M:NPOI.POIXMLDocumentPart.OnDocumentCreate">
  146. Fired when a new namespace part is Created
  147. </member>
  148. <member name="M:NPOI.POIXMLDocumentPart.OnDocumentRead">
  149. Fired when a namespace part is read
  150. </member>
  151. <member name="M:NPOI.POIXMLDocumentPart.onDocumentRemove">
  152. Fired when a namespace part is about to be Removed from the namespace
  153. </member>
  154. <member name="F:NPOI.POIXMLDocument.pkg">
  155. The OPC Package
  156. </member>
  157. <member name="F:NPOI.POIXMLDocument.properties">
  158. The properties of the OPC namespace, opened as needed
  159. </member>
  160. <member name="M:NPOI.POIXMLDocument.OpenPackage(System.String)">
  161. Wrapper to open a namespace, returning an IOException
  162. in the event of a problem.
  163. Works around shortcomings in java's this() constructor calls
  164. </member>
  165. <member name="M:NPOI.POIXMLDocument.GetRelatedByType(System.String)">
  166. Retrieves all the PackageParts which are defined as
  167. relationships of the base document with the
  168. specified content type.
  169. </member>
  170. <member name="M:NPOI.POIXMLDocument.HasOOXMLHeader(System.IO.Stream)">
  171. Checks that the supplied Stream (which MUST
  172. support mark and reSet, or be a PushbackStream)
  173. has a OOXML (zip) header at the start of it.
  174. If your Stream does not support mark / reSet,
  175. then wrap it in a PushBackStream, then be
  176. sure to always use that, and not the original!
  177. @param inp An Stream which supports either mark/reSet, or is a PushbackStream
  178. </member>
  179. <member name="M:NPOI.POIXMLDocument.GetProperties">
  180. Get the document properties. This gives you access to the
  181. core ooxml properties, and the extended ooxml properties.
  182. </member>
  183. <member name="M:NPOI.POIXMLDocument.GetAllEmbedds">
  184. Get the document's embedded files.
  185. </member>
  186. <member name="M:NPOI.POIXMLDocument.Write(System.IO.Stream)">
  187. Write out this document to an Outputstream.
  188. @param stream - the java Stream you wish to write the file to
  189. @exception IOException if anything can't be written.
  190. </member>
  191. <member name="T:NPOI.POIXMLFactory">
  192. Defines a factory API that enables sub-classes to create instances of <code>POIXMLDocumentPart</code>
  193. @author Yegor Kozlov
  194. </member>
  195. <member name="M:NPOI.POIXMLFactory.CreateDocumentPart(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackageRelationship,NPOI.OpenXml4Net.OPC.PackagePart)">
  196. Create a POIXMLDocumentPart from existing namespace part and relation. This method is called
  197. from {@link POIXMLDocument#load(POIXMLFactory)} when parsing a document
  198. @param parent parent part
  199. @param rel the namespace part relationship
  200. @param part the PackagePart representing the Created instance
  201. @return A new instance of a POIXMLDocumentPart.
  202. </member>
  203. <member name="M:NPOI.POIXMLFactory.CreateDocumentPart(NPOI.POIXMLRelation)">
  204. Create a new POIXMLDocumentPart using the supplied descriptor. This method is used when Adding new parts
  205. to a document, for example, when Adding a sheet to a workbook, slide to a presentation, etc.
  206. @param descriptor describes the object to create
  207. @return A new instance of a POIXMLDocumentPart.
  208. </member>
  209. <member name="T:NPOI.CoreProperties">
  210. The core document properties
  211. </member>
  212. <member name="T:NPOI.ExtendedProperties">
  213. Extended document properties
  214. </member>
  215. <member name="T:NPOI.CustomProperties">
  216. Custom document properties
  217. </member>
  218. <member name="F:NPOI.CustomProperties.FORMAT_ID">
  219. Each custom property element Contains an fmtid attribute
  220. with the same GUID value ({D5CDD505-2E9C-101B-9397-08002B2CF9AE}).
  221. </member>
  222. <member name="M:NPOI.CustomProperties.Add(System.String)">
  223. Add a new property
  224. @param name the property name
  225. @throws IllegalArgumentException if a property with this name already exists
  226. </member>
  227. <member name="M:NPOI.CustomProperties.AddProperty(System.String,System.String)">
  228. Add a new string property
  229. @throws IllegalArgumentException if a property with this name already exists
  230. </member>
  231. <member name="M:NPOI.CustomProperties.AddProperty(System.String,System.Double)">
  232. Add a new double property
  233. @throws IllegalArgumentException if a property with this name already exists
  234. </member>
  235. <member name="M:NPOI.CustomProperties.AddProperty(System.String,System.Int32)">
  236. Add a new integer property
  237. @throws IllegalArgumentException if a property with this name already exists
  238. </member>
  239. <member name="M:NPOI.CustomProperties.AddProperty(System.String,System.Boolean)">
  240. Add a new bool property
  241. @throws IllegalArgumentException if a property with this name already exists
  242. </member>
  243. <member name="M:NPOI.CustomProperties.NextPid">
  244. Generate next id that uniquely relates a custom property
  245. @return next property id starting with 2
  246. </member>
  247. <member name="M:NPOI.CustomProperties.Contains(System.String)">
  248. Check if a property with this name already exists in the collection of custom properties
  249. @param name the name to check
  250. @return whether a property with the given name exists in the custom properties
  251. </member>
  252. <member name="T:NPOI.POIXMLProperties">
  253. Wrapper around the two different kinds of OOXML properties
  254. a document can have
  255. </member>
  256. <member name="M:NPOI.POIXMLProperties.Commit">
  257. Commit Changes to the underlying OPC namespace
  258. </member>
  259. <member name="P:NPOI.POIXMLProperties.CoreProperties">
  260. Returns the core document properties
  261. </member>
  262. <member name="P:NPOI.POIXMLProperties.ExtendedProperties">
  263. Returns the extended document properties
  264. </member>
  265. <member name="P:NPOI.POIXMLProperties.CustomProperties">
  266. Returns the custom document properties
  267. </member>
  268. <member name="T:NPOI.POIXMLPropertiesTextExtractor">
  269. A {@link POITextExtractor} for returning the textual
  270. content of the OOXML file properties, eg author
  271. and title.
  272. </member>
  273. <member name="F:NPOI.POIXMLTextExtractor._document">
  274. The POIXMLDocument that's open
  275. </member>
  276. <member name="M:NPOI.POIXMLTextExtractor.#ctor(NPOI.POIXMLDocument)">
  277. Creates a new text extractor for the given document
  278. </member>
  279. <member name="M:NPOI.POIXMLTextExtractor.GetCoreProperties">
  280. Returns the core document properties
  281. </member>
  282. <member name="M:NPOI.POIXMLTextExtractor.GetExtendedProperties">
  283. Returns the extended document properties
  284. </member>
  285. <member name="M:NPOI.POIXMLTextExtractor.GetCustomProperties">
  286. Returns the custom document properties
  287. </member>
  288. <member name="P:NPOI.POIXMLTextExtractor.Document">
  289. Returns opened document
  290. </member>
  291. <member name="P:NPOI.POIXMLTextExtractor.Package">
  292. Returns the opened OPCPackage that Contains the document
  293. </member>
  294. <member name="P:NPOI.POIXMLTextExtractor.MetadataTextExtractor">
  295. Returns an OOXML properties text extractor for the
  296. document properties metadata, such as title and author.
  297. </member>
  298. <member name="M:NPOI.POIXMLPropertiesTextExtractor.#ctor(NPOI.POIXMLDocument)">
  299. Creates a new POIXMLPropertiesTextExtractor for the
  300. given open document.
  301. </member>
  302. <member name="M:NPOI.POIXMLPropertiesTextExtractor.#ctor(NPOI.POIXMLTextExtractor)">
  303. Creates a new POIXMLPropertiesTextExtractor, for the
  304. same file that another TextExtractor is already
  305. working on.
  306. </member>
  307. <member name="M:NPOI.POIXMLPropertiesTextExtractor.GetCorePropertiesText">
  308. Returns the core document properties, eg author
  309. </member>
  310. <member name="M:NPOI.POIXMLPropertiesTextExtractor.GetExtendedPropertiesText">
  311. Returns the extended document properties, eg
  312. application
  313. </member>
  314. <member name="M:NPOI.POIXMLPropertiesTextExtractor.GetCustomPropertiesText">
  315. Returns the custom document properties, if
  316. there are any
  317. </member>
  318. <member name="T:NPOI.POIXMLRelation">
  319. Represents a descriptor of a OOXML relation.
  320. @author Yegor Kozlov
  321. </member>
  322. <member name="F:NPOI.POIXMLRelation._type">
  323. Describes the content stored in a part.
  324. </member>
  325. <member name="F:NPOI.POIXMLRelation._relation">
  326. The kind of connection between a source part and a target part in a namespace.
  327. </member>
  328. <member name="F:NPOI.POIXMLRelation._defaultName">
  329. The path component of a pack URI.
  330. </member>
  331. <member name="F:NPOI.POIXMLRelation._cls">
  332. Defines what object is used to construct instances of this relationship
  333. </member>
  334. <member name="M:NPOI.POIXMLRelation.#ctor(System.String,System.String,System.String,System.Type)">
  335. Instantiates a POIXMLRelation.
  336. @param type content type
  337. @param rel relationship
  338. @param defaultName default item name
  339. @param cls defines what object is used to construct instances of this relationship
  340. </member>
  341. <member name="M:NPOI.POIXMLRelation.#ctor(System.String,System.String,System.String)">
  342. Instantiates a POIXMLRelation.
  343. @param type content type
  344. @param rel relationship
  345. @param defaultName default item name
  346. </member>
  347. <member name="M:NPOI.POIXMLRelation.GetFileName(System.Int32)">
  348. Returns the filename for the nth one of these,
  349. e.g. /xl/comments4.xml
  350. </member>
  351. <member name="P:NPOI.POIXMLRelation.ContentType">
  352. Return the content type. Content types define a media type, a subtype, and an
  353. optional set of parameters, as defined in RFC 2616.
  354. @return the content type
  355. </member>
  356. <member name="P:NPOI.POIXMLRelation.Relation">
  357. Return the relationship, the kind of connection between a source part and a target part in a namespace.
  358. Relationships make the connections between parts directly discoverable without looking at the content
  359. in the parts, and without altering the parts themselves.
  360. @return the relationship
  361. </member>
  362. <member name="P:NPOI.POIXMLRelation.DefaultFileName">
  363. Return the default part name. Part names are used to refer to a part in the context of a
  364. namespace, typically as part of a URI.
  365. @return the default part name
  366. </member>
  367. <member name="P:NPOI.POIXMLRelation.RelationClass">
  368. Return type of the obejct used to construct instances of this relationship
  369. @return the class of the object used to construct instances of this relation
  370. </member>
  371. <member name="M:NPOI.SS.Converter.ExcelToHtmlConverter.ProcessRow(NPOI.SS.Util.CellRangeAddress[][],NPOI.SS.UserModel.IRow,System.Xml.XmlElement)">
  372. @return maximum 1-base index of column that were rendered, zero if none
  373. </member>
  374. <member name="M:NPOI.SS.Converter.ExcelToHtmlConverter.ProcessColumnWidths(NPOI.SS.UserModel.ISheet,System.Int32,System.Xml.XmlElement)">
  375. Creates COLGROUP element with width specified for all columns. (Except
  376. first if <tt>{@link #isOutputRowNumbers()}==true</tt>)
  377. </member>
  378. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.OutputColumnHeaders">
  379. <summary>
  380. 是否输出列头
  381. </summary>
  382. </member>
  383. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.OutputHiddenColumns">
  384. <summary>
  385. 是否输出隐藏的列
  386. </summary>
  387. </member>
  388. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.OutputHiddenRows">
  389. <summary>
  390. 是否输出隐藏的行
  391. </summary>
  392. </member>
  393. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.OutputLeadingSpacesAsNonBreaking">
  394. <summary>
  395. 是否输出文本前的空格
  396. </summary>
  397. </member>
  398. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.OutputRowNumbers">
  399. <summary>
  400. 是否输出行号
  401. </summary>
  402. </member>
  403. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.UseDivsToSpan">
  404. <summary>
  405. 在跨列的单元格使用DIV标记
  406. </summary>
  407. </member>
  408. <member name="M:NPOI.SS.Converter.ExcelToHtmlUtils.BuildMergedRangesMap(NPOI.SS.UserModel.ISheet)">
  409. Creates a map (i.e. two-dimensional array) filled with ranges. Allow fast
  410. retrieving {@link CellRangeAddress} of any cell, if cell is contained in
  411. range.
  412. @see #getMergedRange(CellRangeAddress[][], int, int)
  413. </member>
  414. <member name="M:NPOI.SS.Converter.ExcelToHtmlUtils.GetColumnWidthInPx(System.Int32)">
  415. See <a href=
  416. "http://apache-poi.1045710.n5.nabble.com/Excel-Column-Width-Unit-Converter-pixels-excel-column-width-units-td2301481.html"
  417. >here</a> for Xio explanation and details
  418. </member>
  419. <member name="M:NPOI.SS.Converter.ExcelToHtmlUtils.GetMergedRange(NPOI.SS.Util.CellRangeAddress[][],System.Int32,System.Int32)">
  420. @param mergedRanges
  421. map of sheet merged ranges built with
  422. {@link #buildMergedRangesMap(HSSFSheet)}
  423. @return {@link CellRangeAddress} from map if cell with specified row and
  424. column numbers contained in found range, <tt>null</tt> otherwise
  425. </member>
  426. <member name="T:NPOI.SS.UserModel.IndexedColors">
  427. A deprecated indexing scheme for colours that is still required for some records, and for backwards
  428. compatibility with OLE2 formats.
  429. <p>
  430. Each element corresponds to a color index (zero-based). When using the default indexed color palette,
  431. the values are not written out, but instead are implied. When the color palette has been modified from default,
  432. then the entire color palette is used.
  433. </p>
  434. @author Yegor Kozlov
  435. </member>
  436. <member name="P:NPOI.SS.UserModel.IndexedColors.Index">
  437. Returns index of this color
  438. @return index of this color
  439. </member>
  440. <member name="F:NPOI.SS.UserModel.ImportOption.SheetContentOnly">
  441. <summary>
  442. Only Text and Formulas are imported. Pictures, Drawing, Styles etc. are all ignored.
  443. </summary>
  444. </member>
  445. <member name="F:NPOI.SS.UserModel.ImportOption.TextOnly">
  446. <summary>
  447. Only Text, Comments and Formulas are imported. Pictures, Drawing, Styles etc. are all ignored.
  448. </summary>
  449. </member>
  450. <member name="F:NPOI.SS.UserModel.ImportOption.All">
  451. <summary>
  452. Everything is imported - this is the same as NONE.
  453. </summary>
  454. </member>
  455. <member name="T:NPOI.SS.UserModel.WorkbookFactory">
  456. <summary>
  457. Factory for creating the appropriate kind of Workbook
  458. (be it HSSFWorkbook or XSSFWorkbook), from the given input
  459. </summary>
  460. </member>
  461. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  462. <summary>
  463. Creates an HSSFWorkbook from the given POIFSFileSystem
  464. </summary>
  465. </member>
  466. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  467. Creates an HSSFWorkbook from the given NPOIFSFileSystem
  468. </member>
  469. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(NPOI.OpenXml4Net.OPC.OPCPackage)">
  470. <summary>
  471. Creates an XSSFWorkbook from the given OOXML Package
  472. </summary>
  473. </member>
  474. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(System.IO.Stream)">
  475. <summary>
  476. Creates the appropriate HSSFWorkbook / XSSFWorkbook from
  477. the given InputStream. The Stream is wraped inside a PushbackInputStream.
  478. </summary>
  479. <param name="inputStream">Input Stream of .xls or .xlsx file</param>
  480. <returns>IWorkbook depending on the input HSSFWorkbook or XSSFWorkbook is returned.</returns>
  481. </member>
  482. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(System.String)">
  483. Creates the appropriate HSSFWorkbook / XSSFWorkbook from
  484. the given File, which must exist and be readable.
  485. </member>
  486. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(System.IO.Stream,NPOI.SS.UserModel.ImportOption)">
  487. <summary>
  488. Creates the appropriate HSSFWorkbook / XSSFWorkbook from
  489. the given InputStream. The Stream is wraped inside a PushbackInputStream.
  490. </summary>
  491. <param name="inputStream">Input Stream of .xls or .xlsx file</param>
  492. <param name="importOption">Customize the elements that are processed on the next import</param>
  493. <returns>IWorkbook depending on the input HSSFWorkbook or XSSFWorkbook is returned.</returns>
  494. </member>
  495. <member name="M:NPOI.SS.UserModel.WorkbookFactory.CreateFormulaEvaluator(NPOI.SS.UserModel.IWorkbook)">
  496. <summary>
  497. Creates a specific FormulaEvaluator for the given workbook.
  498. </summary>
  499. </member>
  500. <member name="M:NPOI.SS.UserModel.WorkbookFactory.SetImportOption(NPOI.SS.UserModel.ImportOption)">
  501. <summary>
  502. Sets the import option when opening the next workbook.
  503. Works only for XSSF. For HSSF workbooks this option is ignored.
  504. </summary>
  505. <param name="importOption">Customize the elements that are processed on the next import</param>
  506. </member>
  507. <member name="T:NPOI.Util.IdentifierManager">
  508. <summary>
  509. 24.08.2009 @author Stefan Stern
  510. </summary>
  511. </member>
  512. <member name="F:NPOI.Util.IdentifierManager.upperbound">
  513. </member>
  514. <member name="F:NPOI.Util.IdentifierManager.lowerbound">
  515. </member>
  516. <member name="F:NPOI.Util.IdentifierManager.segments">
  517. List of segments of available identifiers
  518. </member>
  519. <member name="M:NPOI.Util.IdentifierManager.#ctor(System.Int64,System.Int64)">
  520. @param lowerbound the lower limit of the id-range to manage. Must be greater than or equal to {@link #MIN_ID}.
  521. @param upperbound the upper limit of the id-range to manage. Must be less then or equal {@link #MAX_ID}.
  522. </member>
  523. <member name="M:NPOI.Util.IdentifierManager.ReserveNew">
  524. @return a new identifier.
  525. @throws IllegalStateException if no more identifiers are available, then an Exception is raised.
  526. </member>
  527. <member name="M:NPOI.Util.IdentifierManager.Release(System.Int64)">
  528. @param id
  529. the identifier to release. Must be greater than or equal to
  530. {@link #lowerbound} and must be less than or equal to {@link #upperbound}
  531. @return true, if the identifier was reserved and has been successfully
  532. released, false, if the identifier was not reserved.
  533. </member>
  534. <member name="M:NPOI.Util.IdentifierManager.VerifyIdentifiersLeft">
  535. </member>
  536. <member name="T:NPOI.Util.PackageHelper">
  537. Provides handy methods to work with OOXML namespaces
  538. @author Yegor Kozlov
  539. </member>
  540. <member name="M:NPOI.Util.PackageHelper.Clone(NPOI.OpenXml4Net.OPC.OPCPackage,System.String)">
  541. Clone the specified namespace.
  542. @param pkg the namespace to clone
  543. @param file the destination file
  544. @return the Cloned namespace
  545. </member>
  546. <member name="M:NPOI.Util.PackageHelper.CreateTempFile">
  547. Creates an empty file in the default temporary-file directory,
  548. </member>
  549. <member name="M:NPOI.Util.PackageHelper.Copy(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePart)">
  550. Recursively copy namespace parts to the destination namespace
  551. </member>
  552. <member name="M:NPOI.Util.PackageHelper.CopyProperties(NPOI.OpenXml4Net.OPC.PackageProperties,NPOI.OpenXml4Net.OPC.PackageProperties)">
  553. Copy core namespace properties
  554. @param src source properties
  555. @param tgt target properties
  556. </member>
  557. <member name="T:NPOI.Util.Units">
  558. @author Yegor Kozlov
  559. </member>
  560. <member name="T:NPOI.XSSF.Extractor.XSSFExcelExtractor">
  561. Helper class to extract text from an OOXML Excel file
  562. </member>
  563. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetIncludeSheetNames(System.Boolean)">
  564. Should sheet names be included? Default is true
  565. </member>
  566. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetFormulasNotResults(System.Boolean)">
  567. Should we return the formula itself, and not
  568. the result it produces? Default is false
  569. </member>
  570. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetIncludeCellComments(System.Boolean)">
  571. Should cell comments be included? Default is true
  572. </member>
  573. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetIncludeHeadersFooters(System.Boolean)">
  574. Should headers and footers be included? Default is true
  575. </member>
  576. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.IncludeHeaderFooter">
  577. <summary>
  578. Should header and footer be included? Default is true
  579. </summary>
  580. </member>
  581. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.IncludeSheetNames">
  582. <summary>
  583. Should sheet names be included? Default is true
  584. </summary>
  585. <value>if set to <c>true</c> [include sheet names].</value>
  586. </member>
  587. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.FormulasNotResults">
  588. <summary>
  589. Should we return the formula itself, and not
  590. the result it produces? Default is false
  591. </summary>
  592. <value>if set to <c>true</c> [formulas not results].</value>
  593. </member>
  594. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.IncludeCellComments">
  595. <summary>
  596. Should cell comments be included? Default is false
  597. </summary>
  598. <value>if set to <c>true</c> [include cell comments].</value>
  599. </member>
  600. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.Text">
  601. Retreives the text contents of the file
  602. </member>
  603. <member name="T:NPOI.XSSF.Extractor.XSSFExportToXml">
  604. Maps an XLSX to an XML according to one of the mapping defined.
  605. The output XML Schema must respect this limitations:
  606. <ul>
  607. <li> all mandatory elements and attributes must be mapped (enable validation to check this)</li>
  608. <li> no &lt;any&gt; in complex type/element declaration </li>
  609. <li> no &lt;anyAttribute&gt; attributes declaration </li>
  610. <li> no recursive structures: recursive structures can't be nested more than one level </li>
  611. <li> no abstract elements: abstract complex types can be declared but must not be used in elements. </li>
  612. <li> no mixed content: an element can't contain simple text and child element(s) together </li>
  613. <li> no &lt;substitutionGroup&gt; in complex type/element declaration </li>
  614. </ul>
  615. </member>
  616. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.#ctor(NPOI.XSSF.UserModel.XSSFMap)">
  617. Creates a new exporter and Sets the mapping to be used when generating the XML output document
  618. @param map the mapping rule to be used
  619. </member>
  620. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.ExportToXML(System.IO.Stream,System.Boolean)">
  621. Exports the data in an XML stream
  622. @param os OutputStream in which will contain the output XML
  623. @param validate if true, validates the XML againts the XML Schema
  624. @throws SAXException
  625. @throws TransformerException
  626. @throws ParserConfigurationException
  627. </member>
  628. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.ExportToXML(System.IO.Stream,System.String,System.Boolean)">
  629. Exports the data in an XML stream
  630. @param os OutputStream in which will contain the output XML
  631. @param encoding the output charset encoding
  632. @param validate if true, validates the XML againts the XML Schema
  633. @throws SAXException
  634. @throws ParserConfigurationException
  635. @throws TransformerException
  636. @throws InvalidFormatException
  637. </member>
  638. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.IsValid(System.Xml.XmlDocument)">
  639. Validate the generated XML against the XML Schema associated with the XSSFMap
  640. @param xml the XML to validate
  641. @return
  642. </member>
  643. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.Compare(System.String,System.String)">
  644. Compares two xpaths to define an ordering according to the XML Schema
  645. </member>
  646. <member name="T:NPOI.XSSF.Model.CalculationChain">
  647. The cells in a workbook can be calculated in different orders depending on various optimizations and
  648. dependencies. The calculation chain object specifies the order in which the cells in a workbook were last calculated.
  649. @author Yegor Kozlov
  650. </member>
  651. <member name="M:NPOI.XSSF.Model.CalculationChain.RemoveItem(System.Int32,System.String)">
  652. Remove a formula reference from the calculation chain
  653. @param sheetId the sheet Id of a sheet the formula belongs to.
  654. @param ref A1 style reference to the cell Containing the formula.
  655. </member>
  656. <member name="F:NPOI.XSSF.Model.CommentsTable.commentRefs">
  657. XML Beans uses a list, which is very slow
  658. to search, so we wrap things with our own
  659. map for fast Lookup.
  660. </member>
  661. <member name="M:NPOI.XSSF.Model.CommentsTable.ReferenceUpdated(System.String,NPOI.OpenXmlFormats.Spreadsheet.CT_Comment)">
  662. Called after the reference is updated, so that
  663. we can reflect that in our cache
  664. </member>
  665. <member name="M:NPOI.XSSF.Model.CommentsTable.FindAuthor(System.String)">
  666. <summary>
  667. Searches the author. If not found he is added to the list of authors.
  668. </summary>
  669. <param name="author">author to search</param>
  670. <returns>index of the author</returns>
  671. </member>
  672. <member name="T:NPOI.XSSF.Model.IndexedUDFFinder">
  673. A UDFFinder that can retrieve functions both by name and by fake index.
  674. @author Yegor Kozlov
  675. </member>
  676. <member name="T:NPOI.XSSF.Model.MapInfo">
  677. This class : the Custom XML Mapping Part (Open Office XML Part 1:
  678. chapter 12.3.6)
  679. An instance of this part type Contains a schema for an XML file, and
  680. information on the behavior that is used when allowing this custom XML schema
  681. to be mapped into the spreadsheet.
  682. @author Roberto Manicardi
  683. </member>
  684. <member name="M:NPOI.XSSF.Model.MapInfo.GetCTMapInfo">
  685. @return the internal data object
  686. </member>
  687. <member name="M:NPOI.XSSF.Model.MapInfo.GetCTSchemaById(System.String)">
  688. Gets the
  689. @param schemaId the schema ID
  690. @return CTSchema by it's ID
  691. </member>
  692. <member name="M:NPOI.XSSF.Model.MapInfo.GetAllXSSFMaps">
  693. @return all the mappings configured in this document
  694. </member>
  695. <member name="P:NPOI.XSSF.Model.MapInfo.Workbook">
  696. Returns the parent XSSFWorkbook
  697. @return the parent XSSFWorkbook
  698. </member>
  699. <member name="T:NPOI.XSSF.Model.SharedStringsTable">
  700. Table of strings shared across all sheets in a workbook.
  701. <p>
  702. A workbook may contain thousands of cells Containing string (non-numeric) data. Furthermore this data is very
  703. likely to be repeated across many rows or columns. The goal of implementing a single string table that is shared
  704. across the workbook is to improve performance in opening and saving the file by only Reading and writing the
  705. repetitive information once.
  706. </p>
  707. <p>
  708. Consider for example a workbook summarizing information for cities within various countries. There may be a
  709. column for the name of the country, a column for the name of each city in that country, and a column
  710. Containing the data for each city. In this case the country name is repetitive, being duplicated in many cells.
  711. In many cases the repetition is extensive, and a tremendous savings is realized by making use of a shared string
  712. table when saving the workbook. When displaying text in the spreadsheet, the cell table will just contain an
  713. index into the string table as the value of a cell, instead of the full string.
  714. </p>
  715. <p>
  716. The shared string table Contains all the necessary information for displaying the string: the text, formatting
  717. properties, and phonetic properties (for East Asian languages).
  718. </p>
  719. @author Nick Birch
  720. @author Yegor Kozlov
  721. </member>
  722. <member name="F:NPOI.XSSF.Model.SharedStringsTable.strings">
  723. Array of individual string items in the Shared String table.
  724. </member>
  725. <member name="F:NPOI.XSSF.Model.SharedStringsTable.stmap">
  726. Maps strings and their indexes in the <code>strings</code> arrays
  727. </member>
  728. <member name="F:NPOI.XSSF.Model.SharedStringsTable.count">
  729. An integer representing the total count of strings in the workbook. This count does not
  730. include any numbers, it counts only the total of text strings in the workbook.
  731. </member>
  732. <member name="F:NPOI.XSSF.Model.SharedStringsTable.uniqueCount">
  733. An integer representing the total count of unique strings in the Shared String Table.
  734. A string is unique even if it is a copy of another string, but has different formatting applied
  735. at the character level.
  736. </member>
  737. <member name="M:NPOI.XSSF.Model.SharedStringsTable.GetEntryAt(System.Int32)">
  738. Return a string item by index
  739. @param idx index of item to return.
  740. @return the item at the specified position in this Shared String table.
  741. </member>
  742. <member name="M:NPOI.XSSF.Model.SharedStringsTable.AddEntry(NPOI.OpenXmlFormats.Spreadsheet.CT_Rst)">
  743. Add an entry to this Shared String table (a new value is appened to the end).
  744. <p>
  745. If the Shared String table already Contains this <code>CT_Rst</code> bean, its index is returned.
  746. Otherwise a new entry is aded.
  747. </p>
  748. @param st the entry to add
  749. @return index the index of Added entry
  750. </member>
  751. <member name="M:NPOI.XSSF.Model.SharedStringsTable.WriteTo(System.IO.Stream)">
  752. this table out as XML.
  753. @param out The stream to write to.
  754. @throws IOException if an error occurs while writing.
  755. </member>
  756. <member name="P:NPOI.XSSF.Model.SharedStringsTable.Count">
  757. Return an integer representing the total count of strings in the workbook. This count does not
  758. include any numbers, it counts only the total of text strings in the workbook.
  759. @return the total count of strings in the workbook
  760. </member>
  761. <member name="P:NPOI.XSSF.Model.SharedStringsTable.UniqueCount">
  762. Returns an integer representing the total count of unique strings in the Shared String Table.
  763. A string is unique even if it is a copy of another string, but has different formatting applied
  764. at the character level.
  765. @return the total count of unique strings in the workbook
  766. </member>
  767. <member name="P:NPOI.XSSF.Model.SharedStringsTable.Items">
  768. Provide low-level access to the underlying array of CT_Rst beans
  769. @return array of CT_Rst beans
  770. </member>
  771. <member name="T:NPOI.XSSF.Model.SingleXmlCells">
  772. This class : the Single Cell Tables Part (Open Office XML Part 4:
  773. chapter 3.5.2)
  774. @author Roberto Manicardi
  775. </member>
  776. <member name="M:NPOI.XSSF.Model.SingleXmlCells.GetAllSimpleXmlCell">
  777. @return all the SimpleXmlCell Contained in this SingleXmlCells element
  778. </member>
  779. <member name="T:NPOI.XSSF.Model.StylesTable">
  780. Table of styles shared across all sheets in a workbook.
  781. @author ugo
  782. </member>
  783. <member name="F:NPOI.XSSF.Model.StylesTable.FIRST_CUSTOM_STYLE_ID">
  784. The first style id available for use as a custom style
  785. </member>
  786. <member name="M:NPOI.XSSF.Model.StylesTable.#ctor">
  787. Create a new, empty StylesTable
  788. </member>
  789. <member name="M:NPOI.XSSF.Model.StylesTable.ReadFrom(System.Xml.XmlDocument)">
  790. Read this shared styles table from an XML file.
  791. @param is The input stream Containing the XML document.
  792. @throws IOException if an error occurs while Reading.
  793. </member>
  794. <member name="M:NPOI.XSSF.Model.StylesTable.PutFont(NPOI.XSSF.UserModel.XSSFFont,System.Boolean)">
  795. Records the given font in the font table.
  796. Will re-use an existing font index if this
  797. font matches another, EXCEPT if forced
  798. registration is requested.
  799. This allows people to create several fonts
  800. then customise them later.
  801. Note - End Users probably want to call
  802. {@link XSSFFont#registerTo(StylesTable)}
  803. </member>
  804. <member name="M:NPOI.XSSF.Model.StylesTable.GetCTStylesheet">
  805. For unit testing only!
  806. </member>
  807. <member name="M:NPOI.XSSF.Model.StylesTable.WriteTo(System.IO.Stream)">
  808. Write this table out as XML.
  809. @param out The stream to write to.
  810. @throws IOException if an error occurs while writing.
  811. </member>
  812. <member name="M:NPOI.XSSF.Model.StylesTable.FindFont(System.Int16,System.Int16,System.Int16,System.String,System.Boolean,System.Boolean,NPOI.SS.UserModel.FontSuperScript,NPOI.SS.UserModel.FontUnderlineType)">
  813. Finds a font that matches the one with the supplied attributes
  814. </member>
  815. <member name="P:NPOI.XSSF.Model.StylesTable.NumCellStyles">
  816. get the size of cell styles
  817. </member>
  818. <member name="P:NPOI.XSSF.Model.StylesTable.NumberFormatSize">
  819. For unit testing only
  820. </member>
  821. <member name="P:NPOI.XSSF.Model.StylesTable.XfsSize">
  822. For unit testing only
  823. </member>
  824. <member name="P:NPOI.XSSF.Model.StylesTable.StyleXfsSize">
  825. For unit testing only
  826. </member>
  827. <member name="T:NPOI.XSSF.Model.ThemesTable">
  828. Class that represents theme of XLSX document. The theme includes specific
  829. colors and fonts.
  830. @author Petr Udalau(Petr.Udalau at exigenservices.com) - theme colors
  831. </member>
  832. <member name="M:NPOI.XSSF.Model.ThemesTable.InheritFromThemeAsRequired(NPOI.XSSF.UserModel.XSSFColor)">
  833. If the colour is based on a theme, then inherit
  834. information (currently just colours) from it as
  835. required.
  836. </member>
  837. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartAxis">
  838. Base class for all axis types.
  839. @author Roman Kashitsyn
  840. </member>
  841. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartDataFactory">
  842. @author Roman Kashitsyn
  843. </member>
  844. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartDataFactory.CreateScatterChartData``2">
  845. @return new scatter chart data instance
  846. </member>
  847. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartDataFactory.GetInstance">
  848. @return factory instance
  849. </member>
  850. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartLegend">
  851. Represents a SpreadsheetML chart legend
  852. @author Roman Kashitsyn
  853. </member>
  854. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.legend">
  855. Underlaying CTLagend bean
  856. </member>
  857. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.#ctor(NPOI.XSSF.UserModel.XSSFChart)">
  858. Create a new SpreadsheetML chart legend
  859. </member>
  860. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.GetCTLegend">
  861. Return the underlying CTLegend bean.
  862. @return the underlying CTLegend bean
  863. </member>
  864. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartUtil">
  865. Package private class with utility methods.
  866. @author Roman Kashitsyn
  867. </member>
  868. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartUtil.BuildAxDataSource``1(NPOI.OpenXmlFormats.Dml.Chart.CT_AxDataSource,NPOI.SS.UserModel.Charts.IChartDataSource{``0})">
  869. Builds CTAxDataSource object content from POI ChartDataSource.
  870. @param ctAxDataSource OOXML data source to build
  871. @param dataSource POI data source to use
  872. </member>
  873. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartUtil.BuildNumDataSource``1(NPOI.OpenXmlFormats.Dml.Chart.CT_NumDataSource,NPOI.SS.UserModel.Charts.IChartDataSource{``0})">
  874. Builds CTNumDataSource object content from POI ChartDataSource
  875. @param ctNumDataSource OOXML data source to build
  876. @param dataSource POI data source to use
  877. </member>
  878. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFLineChartData`2.series">
  879. List of all data series.
  880. </member>
  881. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFManualLayout">
  882. Represents a SpreadsheetML manual layout.
  883. @author Roman Kashitsyn
  884. </member>
  885. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.layout">
  886. Underlaying CTManualLayout bean.
  887. </member>
  888. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.#ctor(NPOI.OpenXmlFormats.Dml.Chart.CT_Layout)">
  889. Create a new SpreadsheetML manual layout.
  890. @param layout a Spreadsheet ML layout that should be used as base.
  891. </member>
  892. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.#ctor(NPOI.XSSF.UserModel.XSSFChart)">
  893. Create a new SpreadsheetML manual layout for chart.
  894. @param chart a chart to create layout for.
  895. </member>
  896. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.GetCTManualLayout">
  897. Return the underlying CTManualLayout bean.
  898. @return the underlying CTManualLayout bean.
  899. </member>
  900. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2">
  901. Represents DrawingML scatter chart.
  902. @author Roman Kashitsyn
  903. </member>
  904. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.series">
  905. List of all data series.
  906. </member>
  907. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Serie">
  908. Package private ScatterChartSerie implementation.
  909. </member>
  910. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Serie.GetXValues">
  911. Returns data source used for X axis values.
  912. @return data source used for X axis values
  913. </member>
  914. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Serie.GetYValues">
  915. Returns data source used for Y axis values.
  916. @return data source used for Y axis values
  917. </member>
  918. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Serie.SetUseCache(System.Boolean)">
  919. @param useCache if true, cached results will be Added on plot
  920. </member>
  921. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFValueAxis">
  922. Value axis type.
  923. @author Roman Kashitsyn
  924. </member>
  925. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment">
  926. Cell Settings avaiable in the Format/Alignment tab
  927. </member>
  928. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_CellAlignment)">
  929. Creates a Cell Alignment from the supplied XML defInition
  930. @param cellAlignment
  931. </member>
  932. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.GetCTCellAlignment">
  933. Access to low-level data
  934. </member>
  935. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.Vertical">
  936. Get the type of vertical alignment for the cell
  937. @return the type of aligment
  938. @see VerticalAlignment
  939. </member>
  940. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.Horizontal">
  941. Get the type of horizontal alignment for the cell
  942. @return the type of aligment
  943. @see HorizontalAlignment
  944. </member>
  945. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.Indent">
  946. Get the number of spaces to indent the text in the cell
  947. @return indent - number of spaces
  948. </member>
  949. <!-- 对于成员“P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.TextRotation”忽略有格式错误的 XML 注释 -->
  950. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.WrapText">
  951. Whether the text should be wrapped
  952. @return a bool value indicating if the text in a cell should be line-wrapped within the cell.
  953. </member>
  954. <member name="T:NPOI.XSSF.UserModel.Extensions.BorderSide">
  955. The enumeration value indicating the side being used for a cell border.
  956. </member>
  957. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder">
  958. This element Contains border formatting information, specifying border defInition formats (left, right, top, bottom, diagonal)
  959. for cells in the workbook.
  960. Color is optional.
  961. </member>
  962. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Border,NPOI.XSSF.Model.ThemesTable)">
  963. Creates a Cell Border from the supplied XML defInition
  964. </member>
  965. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Border)">
  966. Creates a Cell Border from the supplied XML defInition
  967. </member>
  968. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.#ctor">
  969. Creates a new, empty Cell Border.
  970. You need to attach this to the Styles Table
  971. </member>
  972. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.SetThemesTable(NPOI.XSSF.Model.ThemesTable)">
  973. Records the Themes Table that is associated with
  974. the current font, used when looking up theme
  975. based colours and properties.
  976. </member>
  977. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.GetCTBorder">
  978. Returns the underlying XML bean.
  979. @return CT_Border
  980. </member>
  981. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.GetBorderStyle(NPOI.XSSF.UserModel.Extensions.BorderSide)">
  982. Get the type of border to use for the selected border
  983. @param side - - where to apply the color defInition
  984. @return borderstyle - the type of border to use. default value is NONE if border style is not Set.
  985. @see BorderStyle
  986. </member>
  987. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.SetBorderStyle(NPOI.XSSF.UserModel.Extensions.BorderSide,NPOI.SS.UserModel.BorderStyle)">
  988. Set the type of border to use for the selected border
  989. @param side - - where to apply the color defInition
  990. @param style - border style
  991. @see BorderStyle
  992. </member>
  993. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.GetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide)">
  994. Get the color to use for the selected border
  995. @param side - where to apply the color defInition
  996. @return color - color to use as XSSFColor. null if color is not set
  997. </member>
  998. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.SetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide,NPOI.XSSF.UserModel.XSSFColor)">
  999. Set the color to use for the selected border
  1000. @param side - where to apply the color defInition
  1001. @param color - the color to use
  1002. </member>
  1003. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFCellFill">
  1004. This element specifies fill formatting.
  1005. A cell fill consists of a background color, foreground color, and pattern to be applied across the cell.
  1006. </member>
  1007. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Fill)">
  1008. Creates a CellFill from the supplied parts
  1009. @param fill - fill
  1010. </member>
  1011. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.#ctor">
  1012. Creates an empty CellFill
  1013. </member>
  1014. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetFillBackgroundColor">
  1015. Get the background fill color.
  1016. @return fill color, null if color is not set
  1017. </member>
  1018. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillBackgroundColor(System.Int32)">
  1019. Set the background fill color represented as a indexed color value.
  1020. @param index
  1021. </member>
  1022. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillBackgroundColor(NPOI.XSSF.UserModel.XSSFColor)">
  1023. Set the background fill color represented as a {@link XSSFColor} value.
  1024. @param color
  1025. </member>
  1026. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetFillForegroundColor">
  1027. Get the foreground fill color.
  1028. @return XSSFColor - foreground color. null if color is not set
  1029. </member>
  1030. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillForegroundColor(System.Int32)">
  1031. Set the foreground fill color as a indexed color value
  1032. @param index - the color to use
  1033. </member>
  1034. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillForegroundColor(NPOI.XSSF.UserModel.XSSFColor)">
  1035. Set the foreground fill color represented as a {@link XSSFColor} value.
  1036. @param color - the color to use
  1037. </member>
  1038. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetPatternType">
  1039. get the fill pattern
  1040. @return fill pattern type. null if fill pattern is not set
  1041. </member>
  1042. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetPatternType(NPOI.OpenXmlFormats.Spreadsheet.ST_PatternType)">
  1043. set the fill pattern
  1044. @param patternType fill pattern to use
  1045. </member>
  1046. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetCTFill">
  1047. Returns the underlying XML bean.
  1048. @return CT_Fill
  1049. </member>
  1050. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter">
  1051. <summary>
  1052. Parent class of all XSSF headers and footers.
  1053. </summary>
  1054. </member>
  1055. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  1056. Create an instance of XSSFHeaderFooter from the supplied XML bean
  1057. @param headerFooter
  1058. </member>
  1059. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.GetHeaderFooter">
  1060. Returns the underlying CTHeaderFooter xml bean
  1061. @return the underlying CTHeaderFooter xml bean
  1062. </member>
  1063. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.AreFieldsStripped">
  1064. Are fields currently being stripped from the text that this
  1065. {@link XSSFHeaderFooter} returns? Default is false, but can be Changed
  1066. </member>
  1067. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.SetAreFieldsStripped(System.Boolean)">
  1068. Should fields (eg macros) be stripped from the text that this class
  1069. returns? Default is not to strip.
  1070. @param StripFields
  1071. </member>
  1072. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.StripFields(System.String)">
  1073. Removes any fields (eg macros, page markers etc) from the string.
  1074. Normally used to make some text suitable for showing to humans, and the
  1075. resultant text should not normally be saved back into the document!
  1076. </member>
  1077. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.Center">
  1078. get the text representing the center part of this element
  1079. </member>
  1080. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.Left">
  1081. get the text representing the left part of this element
  1082. </member>
  1083. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.Right">
  1084. get the text representing the right part of this element
  1085. </member>
  1086. <member name="T:NPOI.XSSF.UserModel.Helpers.ColumnHelper">
  1087. Helper class for dealing with the Column Settings on
  1088. a CT_Worksheet (the data part of a sheet).
  1089. Note - within POI, we use 0 based column indexes, but
  1090. the column defInitions in the XML are 1 based!
  1091. </member>
  1092. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.GetColumn(System.Int64,System.Boolean)">
  1093. Returns the Column at the given 0 based index
  1094. </member>
  1095. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.GetColumn1Based(System.Int64,System.Boolean)">
  1096. Returns the Column at the given 1 based index.
  1097. POI default is 0 based, but the file stores
  1098. as 1 based.
  1099. </member>
  1100. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.columnExists(NPOI.OpenXmlFormats.Spreadsheet.CT_Cols,System.Int64)">
  1101. Does the column at the given 0 based index exist
  1102. in the supplied list of column defInitions?
  1103. </member>
  1104. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.GetOrCreateColumn1Based(System.Int64,System.Boolean)">
  1105. Return the CT_Col at the given (0 based) column index,
  1106. creating it if required.
  1107. </member>
  1108. <member name="M:NPOI.XSSF.UserModel.Helpers.HeaderFooterHelper.GetParts(System.String)">
  1109. Split into left, center, right
  1110. </member>
  1111. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils">
  1112. Utility to update formulas and named ranges when a sheet name was Changed
  1113. @author Yegor Kozlov
  1114. </member>
  1115. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils.UpdateSheetName(System.Int32,System.String)">
  1116. Update sheet name in all formulas and named ranges.
  1117. Called from {@link XSSFWorkbook#SetSheetName(int, String)}
  1118. <p/>
  1119. <p>
  1120. The idea is to parse every formula and render it back to string
  1121. with the updated sheet name. The IFormulaParsingWorkbook passed to the formula Parser
  1122. is constructed from the old workbook (sheet name is not yet updated) and
  1123. the FormulaRenderingWorkbook passed to FormulaRenderer#toFormulaString is a custom implementation that
  1124. returns the new sheet name.
  1125. </p>
  1126. @param sheetIndex the 0-based index of the sheet being Changed
  1127. @param name the new sheet name
  1128. </member>
  1129. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils.UpdateFormula(NPOI.XSSF.UserModel.XSSFCell,NPOI.SS.Formula.IFormulaRenderingWorkbook)">
  1130. Parse cell formula and re-assemble it back using the specified FormulaRenderingWorkbook.
  1131. @param cell the cell to update
  1132. @param frwb the formula rendering workbbok that returns new sheet name
  1133. </member>
  1134. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils.UpdateName(NPOI.SS.UserModel.IName,NPOI.SS.Formula.IFormulaRenderingWorkbook)">
  1135. Parse formula in the named range and re-assemble it back using the specified FormulaRenderingWorkbook.
  1136. @param name the name to update
  1137. @param frwb the formula rendering workbbok that returns new sheet name
  1138. </member>
  1139. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter">
  1140. @author Yegor Kozlov
  1141. </member>
  1142. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.ShiftMerged(System.Int32,System.Int32,System.Int32)">
  1143. Shift merged regions
  1144. @param startRow the row to start Shifting
  1145. @param endRow the row to end Shifting
  1146. @param n the number of rows to shift
  1147. @return an array of affected cell regions
  1148. </member>
  1149. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.ContainsCell(NPOI.SS.Util.CellRangeAddress,System.Int32,System.Int32)">
  1150. Check if the row and column are in the specified cell range
  1151. @param cr the cell range to check in
  1152. @param rowIx the row to check
  1153. @param colIx the column to check
  1154. @return true if the range Contains the cell [rowIx,colIx]
  1155. </member>
  1156. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.UpdateNamedRanges(NPOI.SS.Formula.FormulaShifter)">
  1157. Updated named ranges
  1158. </member>
  1159. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.UpdateFormulas(NPOI.SS.Formula.FormulaShifter)">
  1160. Update formulas.
  1161. </member>
  1162. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.ShiftFormula(NPOI.XSSF.UserModel.XSSFRow,System.String,NPOI.SS.Formula.FormulaShifter)">
  1163. Shift a formula using the supplied FormulaShifter
  1164. @param row the row of the cell this formula belongs to. Used to get a reference to the parent workbook.
  1165. @param formula the formula to shift
  1166. @param Shifter the FormulaShifter object that operates on the Parsed formula tokens
  1167. @return the Shifted formula if the formula was Changed,
  1168. <code>null</code> if the formula wasn't modified
  1169. </member>
  1170. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFSingleXmlCell">
  1171. *
  1172. * This class is a wrapper around the CTSingleXmlCell (Open Office XML Part 4:
  1173. * chapter 3.5.2.1)
  1174. *
  1175. *
  1176. * @author Roberto Manicardi
  1177. *
  1178. </member>
  1179. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFSingleXmlCell.GetReferencedCell">
  1180. Gets the XSSFCell referenced by the R attribute or Creates a new one if cell doesn't exists
  1181. @return the referenced XSSFCell, null if the cell reference is invalid
  1182. </member>
  1183. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFXmlColumnPr">
  1184. This class is a wrapper around the CT_XmlColumnPr (Open Office XML Part 4:
  1185. chapter 3.5.1.7)
  1186. @author Roberto Manicardi
  1187. </member>
  1188. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFXmlColumnPr.GetId">
  1189. (see Open Office XML Part 4: chapter 3.5.1.3)
  1190. @return An integer representing the unique identifier of this column.
  1191. </member>
  1192. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFXmlColumnPr.GetLocalXPath">
  1193. If the XPath is, for example, /Node1/Node2/Node3 and /Node1/Node2 is the common XPath for the table, the local XPath is /Node3
  1194. @return the local XPath
  1195. </member>
  1196. <member name="T:NPOI.XSSF.UserModel.XSSFAnchor">
  1197. An anchor is what specifics the position of a shape within a client object
  1198. or within another containing shape.
  1199. @author Yegor Kozlov
  1200. </member>
  1201. <member name="T:NPOI.XSSF.UserModel.XSSFAutoFilter">
  1202. Represents autofiltering for the specified worksheet.
  1203. @author Yegor Kozlov
  1204. </member>
  1205. <member name="T:NPOI.XSSF.UserModel.XSSFBorderFormatting">
  1206. @author Yegor Kozlov
  1207. </member>
  1208. <member name="T:NPOI.XSSF.UserModel.XSSFCell">
  1209. High level representation of a cell in a row of a spreadsheet.
  1210. <p>
  1211. Cells can be numeric, formula-based or string-based (text). The cell type
  1212. specifies this. String cells cannot conatin numbers and numeric cells cannot
  1213. contain strings (at least according to our model). Client apps should do the
  1214. conversions themselves. Formula cells have the formula string, as well as
  1215. the formula result, which can be numeric or string.
  1216. </p>
  1217. <p>
  1218. Cells should have their number (0 based) before being Added to a row. Only
  1219. cells that have values should be Added.
  1220. </p>
  1221. </member>
  1222. <member name="F:NPOI.XSSF.UserModel.XSSFCell._cell">
  1223. the xml bean Containing information about the cell's location, value,
  1224. data type, formatting, and formula
  1225. </member>
  1226. <member name="F:NPOI.XSSF.UserModel.XSSFCell._row">
  1227. the XSSFRow this cell belongs to
  1228. </member>
  1229. <member name="F:NPOI.XSSF.UserModel.XSSFCell._cellNum">
  1230. 0-based column index
  1231. </member>
  1232. <member name="F:NPOI.XSSF.UserModel.XSSFCell._sharedStringSource">
  1233. Table of strings shared across this workbook.
  1234. If two cells contain the same string, then the cell value is the same index into SharedStringsTable
  1235. </member>
  1236. <member name="F:NPOI.XSSF.UserModel.XSSFCell._stylesSource">
  1237. Table of cell styles shared across all cells in a workbook.
  1238. </member>
  1239. <member name="M:NPOI.XSSF.UserModel.XSSFCell.#ctor(NPOI.XSSF.UserModel.XSSFRow,NPOI.OpenXmlFormats.Spreadsheet.CT_Cell)">
  1240. Construct a XSSFCell.
  1241. @param row the parent row.
  1242. @param cell the xml bean Containing information about the cell.
  1243. </member>
  1244. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetSharedStringSource">
  1245. @return table of strings shared across this workbook
  1246. </member>
  1247. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetStylesSource">
  1248. @return table of cell styles shared across this workbook
  1249. </member>
  1250. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.Boolean)">
  1251. Set a bool value for the cell
  1252. @param value the bool value to Set this cell to. For formulas we'll Set the
  1253. precalculated value, for bools we'll Set its value. For other types we
  1254. will change the cell to a bool cell and Set its value.
  1255. </member>
  1256. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.Double)">
  1257. Set a numeric value for the cell
  1258. @param value the numeric value to Set this cell to. For formulas we'll Set the
  1259. precalculated value, for numerics we'll Set its value. For other types we
  1260. will change the cell to a numeric cell and Set its value.
  1261. </member>
  1262. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.String)">
  1263. Set a string value for the cell.
  1264. @param str value to Set the cell to. For formulas we'll Set the formula
  1265. cached string result, for String cells we'll Set its value. For other types we will
  1266. change the cell to a string cell and Set its value.
  1267. If value is null then we will change the cell to a Blank cell.
  1268. </member>
  1269. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(NPOI.SS.UserModel.IRichTextString)">
  1270. Set a string value for the cell.
  1271. @param str value to Set the cell to. For formulas we'll Set the 'pre-Evaluated result string,
  1272. for String cells we'll Set its value. For other types we will
  1273. change the cell to a string cell and Set its value.
  1274. If value is null then we will change the cell to a Blank cell.
  1275. </member>
  1276. <member name="M:NPOI.XSSF.UserModel.XSSFCell.ConvertSharedFormula(System.Int32)">
  1277. <summary>
  1278. Creates a non shared formula from the shared formula counterpart
  1279. </summary>
  1280. <param name="si">Shared Group Index</param>
  1281. <returns>non shared formula created for the given shared formula and this cell</returns>
  1282. </member>
  1283. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellFormula(System.String)">
  1284. Sets formula for this cell.
  1285. <p>
  1286. Note, this method only Sets the formula string and does not calculate the formula value.
  1287. To Set the precalculated value use {@link #setCellValue(double)} or {@link #setCellValue(String)}
  1288. </p>
  1289. @param formula the formula to Set, e.g. <code>"SUM(C4:E4)"</code>.
  1290. If the argument is <code>null</code> then the current formula is Removed.
  1291. @throws NPOI.ss.formula.FormulaParseException if the formula has incorrect syntax or is otherwise invalid
  1292. @throws InvalidOperationException if the operation is not allowed, for example,
  1293. when the cell is a part of a multi-cell array formula
  1294. </member>
  1295. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetReference">
  1296. <summary>
  1297. Returns an A1 style reference to the location of this cell
  1298. </summary>
  1299. <returns>A1 style reference to the location of this cell</returns>
  1300. </member>
  1301. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetBaseCellType(System.Boolean)">
  1302. <summary>
  1303. Detect cell type based on the "t" attribute of the CT_Cell bean
  1304. </summary>
  1305. <param name="blankCells"></param>
  1306. <returns></returns>
  1307. </member>
  1308. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.DateTime)">
  1309. <summary>
  1310. Set a date value for the cell. Excel treats dates as numeric so you will need to format the cell as a date.
  1311. </summary>
  1312. <param name="value">the date value to Set this cell to. For formulas we'll set the precalculated value,
  1313. for numerics we'll Set its value. For other types we will change the cell to a numeric cell and Set its value. </param>
  1314. </member>
  1315. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellErrorValue(NPOI.SS.UserModel.FormulaError)">
  1316. <summary>
  1317. Set a error value for the cell
  1318. </summary>
  1319. <param name="error">the error value to Set this cell to.
  1320. For formulas we'll Set the precalculated value , for errors we'll set
  1321. its value. For other types we will change the cell to an error cell and Set its value.
  1322. </param>
  1323. </member>
  1324. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetAsActiveCell">
  1325. <summary>
  1326. Sets this cell as the active cell for the worksheet.
  1327. </summary>
  1328. </member>
  1329. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetBlank">
  1330. <summary>
  1331. Blanks this cell. Blank cells have no formula or value but may have styling.
  1332. This method erases all the data previously associated with this cell.
  1333. </summary>
  1334. </member>
  1335. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellNum(System.Int32)">
  1336. <summary>
  1337. Sets column index of this cell
  1338. </summary>
  1339. <param name="num"></param>
  1340. </member>
  1341. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellType(NPOI.SS.UserModel.CellType)">
  1342. <summary>
  1343. Set the cells type (numeric, formula or string)
  1344. </summary>
  1345. <param name="cellType"></param>
  1346. </member>
  1347. <member name="M:NPOI.XSSF.UserModel.XSSFCell.ToString">
  1348. <summary>
  1349. Returns a string representation of the cell
  1350. </summary>
  1351. <returns>Formula cells return the formula string, rather than the formula result.
  1352. Dates are displayed in dd-MMM-yyyy format
  1353. Errors are displayed as #ERR&lt;errIdx&gt;
  1354. </returns>
  1355. </member>
  1356. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetRawValue">
  1357. Returns the raw, underlying ooxml value for the cell
  1358. <p>
  1359. If the cell Contains a string, then this value is an index into
  1360. the shared string table, pointing to the actual string value. Otherwise,
  1361. the value of the cell is expressed directly in this element. Cells Containing formulas express
  1362. the last calculated result of the formula in this element.
  1363. </p>
  1364. @return the raw cell value as Contained in the underlying CT_Cell bean,
  1365. <code>null</code> for blank cells.
  1366. </member>
  1367. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetCellTypeName(NPOI.SS.UserModel.CellType)">
  1368. <summary>
  1369. Used to help format error messages
  1370. </summary>
  1371. <param name="cellTypeCode"></param>
  1372. <returns></returns>
  1373. </member>
  1374. <member name="M:NPOI.XSSF.UserModel.XSSFCell.TypeMismatch(NPOI.SS.UserModel.CellType,NPOI.SS.UserModel.CellType,System.Boolean)">
  1375. Used to help format error messages
  1376. </member>
  1377. <member name="M:NPOI.XSSF.UserModel.XSSFCell.CheckBounds(System.Int32)">
  1378. @throws RuntimeException if the bounds are exceeded.
  1379. </member>
  1380. <member name="M:NPOI.XSSF.UserModel.XSSFCell.RemoveCellComment">
  1381. <summary>
  1382. Removes the comment for this cell, if there is one.
  1383. </summary>
  1384. </member>
  1385. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetCTCell">
  1386. Returns the xml bean containing information about the cell's location (reference), value,
  1387. data type, formatting, and formula
  1388. @return the xml bean containing information about this cell
  1389. </member>
  1390. <member name="M:NPOI.XSSF.UserModel.XSSFCell.ConvertCellValueToBoolean">
  1391. Chooses a new bool value for the cell when its type is changing.<p/>
  1392. Usually the caller is calling SetCellType() with the intention of calling
  1393. SetCellValue(bool) straight afterwards. This method only exists to give
  1394. the cell a somewhat reasonable value until the SetCellValue() call (if at all).
  1395. TODO - perhaps a method like SetCellTypeAndValue(int, Object) should be introduced to avoid this
  1396. </member>
  1397. <member name="M:NPOI.XSSF.UserModel.XSSFCell.NotifyArrayFormulaChanging(System.String)">
  1398. The purpose of this method is to validate the cell state prior to modification
  1399. @see #NotifyArrayFormulaChanging()
  1400. </member>
  1401. <member name="M:NPOI.XSSF.UserModel.XSSFCell.NotifyArrayFormulaChanging">
  1402. <summary>
  1403. Called when this cell is modified.The purpose of this method is to validate the cell state prior to modification.
  1404. </summary>
  1405. <exception cref="T:System.InvalidOperationException">if modification is not allowed</exception>
  1406. </member>
  1407. <member name="P:NPOI.XSSF.UserModel.XSSFCell.Sheet">
  1408. Returns the sheet this cell belongs to
  1409. @return the sheet this cell belongs to
  1410. </member>
  1411. <member name="P:NPOI.XSSF.UserModel.XSSFCell.Row">
  1412. Returns the row this cell belongs to
  1413. @return the row this cell belongs to
  1414. </member>
  1415. <member name="P:NPOI.XSSF.UserModel.XSSFCell.BooleanCellValue">
  1416. Get the value of the cell as a bool.
  1417. <p>
  1418. For strings, numbers, and errors, we throw an exception. For blank cells we return a false.
  1419. </p>
  1420. @return the value of the cell as a bool
  1421. @throws InvalidOperationException if the cell type returned by {@link #CellType}
  1422. is not CellType.Boolean, CellType.Blank or CellType.Formula
  1423. </member>
  1424. <member name="P:NPOI.XSSF.UserModel.XSSFCell.NumericCellValue">
  1425. Get the value of the cell as a number.
  1426. <p>
  1427. For strings we throw an exception. For blank cells we return a 0.
  1428. For formulas or error cells we return the precalculated value;
  1429. </p>
  1430. @return the value of the cell as a number
  1431. @throws InvalidOperationException if the cell type returned by {@link #CellType} is CellType.String
  1432. @exception NumberFormatException if the cell value isn't a parsable <code>double</code>.
  1433. @see DataFormatter for turning this number into a string similar to that which Excel would render this number as.
  1434. </member>
  1435. <member name="P:NPOI.XSSF.UserModel.XSSFCell.StringCellValue">
  1436. Get the value of the cell as a string
  1437. <p>
  1438. For numeric cells we throw an exception. For blank cells we return an empty string.
  1439. For formulaCells that are not string Formulas, we throw an exception
  1440. </p>
  1441. @return the value of the cell as a string
  1442. </member>
  1443. <member name="P:NPOI.XSSF.UserModel.XSSFCell.RichStringCellValue">
  1444. Get the value of the cell as a XSSFRichTextString
  1445. <p>
  1446. For numeric cells we throw an exception. For blank cells we return an empty string.
  1447. For formula cells we return the pre-calculated value if a string, otherwise an exception
  1448. </p>
  1449. @return the value of the cell as a XSSFRichTextString
  1450. </member>
  1451. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellFormula">
  1452. <summary>
  1453. Return a formula for the cell, for example, <code>SUM(C4:E4)</code>
  1454. </summary>
  1455. </member>
  1456. <member name="P:NPOI.XSSF.UserModel.XSSFCell.ColumnIndex">
  1457. <summary>
  1458. Returns zero-based column index of this cell
  1459. </summary>
  1460. </member>
  1461. <member name="P:NPOI.XSSF.UserModel.XSSFCell.RowIndex">
  1462. <summary>
  1463. Returns zero-based row index of a row in the sheet that contains this cell
  1464. </summary>
  1465. </member>
  1466. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellStyle">
  1467. <summary>
  1468. Return the cell's style.
  1469. </summary>
  1470. </member>
  1471. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellType">
  1472. <summary>
  1473. Return the cell type.
  1474. </summary>
  1475. </member>
  1476. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CachedFormulaResultType">
  1477. <summary>
  1478. Only valid for formula cells
  1479. </summary>
  1480. </member>
  1481. <member name="P:NPOI.XSSF.UserModel.XSSFCell.DateCellValue">
  1482. <summary>
  1483. Get the value of the cell as a date.
  1484. </summary>
  1485. </member>
  1486. <member name="P:NPOI.XSSF.UserModel.XSSFCell.ErrorCellString">
  1487. <summary>
  1488. Returns the error message, such as #VALUE!
  1489. </summary>
  1490. </member>
  1491. <member name="P:NPOI.XSSF.UserModel.XSSFCell.ErrorCellValue">
  1492. <summary>
  1493. Get the value of the cell as an error code.
  1494. For strings, numbers, and bools, we throw an exception.
  1495. For blank cells we return a 0.
  1496. </summary>
  1497. </member>
  1498. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellComment">
  1499. <summary>
  1500. Returns cell comment associated with this cell
  1501. </summary>
  1502. </member>
  1503. <member name="P:NPOI.XSSF.UserModel.XSSFCell.Hyperlink">
  1504. <summary>
  1505. Returns hyperlink associated with this cell
  1506. </summary>
  1507. </member>
  1508. <member name="T:NPOI.XSSF.UserModel.XSSFCellStyle">
  1509. High level representation of the the possible formatting information for the contents of the cells on a sheet in a
  1510. SpreadsheetML document.
  1511. @see NPOI.xssf.usermodel.XSSFWorkbook#CreateCellStyle()
  1512. @see NPOI.xssf.usermodel.XSSFWorkbook#getCellStyleAt(short)
  1513. @see NPOI.xssf.usermodel.XSSFCell#setCellStyle(NPOI.ss.usermodel.CellStyle)
  1514. </member>
  1515. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.#ctor(System.Int32,System.Int32,NPOI.XSSF.Model.StylesTable,NPOI.XSSF.Model.ThemesTable)">
  1516. Creates a Cell Style from the supplied parts
  1517. @param cellXfId The main XF for the cell. Must be a valid 0-based index into the XF table
  1518. @param cellStyleXfId Optional, style xf. A value of <code>-1</code> means no xf.
  1519. @param stylesSource Styles Source to work off
  1520. </member>
  1521. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCoreXf">
  1522. Used so that StylesSource can figure out our location
  1523. </member>
  1524. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetStyleXf">
  1525. Used so that StylesSource can figure out our location
  1526. </member>
  1527. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.#ctor(NPOI.XSSF.Model.StylesTable)">
  1528. <summary>
  1529. Creates an empty Cell Style
  1530. </summary>
  1531. <param name="stylesSource"></param>
  1532. </member>
  1533. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.VerifyBelongsToStylesSource(NPOI.XSSF.Model.StylesTable)">
  1534. Verifies that this style belongs to the supplied Workbook
  1535. Styles Source.
  1536. Will throw an exception if it belongs to a different one.
  1537. This is normally called when trying to assign a style to a
  1538. cell, to ensure the cell and the style are from the same
  1539. workbook (if they're not, it won't work)
  1540. @throws ArgumentException if there's a workbook mis-match
  1541. </member>
  1542. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.CloneStyleFrom(NPOI.SS.UserModel.ICellStyle)">
  1543. Clones all the style information from another
  1544. XSSFCellStyle, onto this one. This
  1545. XSSFCellStyle will then have all the same
  1546. properties as the source, but the two may
  1547. be edited independently.
  1548. Any stylings on this XSSFCellStyle will be lost!
  1549. The source XSSFCellStyle could be from another
  1550. XSSFWorkbook if you like. This allows you to
  1551. copy styles from one XSSFWorkbook to another.
  1552. </member>
  1553. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetAlignmentEnum">
  1554. <summary>
  1555. Get the type of horizontal alignment for the cell
  1556. </summary>
  1557. <returns>the type of alignment</returns>
  1558. </member>
  1559. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetDataFormatString">
  1560. Get the contents of the format string, by looking up
  1561. the StylesSource
  1562. @return the number format string
  1563. </member>
  1564. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetFont">
  1565. Gets the font for this style
  1566. @return Font - font
  1567. </member>
  1568. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetVerticalAlignmentEnum">
  1569. <summary>
  1570. Get the type of vertical alignment for the cell
  1571. </summary>
  1572. <returns></returns>
  1573. </member>
  1574. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetBottomBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  1575. Set the color to use for the bottom border
  1576. @param color the color to use, null means no color
  1577. </member>
  1578. <!-- 对于成员“M:NPOI.XSSF.UserModel.XSSFCellStyle.SetFillBackgroundColor(NPOI.XSSF.UserModel.XSSFColor)”忽略有格式错误的 XML 注释 -->
  1579. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetFillForegroundColor(NPOI.XSSF.UserModel.XSSFColor)">
  1580. * Set the foreground fill color represented as a {@link XSSFColor} value.
  1581. * <br/>
  1582. * <i>Note: Ensure Foreground color is Set prior to background color.</i>
  1583. * @param color the color to use
  1584. * @see #setFillBackgroundColor(NPOI.xssf.usermodel.XSSFColor) )
  1585. </member>
  1586. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCTFill">
  1587. Get a <b>copy</b> of the currently used CT_Fill, if none is used, return a new instance.
  1588. </member>
  1589. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCTBorder">
  1590. Get a <b>copy</b> of the currently used CT_Border, if none is used, return a new instance.
  1591. </member>
  1592. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetFont(NPOI.SS.UserModel.IFont)">
  1593. Set the font for this style
  1594. @param font a font object Created or retreived from the XSSFWorkbook object
  1595. @see NPOI.xssf.usermodel.XSSFWorkbook#CreateFont()
  1596. @see NPOI.xssf.usermodel.XSSFWorkbook#getFontAt(short)
  1597. </member>
  1598. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetLeftBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  1599. Set the color to use for the left border as a {@link XSSFColor} value
  1600. @param color the color to use
  1601. </member>
  1602. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetRightBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  1603. Set the color to use for the right border as a {@link XSSFColor} value
  1604. @param color the color to use
  1605. </member>
  1606. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetTopBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  1607. Set the color to use for the top border as a {@link XSSFColor} value
  1608. @param color the color to use
  1609. </member>
  1610. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetVerticalAlignment(System.Int16)">
  1611. Set the type of vertical alignment for the cell
  1612. @param align - align the type of alignment
  1613. @see NPOI.ss.usermodel.CellStyle#VERTICAL_TOP
  1614. @see NPOI.ss.usermodel.CellStyle#VERTICAL_CENTER
  1615. @see NPOI.ss.usermodel.CellStyle#VERTICAL_BOTTOM
  1616. @see NPOI.ss.usermodel.CellStyle#VERTICAL_JUSTIFY
  1617. @see NPOI.ss.usermodel.VerticalAlignment
  1618. </member>
  1619. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide)">
  1620. Gets border color
  1621. @param side the border side
  1622. @return the used color
  1623. </member>
  1624. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide,NPOI.XSSF.UserModel.XSSFColor)">
  1625. Set the color to use for the selected border
  1626. @param side - where to apply the color defInition
  1627. @param color - the color to use
  1628. </member>
  1629. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCellAlignment">
  1630. Get the cellAlignment object to use for manage alignment
  1631. @return XSSFCellAlignment - cell alignment
  1632. </member>
  1633. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCTCellAlignment">
  1634. Return the CT_CellAlignment instance for alignment
  1635. @return CT_CellAlignment
  1636. </member>
  1637. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetHashCode">
  1638. Returns a hash code value for the object. The hash is derived from the underlying CT_Xf bean.
  1639. @return the hash code value for this style
  1640. </member>
  1641. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.Equals(System.Object)">
  1642. Checks is the supplied style is equal to this style
  1643. @param o the style to check
  1644. @return true if the supplied style is equal to this style
  1645. </member>
  1646. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.Clone">
  1647. Make a copy of this style. The underlying CT_Xf bean is Cloned,
  1648. the references to Fills and borders remain.
  1649. @return a copy of this style
  1650. </member>
  1651. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BorderRight">
  1652. <summary>
  1653. Get the type of border to use for the right border of the cell
  1654. </summary>
  1655. </member>
  1656. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BottomBorderColor">
  1657. Get the color to use for the bottom border
  1658. Color is optional. When missing, IndexedColors.Automatic is implied.
  1659. @return the index of the color defInition, default value is {@link NPOI.ss.usermodel.IndexedColors#AUTOMATIC}
  1660. @see NPOI.ss.usermodel.IndexedColors
  1661. </member>
  1662. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BottomBorderXSSFColor">
  1663. Get the color to use for the bottom border as a {@link XSSFColor}
  1664. @return the used color or <code>null</code> if not Set
  1665. </member>
  1666. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.DataFormat">
  1667. Get the index of the number format (numFmt) record used by this cell format.
  1668. @return the index of the number format
  1669. </member>
  1670. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillBackgroundColor">
  1671. <summary>
  1672. Get the background fill color.
  1673. Note - many cells are actually filled with a foreground fill, not a background fill
  1674. </summary>
  1675. </member>
  1676. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillBackgroundColorColor">
  1677. Get the background fill color.
  1678. <p>
  1679. Note - many cells are actually Filled with a foreground
  1680. Fill, not a background fill - see {@link #getFillForegroundColor()}
  1681. </p>
  1682. @see NPOI.xssf.usermodel.XSSFColor#getRgb()
  1683. @return XSSFColor - fill color or <code>null</code> if not Set
  1684. </member>
  1685. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillForegroundColor">
  1686. Get the foreground fill color.
  1687. <p>
  1688. Many cells are Filled with this, instead of a
  1689. background color ({@link #getFillBackgroundColor()})
  1690. </p>
  1691. @see IndexedColors
  1692. @return fill color, default value is {@link NPOI.ss.usermodel.IndexedColors#AUTOMATIC}
  1693. </member>
  1694. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillForegroundColorColor">
  1695. <summary>
  1696. Get the foreground fill color.
  1697. </summary>
  1698. </member>
  1699. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillForegroundXSSFColor">
  1700. <summary>
  1701. Get the foreground fill color.
  1702. </summary>
  1703. </member>
  1704. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FontIndex">
  1705. Gets the index of the font for this style
  1706. @return short - font index
  1707. @see NPOI.xssf.usermodel.XSSFWorkbook#getFontAt(short)
  1708. </member>
  1709. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.IsHidden">
  1710. Get whether the cell's using this style are to be hidden
  1711. @return bool - whether the cell using this style is hidden
  1712. </member>
  1713. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.Indention">
  1714. Get the number of spaces to indent the text in the cell
  1715. @return indent - number of spaces
  1716. </member>
  1717. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.Index">
  1718. Get the index within the StylesTable (sequence within the collection of CT_Xf elements)
  1719. @return unique index number of the underlying record this style represents
  1720. </member>
  1721. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.LeftBorderColor">
  1722. Get the color to use for the left border
  1723. @return the index of the color defInition, default value is {@link NPOI.ss.usermodel.IndexedColors#BLACK}
  1724. @see NPOI.ss.usermodel.IndexedColors
  1725. </member>
  1726. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.LeftBorderXSSFColor">
  1727. Get the color to use for the left border
  1728. @return the index of the color defInition or <code>null</code> if not Set
  1729. @see NPOI.ss.usermodel.IndexedColors
  1730. </member>
  1731. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.IsLocked">
  1732. <summary>
  1733. Get whether the cell's using this style are locked
  1734. </summary>
  1735. </member>
  1736. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.RightBorderColor">
  1737. <summary>
  1738. Get the color to use for the right border
  1739. </summary>
  1740. </member>
  1741. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.RightBorderXSSFColor">
  1742. <summary>
  1743. Get the color to use for the right border
  1744. </summary>
  1745. <returns></returns>
  1746. </member>
  1747. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.Rotation">
  1748. <summary>
  1749. Get the degree of rotation (between 0 and 180 degrees) for the text in the cell
  1750. </summary>
  1751. <example>
  1752. Expressed in degrees. Values range from 0 to 180. The first letter of
  1753. the text is considered the center-point of the arc.
  1754. For 0 - 90, the value represents degrees above horizon. For 91-180 the degrees below the horizon is calculated as:
  1755. <code>[degrees below horizon] = 90 - textRotation.</code>
  1756. </example>
  1757. </member>
  1758. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.TopBorderColor">
  1759. Get the color to use for the top border
  1760. @return the index of the color defInition, default value is {@link NPOI.ss.usermodel.IndexedColors#BLACK}
  1761. @see NPOI.ss.usermodel.IndexedColors
  1762. </member>
  1763. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.TopBorderXSSFColor">
  1764. <summary>
  1765. Get the color to use for the top border
  1766. </summary>
  1767. <returns></returns>
  1768. </member>
  1769. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.VerticalAlignment">
  1770. <summary>
  1771. Get the type of vertical alignment for the cell
  1772. </summary>
  1773. </member>
  1774. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.WrapText">
  1775. <summary>
  1776. Whether the text in a cell should be line-wrapped within the cell.
  1777. </summary>
  1778. </member>
  1779. <member name="T:NPOI.XSSF.UserModel.XSSFChart">
  1780. Represents a SpreadsheetML Chart
  1781. @author Nick Burch
  1782. @author Roman Kashitsyn
  1783. </member>
  1784. <member name="F:NPOI.XSSF.UserModel.XSSFChart.frame">
  1785. Parent graphic frame.
  1786. </member>
  1787. <member name="F:NPOI.XSSF.UserModel.XSSFChart.chartSpaceDocument">
  1788. Root element of the SpreadsheetML Chart part
  1789. </member>
  1790. <member name="F:NPOI.XSSF.UserModel.XSSFChart.chart">
  1791. The Chart within that
  1792. </member>
  1793. <member name="M:NPOI.XSSF.UserModel.XSSFChart.#ctor">
  1794. Create a new SpreadsheetML chart
  1795. </member>
  1796. <member name="M:NPOI.XSSF.UserModel.XSSFChart.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  1797. Construct a SpreadsheetML chart from a namespace part.
  1798. @param part the namespace part holding the chart data,
  1799. the content type must be <code>application/vnd.Openxmlformats-officedocument.Drawingml.chart+xml</code>
  1800. @param rel the namespace relationship holding this chart,
  1801. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/chart
  1802. </member>
  1803. <member name="M:NPOI.XSSF.UserModel.XSSFChart.CreateChart">
  1804. Construct a new CTChartSpace bean.
  1805. By default, it's just an empty placeholder for chart objects.
  1806. @return a new CTChartSpace bean
  1807. </member>
  1808. <member name="M:NPOI.XSSF.UserModel.XSSFChart.GetCTChartSpace">
  1809. Return the underlying CTChartSpace bean, the root element of the SpreadsheetML Chart part.
  1810. @return the underlying CTChartSpace bean
  1811. </member>
  1812. <member name="M:NPOI.XSSF.UserModel.XSSFChart.GetCTChart">
  1813. Return the underlying CTChart bean, within the Chart Space
  1814. @return the underlying CTChart bean
  1815. </member>
  1816. <member name="M:NPOI.XSSF.UserModel.XSSFChart.GetGraphicFrame">
  1817. Returns the parent graphic frame.
  1818. @return the graphic frame this chart belongs to
  1819. </member>
  1820. <member name="M:NPOI.XSSF.UserModel.XSSFChart.SetGraphicFrame(NPOI.XSSF.UserModel.XSSFGraphicFrame)">
  1821. Sets the parent graphic frame.
  1822. </member>
  1823. <member name="M:NPOI.XSSF.UserModel.XSSFChart.IsPlotOnlyVisibleCells">
  1824. @return true if only visible cells will be present on the chart,
  1825. false otherwise
  1826. </member>
  1827. <member name="M:NPOI.XSSF.UserModel.XSSFChart.SetPlotOnlyVisibleCells(System.Boolean)">
  1828. @param plotVisOnly a flag specifying if only visible cells should be
  1829. present on the chart
  1830. </member>
  1831. <member name="P:NPOI.XSSF.UserModel.XSSFChart.Title">
  1832. Returns the title, or null if none is Set
  1833. </member>
  1834. <member name="T:NPOI.XSSF.UserModel.XSSFChartSheet">
  1835. High level representation of Sheet Parts that are of type 'chartsheet'.
  1836. <p>
  1837. Chart sheet is a special kind of Sheet that Contains only chart and no data.
  1838. </p>
  1839. @author Yegor Kozlov
  1840. </member>
  1841. <member name="T:NPOI.XSSF.UserModel.XSSFSheet">
  1842. High level representation of a SpreadsheetML worksheet.
  1843. <p>
  1844. Sheets are the central structures within a workbook, and are where a user does most of his spreadsheet work.
  1845. The most common type of sheet is the worksheet, which is represented as a grid of cells. Worksheet cells can
  1846. contain text, numbers, dates, and formulas. Cells can also be formatted.
  1847. </p>
  1848. </member>
  1849. <member name="F:NPOI.XSSF.UserModel.XSSFSheet.sharedFormulas">
  1850. cache of master shared formulas in this sheet.
  1851. Master shared formula is the first formula in a group of shared formulas is saved in the f element.
  1852. </member>
  1853. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.#ctor">
  1854. Creates new XSSFSheet - called by XSSFWorkbook to create a sheet from scratch.
  1855. @see NPOI.XSSF.usermodel.XSSFWorkbook#CreateSheet()
  1856. </member>
  1857. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  1858. Creates an XSSFSheet representing the given namespace part and relationship.
  1859. Should only be called by XSSFWorkbook when Reading in an exisiting file.
  1860. @param part - The namespace part that holds xml data represenring this sheet.
  1861. @param rel - the relationship of the given namespace part in the underlying OPC namespace
  1862. </member>
  1863. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.OnDocumentRead">
  1864. Initialize worksheet data when Reading in an exisiting file.
  1865. </member>
  1866. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.OnDocumentCreate">
  1867. Initialize worksheet data when creating a new sheet.
  1868. </member>
  1869. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.InitHyperlinks">
  1870. Read hyperlink relations, link them with CT_Hyperlink beans in this worksheet
  1871. and Initialize the internal array of XSSFHyperlink objects
  1872. </member>
  1873. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.NewSheet">
  1874. Create a new CT_Worksheet instance with all values set to defaults
  1875. @return a new instance
  1876. </member>
  1877. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCTWorksheet">
  1878. Provide access to the CT_Worksheet bean holding this sheet's data
  1879. @return the CT_Worksheet bean holding this sheet's data
  1880. </member>
  1881. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  1882. Adds a merged region of cells (hence those cells form one).
  1883. @param region (rowfrom/colfrom-rowto/colto) to merge
  1884. @return index of this region
  1885. </member>
  1886. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AutoSizeColumn(System.Int32)">
  1887. Adjusts the column width to fit the contents.
  1888. This process can be relatively slow on large sheets, so this should
  1889. normally only be called once per column, at the end of your
  1890. Processing.
  1891. @param column the column index
  1892. </member>
  1893. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AutoSizeColumn(System.Int32,System.Boolean)">
  1894. Adjusts the column width to fit the contents.
  1895. <p>
  1896. This process can be relatively slow on large sheets, so this should
  1897. normally only be called once per column, at the end of your
  1898. Processing.
  1899. </p>
  1900. You can specify whether the content of merged cells should be considered or ignored.
  1901. Default is to ignore merged cells.
  1902. @param column the column index
  1903. @param useMergedCells whether to use the contents of merged cells when calculating the width of the column
  1904. </member>
  1905. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateDrawingPatriarch">
  1906. Create a new SpreadsheetML drawing. If this sheet already Contains a drawing - return that.
  1907. @return a SpreadsheetML drawing
  1908. </member>
  1909. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetVMLDrawing(System.Boolean)">
  1910. Get VML drawing for this sheet (aka 'legacy' drawig)
  1911. @param autoCreate if true, then a new VML drawing part is Created
  1912. @return the VML drawing of <code>null</code> if the drawing was not found and autoCreate=false
  1913. </member>
  1914. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateFreezePane(System.Int32,System.Int32)">
  1915. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  1916. @param colSplit Horizonatal position of split.
  1917. @param rowSplit Vertical position of split.
  1918. </member>
  1919. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateFreezePane(System.Int32,System.Int32,System.Int32,System.Int32)">
  1920. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  1921. <p>
  1922. If both colSplit and rowSplit are zero then the existing freeze pane is Removed
  1923. </p>
  1924. @param colSplit Horizonatal position of split.
  1925. @param rowSplit Vertical position of split.
  1926. @param leftmostColumn Left column visible in right pane.
  1927. @param topRow Top row visible in bottom pane
  1928. </member>
  1929. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateComment">
  1930. Creates a new comment for this sheet. You still
  1931. need to assign it to a cell though
  1932. @deprecated since Nov 2009 this method is not compatible with the common SS interfaces,
  1933. use {@link NPOI.XSSF.usermodel.XSSFDrawing#CreateCellComment
  1934. (NPOI.SS.usermodel.ClientAnchor)} instead
  1935. </member>
  1936. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateRow(System.Int32)">
  1937. Create a new row within the sheet and return the high level representation
  1938. @param rownum row number
  1939. @return High level {@link XSSFRow} object representing a row in the sheet
  1940. @see #RemoveRow(NPOI.SS.usermodel.Row)
  1941. </member>
  1942. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateSplitPane(System.Int32,System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  1943. Creates a split pane. Any existing freezepane or split pane is overwritten.
  1944. @param xSplitPos Horizonatal position of split (in 1/20th of a point).
  1945. @param ySplitPos Vertical position of split (in 1/20th of a point).
  1946. @param topRow Top row visible in bottom pane
  1947. @param leftmostColumn Left column visible in right pane.
  1948. @param activePane Active pane. One of: PANE_LOWER_RIGHT,
  1949. PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT
  1950. @see NPOI.SS.usermodel.Sheet#PANE_LOWER_LEFT
  1951. @see NPOI.SS.usermodel.Sheet#PANE_LOWER_RIGHT
  1952. @see NPOI.SS.usermodel.Sheet#PANE_UPPER_LEFT
  1953. @see NPOI.SS.usermodel.Sheet#PANE_UPPER_RIGHT
  1954. </member>
  1955. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetColumnWidth(System.Int32)">
  1956. Get the actual column width (in units of 1/256th of a character width )
  1957. <p>
  1958. Note, the returned value is always gerater that {@link #GetDefaultColumnWidth()} because the latter does not include margins.
  1959. Actual column width measured as the number of characters of the maximum digit width of the
  1960. numbers 0, 1, 2, ..., 9 as rendered in the normal style's font. There are 4 pixels of margin
  1961. pAdding (two on each side), plus 1 pixel pAdding for the gridlines.
  1962. </p>
  1963. @param columnIndex - the column to set (0-based)
  1964. @return width - the width in units of 1/256th of a character width
  1965. </member>
  1966. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetColumnStyle(System.Int32)">
  1967. Returns the CellStyle that applies to the given
  1968. (0 based) column, or null if no style has been
  1969. set for that column
  1970. </member>
  1971. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetMargin(NPOI.SS.UserModel.MarginType)">
  1972. Gets the size of the margin in inches.
  1973. @param margin which margin to get
  1974. @return the size of the margin
  1975. @see Sheet#LeftMargin
  1976. @see Sheet#RightMargin
  1977. @see Sheet#TopMargin
  1978. @see Sheet#BottomMargin
  1979. @see Sheet#HeaderMargin
  1980. @see Sheet#FooterMargin
  1981. </member>
  1982. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  1983. Sets the size of the margin in inches.
  1984. @param margin which margin to get
  1985. @param size the size of the margin
  1986. @see Sheet#LeftMargin
  1987. @see Sheet#RightMargin
  1988. @see Sheet#TopMargin
  1989. @see Sheet#BottomMargin
  1990. @see Sheet#HeaderMargin
  1991. @see Sheet#FooterMargin
  1992. </member>
  1993. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetMergedRegion(System.Int32)">
  1994. @return the merged region at the specified index
  1995. @throws InvalidOperationException if this worksheet does not contain merged regions
  1996. </member>
  1997. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ProtectSheet(System.String)">
  1998. Enables sheet protection and Sets the password for the sheet.
  1999. Also Sets some attributes on the {@link CT_SheetProtection} that correspond to
  2000. the default values used by Excel
  2001. @param password to set for protection. Pass <code>null</code> to remove protection
  2002. </member>
  2003. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.StringToExcelPassword(System.String)">
  2004. Converts a String to a {@link STUnsignedshortHex} value that Contains the {@link PasswordRecord#hashPassword(String)}
  2005. value in hexadecimal format
  2006. @param password the password string you wish convert to an {@link STUnsignedshortHex}
  2007. @return {@link STUnsignedshortHex} that Contains Excel hashed password in Hex format
  2008. </member>
  2009. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetRow(System.Int32)">
  2010. Returns the logical row ( 0-based). If you ask for a row that is not
  2011. defined you get a null. This is to say row 4 represents the fifth row on a sheet.
  2012. @param rownum row to get
  2013. @return <code>XSSFRow</code> representing the rownumber or <code>null</code> if its not defined on the sheet
  2014. </member>
  2015. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ensureOutlinePr">
  2016. Ensure CT_Worksheet.CT_SheetPr.CT_OutlinePr
  2017. </member>
  2018. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GroupColumn(System.Int32,System.Int32)">
  2019. Group between (0 based) columns
  2020. </member>
  2021. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GroupRow(System.Int32,System.Int32)">
  2022. Tie a range of cell toGether so that they can be collapsed or expanded
  2023. @param fromRow start row (0-based)
  2024. @param toRow end row (0-based)
  2025. </member>
  2026. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsColumnBroken(System.Int32)">
  2027. Determines if there is a page break at the indicated column
  2028. </member>
  2029. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsColumnHidden(System.Int32)">
  2030. Get the hidden state for a given column.
  2031. @param columnIndex - the column to set (0-based)
  2032. @return hidden - <code>false</code> if the column is visible
  2033. </member>
  2034. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsRowBroken(System.Int32)">
  2035. Tests if there is a page break at the indicated row
  2036. @param row index of the row to test
  2037. @return <code>true</code> if there is a page break at the indicated row
  2038. </member>
  2039. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetRowBreak(System.Int32)">
  2040. Sets a page break at the indicated row
  2041. Breaks occur above the specified row and left of the specified column inclusive.
  2042. For example, <code>sheet.SetColumnBreak(2);</code> breaks the sheet into two parts
  2043. with columns A,B,C in the first and D,E,... in the second. Simuilar, <code>sheet.SetRowBreak(2);</code>
  2044. breaks the sheet into two parts with first three rows (rownum=1...3) in the first part
  2045. and rows starting with rownum=4 in the second.
  2046. @param row the row to break, inclusive
  2047. </member>
  2048. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveColumnBreak(System.Int32)">
  2049. Removes a page break at the indicated column
  2050. </member>
  2051. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveMergedRegion(System.Int32)">
  2052. Removes a merged region of cells (hence letting them free)
  2053. @param index of the region to unmerge
  2054. </member>
  2055. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveRow(NPOI.SS.UserModel.IRow)">
  2056. Remove a row from this sheet. All cells Contained in the row are Removed as well
  2057. @param row the row to Remove.
  2058. </member>
  2059. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveRowBreak(System.Int32)">
  2060. Removes the page break at the indicated row
  2061. </member>
  2062. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetColumnBreak(System.Int32)">
  2063. Sets a page break at the indicated column.
  2064. Breaks occur above the specified row and left of the specified column inclusive.
  2065. For example, <code>sheet.SetColumnBreak(2);</code> breaks the sheet into two parts
  2066. with columns A,B,C in the first and D,E,... in the second. Simuilar, <code>sheet.SetRowBreak(2);</code>
  2067. breaks the sheet into two parts with first three rows (rownum=1...3) in the first part
  2068. and rows starting with rownum=4 in the second.
  2069. @param column the column to break, inclusive
  2070. </member>
  2071. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetGroupHidden(System.Int32,System.Int32,System.Boolean)">
  2072. Sets all adjacent columns of the same outline level to the specified
  2073. hidden status.
  2074. @param pIdx
  2075. the col info index of the start of the outline group
  2076. @return the column index of the last column in the outline group
  2077. </member>
  2078. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsColumnGroupCollapsed(System.Int32)">
  2079. 'Collapsed' state is stored in a single column col info record
  2080. immediately after the outline group
  2081. @param idx
  2082. @return a bool represented if the column is collapsed
  2083. </member>
  2084. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetColumnHidden(System.Int32,System.Boolean)">
  2085. Get the visibility state for a given column.
  2086. @param columnIndex - the column to get (0-based)
  2087. @param hidden - the visiblity state of the column
  2088. </member>
  2089. <!-- 对于成员“M:NPOI.XSSF.UserModel.XSSFSheet.SetColumnWidth(System.Int32,System.Int32)”忽略有格式错误的 XML 注释 -->
  2090. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetRowGroupCollapsed(System.Int32,System.Boolean)">
  2091. group the row It is possible for collapsed to be false and yet still have
  2092. the rows in question hidden. This can be achieved by having a lower
  2093. outline level collapsed, thus hiding all the child rows. Note that in
  2094. this case, if the lowest level were expanded, the middle level would
  2095. remain collapsed.
  2096. @param rowIndex -
  2097. the row involved, 0 based
  2098. @param collapse -
  2099. bool value for collapse
  2100. </member>
  2101. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CollapseRow(System.Int32)">
  2102. @param rowIndex the zero based row index to collapse
  2103. </member>
  2104. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.FindStartOfRowOutlineGroup(System.Int32)">
  2105. @param rowIndex the zero based row index to find from
  2106. </member>
  2107. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ExpandRow(System.Int32)">
  2108. @param rowNumber the zero based row index to expand
  2109. </member>
  2110. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.FindEndOfRowOutlineGroup(System.Int32)">
  2111. @param row the zero based row index to find from
  2112. </member>
  2113. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsRowGroupHiddenByParent(System.Int32)">
  2114. @param row the zero based row index to find from
  2115. </member>
  2116. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsRowGroupCollapsed(System.Int32)">
  2117. @param row the zero based row index to find from
  2118. </member>
  2119. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetZoom(System.Int32,System.Int32)">
  2120. Sets the zoom magnication for the sheet. The zoom is expressed as a
  2121. fraction. For example to express a zoom of 75% use 3 for the numerator
  2122. and 4 for the denominator.
  2123. @param numerator The numerator for the zoom magnification.
  2124. @param denominator The denominator for the zoom magnification.
  2125. @see #SetZoom(int)
  2126. </member>
  2127. <!-- 对于成员“M:NPOI.XSSF.UserModel.XSSFSheet.SetZoom(System.Int32)”忽略有格式错误的 XML 注释 -->
  2128. <!-- 对于成员“M:NPOI.XSSF.UserModel.XSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32)”忽略有格式错误的 XML 注释 -->
  2129. <!-- 对于成员“M:NPOI.XSSF.UserModel.XSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean)”忽略有格式错误的 XML 注释 -->
  2130. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ShowInPane(System.Int16,System.Int16)">
  2131. Location of the top left visible cell Location of the top left visible cell in the bottom right
  2132. pane (when in Left-to-Right mode).
  2133. @param toprow the top row to show in desktop window pane
  2134. @param leftcol the left column to show in desktop window pane
  2135. </member>
  2136. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.UngroupRow(System.Int32,System.Int32)">
  2137. Ungroup a range of rows that were previously groupped
  2138. @param fromRow start row (0-based)
  2139. @param toRow end row (0-based)
  2140. </member>
  2141. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetCellComment(System.String,NPOI.XSSF.UserModel.XSSFComment)">
  2142. Assign a cell comment to a cell region in this worksheet
  2143. @param cellRef cell region
  2144. @param comment the comment to assign
  2145. @deprecated since Nov 2009 use {@link XSSFCell#SetCellComment(NPOI.SS.usermodel.Comment)} instead
  2146. </member>
  2147. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddHyperlink(NPOI.XSSF.UserModel.XSSFHyperlink)">
  2148. Register a hyperlink in the collection of hyperlinks on this sheet
  2149. @param hyperlink the link to add
  2150. </member>
  2151. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetDefaultSheetView">
  2152. Return the default sheet view. This is the last one if the sheet's views, according to sec. 3.3.1.83
  2153. of the OOXML spec: "A single sheet view defInition. When more than 1 sheet view is defined in the file,
  2154. it means that when opening the workbook, each sheet view corresponds to a separate window within the
  2155. spreadsheet application, where each window is Showing the particular sheet. Containing the same
  2156. workbookViewId value, the last sheetView defInition is loaded, and the others are discarded.
  2157. When multiple windows are viewing the same sheet, multiple sheetView elements (with corresponding
  2158. workbookView entries) are saved."
  2159. </member>
  2160. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCommentsTable(System.Boolean)">
  2161. Returns the sheet's comments object if there is one,
  2162. or null if not
  2163. @param create create a new comments table if it does not exist
  2164. </member>
  2165. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetSharedFormula(System.Int32)">
  2166. Return a master shared formula by index
  2167. @param sid shared group index
  2168. @return a CT_CellFormula bean holding shared formula or <code>null</code> if not found
  2169. </member>
  2170. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.EnableLocking">
  2171. Enable sheet protection
  2172. </member>
  2173. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.DisableLocking">
  2174. Disable sheet protection
  2175. </member>
  2176. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockAutoFilter">
  2177. Enable Autofilters locking.
  2178. This does not modify sheet protection status.
  2179. To enforce this locking, call {@link #enableLocking()}
  2180. </member>
  2181. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockDeleteColumns">
  2182. Enable Deleting columns locking.
  2183. This does not modify sheet protection status.
  2184. To enforce this locking, call {@link #enableLocking()}
  2185. </member>
  2186. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockDeleteRows">
  2187. Enable Deleting rows locking.
  2188. This does not modify sheet protection status.
  2189. To enforce this locking, call {@link #enableLocking()}
  2190. </member>
  2191. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockFormatCells">
  2192. Enable Formatting cells locking.
  2193. This does not modify sheet protection status.
  2194. To enforce this locking, call {@link #enableLocking()}
  2195. </member>
  2196. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockFormatColumns">
  2197. Enable Formatting columns locking.
  2198. This does not modify sheet protection status.
  2199. To enforce this locking, call {@link #enableLocking()}
  2200. </member>
  2201. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockFormatRows">
  2202. Enable Formatting rows locking.
  2203. This does not modify sheet protection status.
  2204. To enforce this locking, call {@link #enableLocking()}
  2205. </member>
  2206. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockInsertColumns">
  2207. Enable Inserting columns locking.
  2208. This does not modify sheet protection status.
  2209. To enforce this locking, call {@link #enableLocking()}
  2210. </member>
  2211. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockInsertHyperlinks">
  2212. Enable Inserting hyperlinks locking.
  2213. This does not modify sheet protection status.
  2214. To enforce this locking, call {@link #enableLocking()}
  2215. </member>
  2216. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockInsertRows">
  2217. Enable Inserting rows locking.
  2218. This does not modify sheet protection status.
  2219. To enforce this locking, call {@link #enableLocking()}
  2220. </member>
  2221. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockPivotTables">
  2222. Enable Pivot Tables locking.
  2223. This does not modify sheet protection status.
  2224. To enforce this locking, call {@link #enableLocking()}
  2225. </member>
  2226. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockSort">
  2227. Enable Sort locking.
  2228. This does not modify sheet protection status.
  2229. To enforce this locking, call {@link #enableLocking()}
  2230. </member>
  2231. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockObjects">
  2232. Enable Objects locking.
  2233. This does not modify sheet protection status.
  2234. To enforce this locking, call {@link #enableLocking()}
  2235. </member>
  2236. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockScenarios">
  2237. Enable Scenarios locking.
  2238. This does not modify sheet protection status.
  2239. To enforce this locking, call {@link #enableLocking()}
  2240. </member>
  2241. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockSelectLockedCells">
  2242. Enable Selection of locked cells locking.
  2243. This does not modify sheet protection status.
  2244. To enforce this locking, call {@link #enableLocking()}
  2245. </member>
  2246. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockSelectUnlockedCells">
  2247. Enable Selection of unlocked cells locking.
  2248. This does not modify sheet protection status.
  2249. To enforce this locking, call {@link #enableLocking()}
  2250. </member>
  2251. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCellRange(NPOI.SS.Util.CellRangeAddress)">
  2252. Also Creates cells if they don't exist
  2253. </member>
  2254. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateTable">
  2255. Creates a new Table, and associates it with this Sheet
  2256. </member>
  2257. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetTables">
  2258. Returns any tables associated with this Sheet
  2259. </member>
  2260. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetTabColor(System.Int32)">
  2261. Set background color of the sheet tab
  2262. @param colorIndex the indexed color to set, must be a constant from {@link IndexedColors}
  2263. </member>
  2264. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Workbook">
  2265. Returns the parent XSSFWorkbook
  2266. @return the parent XSSFWorkbook
  2267. </member>
  2268. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.SheetName">
  2269. Returns the name of this sheet
  2270. @return the name of this sheet
  2271. </member>
  2272. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ColumnBreaks">
  2273. Vertical page break information used for print layout view, page layout view, drawing print breaks
  2274. in normal view, and for printing the worksheet.
  2275. @return column indexes of all the vertical page breaks, never <code>null</code>
  2276. </member>
  2277. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DefaultColumnWidth">
  2278. Get the default column width for the sheet (if the columns do not define their own width) in
  2279. characters.
  2280. <p>
  2281. Note, this value is different from {@link #GetColumnWidth(int)}. The latter is always greater and includes
  2282. 4 pixels of margin pAdding (two on each side), plus 1 pixel pAdding for the gridlines.
  2283. </p>
  2284. @return column width, default value is 8
  2285. </member>
  2286. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DefaultRowHeight">
  2287. Get the default row height for the sheet (if the rows do not define their own height) in
  2288. twips (1/20 of a point)
  2289. @return default row height
  2290. </member>
  2291. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DefaultRowHeightInPoints">
  2292. Get the default row height for the sheet measued in point size (if the rows do not define their own height).
  2293. @return default row height in points
  2294. </member>
  2295. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RightToLeft">
  2296. Whether the text is displayed in right-to-left mode in the window
  2297. @return whether the text is displayed in right-to-left mode in the window
  2298. </member>
  2299. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayGuts">
  2300. Get whether to display the guts or not,
  2301. default value is true
  2302. @return bool - guts or no guts
  2303. </member>
  2304. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayZeros">
  2305. Gets the flag indicating whether the window should show 0 (zero) in cells Containing zero value.
  2306. When false, cells with zero value appear blank instead of Showing the number zero.
  2307. @return whether all zero values on the worksheet are displayed
  2308. </member>
  2309. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FirstRowNum">
  2310. Gets the first row on the sheet
  2311. @return the number of the first logical row on the sheet, zero based
  2312. </member>
  2313. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FitToPage">
  2314. Flag indicating whether the Fit to Page print option is enabled.
  2315. @return <code>true</code>
  2316. </member>
  2317. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Footer">
  2318. Returns the default footer for the sheet,
  2319. creating one as needed.
  2320. You may also want to look at
  2321. {@link #GetFirstFooter()},
  2322. {@link #GetOddFooter()} and
  2323. {@link #GetEvenFooter()}
  2324. </member>
  2325. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Header">
  2326. Returns the default header for the sheet,
  2327. creating one as needed.
  2328. You may also want to look at
  2329. {@link #GetFirstHeader()},
  2330. {@link #GetOddHeader()} and
  2331. {@link #GetEvenHeader()}
  2332. </member>
  2333. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.OddFooter">
  2334. Returns the odd footer. Used on all pages unless
  2335. other footers also present, when used on only
  2336. odd pages.
  2337. </member>
  2338. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.EvenFooter">
  2339. Returns the even footer. Not there by default, but
  2340. when Set, used on even pages.
  2341. </member>
  2342. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FirstFooter">
  2343. Returns the first page footer. Not there by
  2344. default, but when Set, used on the first page.
  2345. </member>
  2346. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.OddHeader">
  2347. Returns the odd header. Used on all pages unless
  2348. other headers also present, when used on only
  2349. odd pages.
  2350. </member>
  2351. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.EvenHeader">
  2352. Returns the even header. Not there by default, but
  2353. when Set, used on even pages.
  2354. </member>
  2355. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FirstHeader">
  2356. Returns the first page header. Not there by
  2357. default, but when Set, used on the first page.
  2358. </member>
  2359. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.HorizontallyCenter">
  2360. Determine whether printed output for this sheet will be horizontally centered.
  2361. </member>
  2362. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.NumMergedRegions">
  2363. Returns the number of merged regions defined in this worksheet
  2364. @return number of merged regions in this worksheet
  2365. </member>
  2366. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.PaneInformation">
  2367. Returns the information regarding the currently configured pane (split or freeze).
  2368. @return null if no pane configured, or the pane information.
  2369. </member>
  2370. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.PhysicalNumberOfRows">
  2371. Returns the number of phsyically defined rows (NOT the number of rows in the sheet)
  2372. @return the number of phsyically defined rows
  2373. </member>
  2374. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.PrintSetup">
  2375. Gets the print Setup object.
  2376. @return The user model for the print Setup object.
  2377. </member>
  2378. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Protect">
  2379. Answer whether protection is enabled or disabled
  2380. @return true => protection enabled; false => protection disabled
  2381. </member>
  2382. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RowBreaks">
  2383. Horizontal page break information used for print layout view, page layout view, drawing print breaks in normal
  2384. view, and for printing the worksheet.
  2385. @return row indexes of all the horizontal page breaks, never <code>null</code>
  2386. </member>
  2387. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RowSumsBelow">
  2388. Flag indicating whether summary rows appear below detail in an outline, when Applying an outline.
  2389. <p>
  2390. When true a summary row is inserted below the detailed data being summarized and a
  2391. new outline level is established on that row.
  2392. </p>
  2393. <p>
  2394. When false a summary row is inserted above the detailed data being summarized and a new outline level
  2395. is established on that row.
  2396. </p>
  2397. @return <code>true</code> if row summaries appear below detail in the outline
  2398. </member>
  2399. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RowSumsRight">
  2400. Flag indicating whether summary columns appear to the right of detail in an outline, when Applying an outline.
  2401. <p>
  2402. When true a summary column is inserted to the right of the detailed data being summarized
  2403. and a new outline level is established on that column.
  2404. </p>
  2405. <p>
  2406. When false a summary column is inserted to the left of the detailed data being
  2407. summarized and a new outline level is established on that column.
  2408. </p>
  2409. @return <code>true</code> if col summaries appear right of the detail in the outline
  2410. </member>
  2411. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ScenarioProtect">
  2412. <summary>
  2413. A flag indicating whether scenarios are locked when the sheet is protected.
  2414. </summary>
  2415. </member>
  2416. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.TopRow">
  2417. <summary>
  2418. The top row in the visible view when the sheet is first viewed after opening it in a viewer
  2419. </summary>
  2420. </member>
  2421. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.VerticallyCenter">
  2422. Determine whether printed output for this sheet will be vertically centered.
  2423. @return whether printed output for this sheet will be vertically centered.
  2424. </member>
  2425. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayFormulas">
  2426. Gets the flag indicating whether this sheet should display formulas.
  2427. @return <code>true</code> if this sheet should display formulas.
  2428. </member>
  2429. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayGridlines">
  2430. Gets the flag indicating whether this sheet displays the lines
  2431. between rows and columns to make editing and Reading easier.
  2432. @return <code>true</code> if this sheet displays gridlines.
  2433. @see #isPrintGridlines() to check if printing of gridlines is turned on or off
  2434. </member>
  2435. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayRowColHeadings">
  2436. Gets the flag indicating whether this sheet should display row and column headings.
  2437. <p>
  2438. Row heading are the row numbers to the side of the sheet
  2439. </p>
  2440. <p>
  2441. Column heading are the letters or numbers that appear above the columns of the sheet
  2442. </p>
  2443. @return <code>true</code> if this sheet should display row and column headings.
  2444. </member>
  2445. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsPrintGridlines">
  2446. Returns whether gridlines are printed.
  2447. @return whether gridlines are printed
  2448. </member>
  2449. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ForceFormulaRecalculation">
  2450. Whether Excel will be asked to recalculate all formulas when the
  2451. workbook is opened.
  2452. </member>
  2453. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Autobreaks">
  2454. Flag indicating whether the sheet displays Automatic Page Breaks.
  2455. @return <code>true</code> if the sheet displays Automatic Page Breaks.
  2456. </member>
  2457. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSelected">
  2458. Returns a flag indicating whether this sheet is selected.
  2459. <p>
  2460. When only 1 sheet is selected and active, this value should be in synch with the activeTab value.
  2461. In case of a conflict, the Start Part Setting wins and Sets the active sheet tab.
  2462. </p>
  2463. Note: multiple sheets can be selected, but only one sheet can be active at one time.
  2464. @return <code>true</code> if this sheet is selected
  2465. </member>
  2466. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ActiveCell">
  2467. Return location of the active cell, e.g. <code>A1</code>.
  2468. @return the location of the active cell.
  2469. </member>
  2470. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.HasComments">
  2471. Does this sheet have any comments on it? We need to know,
  2472. so we can decide about writing it to disk or not
  2473. </member>
  2474. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsAutoFilterLocked">
  2475. @return true when Autofilters are locked and the sheet is protected.
  2476. </member>
  2477. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsDeleteColumnsLocked">
  2478. @return true when Deleting columns is locked and the sheet is protected.
  2479. </member>
  2480. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsDeleteRowsLocked">
  2481. @return true when Deleting rows is locked and the sheet is protected.
  2482. </member>
  2483. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsFormatCellsLocked">
  2484. @return true when Formatting cells is locked and the sheet is protected.
  2485. </member>
  2486. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsFormatColumnsLocked">
  2487. @return true when Formatting columns is locked and the sheet is protected.
  2488. </member>
  2489. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsFormatRowsLocked">
  2490. @return true when Formatting rows is locked and the sheet is protected.
  2491. </member>
  2492. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsInsertColumnsLocked">
  2493. @return true when Inserting columns is locked and the sheet is protected.
  2494. </member>
  2495. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsInsertHyperlinksLocked">
  2496. @return true when Inserting hyperlinks is locked and the sheet is protected.
  2497. </member>
  2498. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsInsertRowsLocked">
  2499. @return true when Inserting rows is locked and the sheet is protected.
  2500. </member>
  2501. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsPivotTablesLocked">
  2502. @return true when Pivot tables are locked and the sheet is protected.
  2503. </member>
  2504. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSortLocked">
  2505. @return true when Sorting is locked and the sheet is protected.
  2506. </member>
  2507. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsObjectsLocked">
  2508. @return true when Objects are locked and the sheet is protected.
  2509. </member>
  2510. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsScenariosLocked">
  2511. @return true when Scenarios are locked and the sheet is protected.
  2512. </member>
  2513. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSelectLockedCellsLocked">
  2514. @return true when Selection of locked cells is locked and the sheet is protected.
  2515. </member>
  2516. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSelectUnlockedCellsLocked">
  2517. @return true when Selection of unlocked cells is locked and the sheet is protected.
  2518. </member>
  2519. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSheetLocked">
  2520. @return true when Sheet is Protected.
  2521. </member>
  2522. <member name="M:NPOI.XSSF.UserModel.XSSFChartSheet.GetCTChartsheet">
  2523. Provide access to the CTChartsheet bean holding this sheet's data
  2524. @return the CTChartsheet bean holding this sheet's data
  2525. </member>
  2526. <member name="T:NPOI.XSSF.UserModel.XSSFChildAnchor">
  2527. @author Yegor Kozlov
  2528. </member>
  2529. <member name="T:NPOI.XSSF.UserModel.XSSFClientAnchor">
  2530. A client anchor is attached to an excel worksheet. It anchors against
  2531. top-left and bottom-right cells.
  2532. @author Yegor Kozlov
  2533. </member>
  2534. <member name="F:NPOI.XSSF.UserModel.XSSFClientAnchor.cell1">
  2535. Starting anchor point
  2536. </member>
  2537. <member name="F:NPOI.XSSF.UserModel.XSSFClientAnchor.cell2">
  2538. Ending anchor point
  2539. </member>
  2540. <member name="M:NPOI.XSSF.UserModel.XSSFClientAnchor.#ctor">
  2541. Creates a new client anchor and defaults all the anchor positions to 0.
  2542. </member>
  2543. <member name="M:NPOI.XSSF.UserModel.XSSFClientAnchor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  2544. Creates a new client anchor and Sets the top-left and bottom-right
  2545. coordinates of the anchor.
  2546. @param dx1 the x coordinate within the first cell.
  2547. @param dy1 the y coordinate within the first cell.
  2548. @param dx2 the x coordinate within the second cell.
  2549. @param dy2 the y coordinate within the second cell.
  2550. @param col1 the column (0 based) of the first cell.
  2551. @param row1 the row (0 based) of the first cell.
  2552. @param col2 the column (0 based) of the second cell.
  2553. @param row2 the row (0 based) of the second cell.
  2554. </member>
  2555. <member name="M:NPOI.XSSF.UserModel.XSSFClientAnchor.#ctor(NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Marker,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Marker)">
  2556. Create XSSFClientAnchor from existing xml beans
  2557. @param cell1 starting anchor point
  2558. @param cell2 ending anchor point
  2559. </member>
  2560. <member name="P:NPOI.XSSF.UserModel.XSSFClientAnchor.From">
  2561. Return starting anchor point
  2562. @return starting anchor point
  2563. </member>
  2564. <member name="P:NPOI.XSSF.UserModel.XSSFClientAnchor.To">
  2565. Return ending anchor point
  2566. @return ending anchor point
  2567. </member>
  2568. <member name="T:NPOI.XSSF.UserModel.XSSFColor">
  2569. Represents a color in SpreadsheetML
  2570. </member>
  2571. <member name="M:NPOI.XSSF.UserModel.XSSFColor.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Color)">
  2572. Create an instance of XSSFColor from the supplied XML bean
  2573. </member>
  2574. <member name="M:NPOI.XSSF.UserModel.XSSFColor.#ctor">
  2575. Create an new instance of XSSFColor
  2576. </member>
  2577. <member name="M:NPOI.XSSF.UserModel.XSSFColor.CorrectRGB(System.Byte[])">
  2578. For RGB colours, but not ARGB (we think...)
  2579. Excel Gets black and white the wrong way around, so switch them
  2580. </member>
  2581. <member name="M:NPOI.XSSF.UserModel.XSSFColor.GetARgb">
  2582. Standard Alpha Red Green Blue ctColor value (ARGB).
  2583. </member>
  2584. <member name="M:NPOI.XSSF.UserModel.XSSFColor.GetRgbWithTint">
  2585. Standard Red Green Blue ctColor value (RGB) with applied tint.
  2586. Alpha values are ignored.
  2587. </member>
  2588. <member name="M:NPOI.XSSF.UserModel.XSSFColor.GetARGBHex">
  2589. Return the ARGB value in hex format, eg FF00FF00.
  2590. Works for both regular and indexed colours.
  2591. </member>
  2592. <member name="M:NPOI.XSSF.UserModel.XSSFColor.SetRgb(System.Byte[])">
  2593. Standard Alpha Red Green Blue ctColor value (ARGB).
  2594. </member>
  2595. <member name="M:NPOI.XSSF.UserModel.XSSFColor.GetCTColor">
  2596. Returns the underlying XML bean
  2597. @return the underlying XML bean
  2598. </member>
  2599. <member name="P:NPOI.XSSF.UserModel.XSSFColor.IsAuto">
  2600. <summary>
  2601. A bool value indicating the ctColor is automatic and system ctColor dependent.
  2602. </summary>
  2603. </member>
  2604. <member name="P:NPOI.XSSF.UserModel.XSSFColor.Indexed">
  2605. Indexed ctColor value. Only used for backwards compatibility. References a ctColor in indexedColors.
  2606. </member>
  2607. <member name="P:NPOI.XSSF.UserModel.XSSFColor.RGB">
  2608. Standard Red Green Blue ctColor value (RGB).
  2609. If there was an A (Alpha) value, it will be stripped.
  2610. </member>
  2611. <!-- 对于成员“P:NPOI.XSSF.UserModel.XSSFColor.Theme”忽略有格式错误的 XML 注释 -->
  2612. <member name="P:NPOI.XSSF.UserModel.XSSFColor.Tint">
  2613. Specifies the tint value applied to the ctColor.
  2614. <p>
  2615. If tint is supplied, then it is applied to the RGB value of the ctColor to determine the final
  2616. ctColor applied.
  2617. </p>
  2618. <p>
  2619. The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken and
  2620. 1.0 means 100% lighten. Also, 0.0 means no Change.
  2621. </p>
  2622. <p>
  2623. In loading the RGB value, it is Converted to HLS where HLS values are (0..HLSMAX), where
  2624. HLSMAX is currently 255.
  2625. </p>
  2626. Here are some examples of how to apply tint to ctColor:
  2627. <blockquote>
  2628. <pre>
  2629. If (tint &lt; 0)
  2630. Lum' = Lum * (1.0 + tint)
  2631. For example: Lum = 200; tint = -0.5; Darken 50%
  2632. Lum' = 200 * (0.5) =&gt; 100
  2633. For example: Lum = 200; tint = -1.0; Darken 100% (make black)
  2634. Lum' = 200 * (1.0-1.0) =&gt; 0
  2635. If (tint &gt; 0)
  2636. Lum' = Lum * (1.0-tint) + (HLSMAX - HLSMAX * (1.0-tint))
  2637. For example: Lum = 100; tint = 0.75; Lighten 75%
  2638. Lum' = 100 * (1-.75) + (HLSMAX - HLSMAX*(1-.75))
  2639. = 100 * .25 + (255 - 255 * .25)
  2640. = 25 + (255 - 63) = 25 + 192 = 217
  2641. For example: Lum = 100; tint = 1.0; Lighten 100% (make white)
  2642. Lum' = 100 * (1-1) + (HLSMAX - HLSMAX*(1-1))
  2643. = 100 * 0 + (255 - 255 * 0)
  2644. = 0 + (255 - 0) = 255
  2645. </pre>
  2646. </blockquote>
  2647. @return the tint value
  2648. </member>
  2649. <member name="F:NPOI.XSSF.UserModel.XSSFComment._str">
  2650. cached reference to the string with the comment text
  2651. </member>
  2652. <member name="M:NPOI.XSSF.UserModel.XSSFComment.#ctor(NPOI.XSSF.Model.CommentsTable,NPOI.OpenXmlFormats.Spreadsheet.CT_Comment,NPOI.OpenXmlFormats.Vml.CT_Shape)">
  2653. Creates a new XSSFComment, associated with a given
  2654. low level comment object.
  2655. </member>
  2656. <member name="M:NPOI.XSSF.UserModel.XSSFComment.SetString(System.String)">
  2657. Sets the rich text string used by this comment.
  2658. @param string the XSSFRichTextString used by this object.
  2659. </member>
  2660. <member name="M:NPOI.XSSF.UserModel.XSSFComment.GetCTComment">
  2661. @return the xml bean holding this comment's properties
  2662. </member>
  2663. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Author">
  2664. @return Name of the original comment author. Default value is blank.
  2665. </member>
  2666. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Column">
  2667. @return the 0-based column of the cell that the comment is associated with.
  2668. </member>
  2669. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Row">
  2670. @return the 0-based row index of the cell that the comment is associated with.
  2671. </member>
  2672. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Visible">
  2673. @return whether the comment is visible
  2674. </member>
  2675. <member name="P:NPOI.XSSF.UserModel.XSSFComment.String">
  2676. @return the rich text string of the comment
  2677. </member>
  2678. <member name="T:NPOI.XSSF.UserModel.XSSFConditionalFormatting">
  2679. @author Yegor Kozlov
  2680. </member>
  2681. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.GetFormattingRanges">
  2682. @return array of <tt>CellRangeAddress</tt>s. Never <code>null</code>
  2683. </member>
  2684. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.SetRule(System.Int32,NPOI.SS.UserModel.IConditionalFormattingRule)">
  2685. Replaces an existing Conditional Formatting rule at position idx.
  2686. Excel allows to create up to 3 Conditional Formatting rules.
  2687. This method can be useful to modify existing Conditional Formatting rules.
  2688. @param idx position of the rule. Should be between 0 and 2.
  2689. @param cfRule - Conditional Formatting rule
  2690. </member>
  2691. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.AddRule(NPOI.SS.UserModel.IConditionalFormattingRule)">
  2692. Add a Conditional Formatting rule.
  2693. Excel allows to create up to 3 Conditional Formatting rules.
  2694. @param cfRule - Conditional Formatting rule
  2695. </member>
  2696. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.GetRule(System.Int32)">
  2697. @return the Conditional Formatting rule at position idx.
  2698. </member>
  2699. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormatting.NumberOfRules">
  2700. @return number of Conditional Formatting rules.
  2701. </member>
  2702. <member name="T:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule">
  2703. @author Yegor Kozlov
  2704. </member>
  2705. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.CreateBorderFormatting">
  2706. Create a new border formatting structure if it does not exist,
  2707. otherwise just return existing object.
  2708. @return - border formatting object, never returns <code>null</code>.
  2709. </member>
  2710. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.GetBorderFormatting">
  2711. @return - border formatting object if defined, <code>null</code> otherwise
  2712. </member>
  2713. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.CreateFontFormatting">
  2714. Create a new font formatting structure if it does not exist,
  2715. otherwise just return existing object.
  2716. @return - font formatting object, never returns <code>null</code>.
  2717. </member>
  2718. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.GetFontFormatting">
  2719. @return - font formatting object if defined, <code>null</code> otherwise
  2720. </member>
  2721. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.CreatePatternFormatting">
  2722. Create a new pattern formatting structure if it does not exist,
  2723. otherwise just return existing object.
  2724. @return - pattern formatting object, never returns <code>null</code>.
  2725. </member>
  2726. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.GetPatternFormatting">
  2727. @return - pattern formatting object if defined, <code>null</code> otherwise
  2728. </member>
  2729. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.ConditionType">
  2730. Type of conditional formatting rule.
  2731. <p>
  2732. MUST be either {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS}
  2733. or {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA}
  2734. </p>
  2735. @return the type of condition
  2736. </member>
  2737. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.ComparisonOperation">
  2738. The comparison function used when the type of conditional formatting is Set to
  2739. {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS}
  2740. <p>
  2741. MUST be a constant from {@link NPOI.ss.usermodel.ComparisonOperator}
  2742. </p>
  2743. @return the conditional format operator
  2744. </member>
  2745. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.Formula1">
  2746. The formula used to Evaluate the first operand for the conditional formatting rule.
  2747. <p>
  2748. If the condition type is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS},
  2749. this field is the first operand of the comparison.
  2750. If type is {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA}, this formula is used
  2751. to determine if the conditional formatting is applied.
  2752. </p>
  2753. <p>
  2754. If comparison type is {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA} the formula MUST be a Boolean function
  2755. </p>
  2756. @return the first formula
  2757. </member>
  2758. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.Formula2">
  2759. The formula used to Evaluate the second operand of the comparison when
  2760. comparison type is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS} and operator
  2761. is either {@link NPOI.ss.usermodel.ComparisonOperator#BETWEEN} or {@link NPOI.ss.usermodel.ComparisonOperator#NOT_BETWEEN}
  2762. @return the second formula
  2763. </member>
  2764. <member name="T:NPOI.XSSF.UserModel.XSSFConnector">
  2765. A connection shape Drawing element. A connection shape is a line, etc.
  2766. that connects two other shapes in this Drawing.
  2767. @author Yegor Kozlov
  2768. </member>
  2769. <member name="T:NPOI.XSSF.UserModel.XSSFShape">
  2770. Represents a shape in a SpreadsheetML Drawing.
  2771. @author Yegor Kozlov
  2772. </member>
  2773. <member name="F:NPOI.XSSF.UserModel.XSSFShape.drawing">
  2774. Parent Drawing
  2775. </member>
  2776. <member name="F:NPOI.XSSF.UserModel.XSSFShape.parent">
  2777. The parent shape, always not-null for shapes in groups
  2778. </member>
  2779. <member name="F:NPOI.XSSF.UserModel.XSSFShape.anchor">
  2780. anchor that is used by this shape
  2781. </member>
  2782. <member name="M:NPOI.XSSF.UserModel.XSSFShape.GetDrawing">
  2783. Return the Drawing that owns this shape
  2784. @return the parent Drawing that owns this shape
  2785. </member>
  2786. <member name="M:NPOI.XSSF.UserModel.XSSFShape.GetAnchor">
  2787. @return the anchor that is used by this shape.
  2788. </member>
  2789. <member name="M:NPOI.XSSF.UserModel.XSSFShape.GetShapeProperties">
  2790. Returns xml bean with shape properties.
  2791. @return xml bean with shape properties.
  2792. </member>
  2793. <member name="M:NPOI.XSSF.UserModel.XSSFShape.SetFillColor(System.Int32,System.Int32,System.Int32)">
  2794. Sets the color used to fill this shape using the solid fill pattern.
  2795. </member>
  2796. <member name="M:NPOI.XSSF.UserModel.XSSFShape.SetLineStyleColor(System.Int32,System.Int32,System.Int32)">
  2797. The color applied to the lines of this shape.
  2798. </member>
  2799. <member name="P:NPOI.XSSF.UserModel.XSSFShape.Parent">
  2800. Gets the parent shape.
  2801. </member>
  2802. <member name="P:NPOI.XSSF.UserModel.XSSFShape.IsNoFill">
  2803. Whether this shape is not Filled with a color
  2804. @return true if this shape is not Filled with a color.
  2805. </member>
  2806. <member name="M:NPOI.XSSF.UserModel.XSSFConnector.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Connector)">
  2807. Construct a new XSSFConnector object.
  2808. @param Drawing the XSSFDrawing that owns this shape
  2809. @param ctShape the shape bean that holds all the shape properties
  2810. </member>
  2811. <member name="M:NPOI.XSSF.UserModel.XSSFConnector.Prototype">
  2812. Initialize default structure of a new auto-shape
  2813. </member>
  2814. <member name="P:NPOI.XSSF.UserModel.XSSFConnector.ShapeType">
  2815. Gets the shape type, one of the constants defined in {@link NPOI.ss.usermodel.ShapeTypes}.
  2816. @return the shape type
  2817. @see NPOI.ss.usermodel.ShapeTypes
  2818. </member>
  2819. <member name="M:NPOI.XSSF.UserModel.XSSFCreationHelper.CreateRichTextString(System.String)">
  2820. Creates a new XSSFRichTextString for you.
  2821. </member>
  2822. <member name="M:NPOI.XSSF.UserModel.XSSFCreationHelper.CreateFormulaEvaluator">
  2823. Creates a XSSFFormulaEvaluator, the object that Evaluates formula cells.
  2824. @return a XSSFFormulaEvaluator instance
  2825. </member>
  2826. <member name="M:NPOI.XSSF.UserModel.XSSFCreationHelper.CreateClientAnchor">
  2827. Creates a XSSFClientAnchor. Use this object to position Drawing object in
  2828. a sheet
  2829. @return a XSSFClientAnchor instance
  2830. @see NPOI.ss.usermodel.Drawing
  2831. </member>
  2832. <member name="T:NPOI.XSSF.UserModel.XSSFDataFormat">
  2833. Handles data formats for XSSF.
  2834. </member>
  2835. <member name="M:NPOI.XSSF.UserModel.XSSFDataFormat.GetFormat(System.String)">
  2836. Get the format index that matches the given format
  2837. string, creating a new format entry if required.
  2838. Aliases text to the proper format as required.
  2839. @param format string matching a built in format
  2840. @return index of format.
  2841. </member>
  2842. <member name="M:NPOI.XSSF.UserModel.XSSFDataFormat.GetFormat(System.Int16)">
  2843. Get the format string that matches the given format index
  2844. @param index of a format
  2845. @return string represented at index of format or null if there is not a format at that index
  2846. </member>
  2847. <member name="T:NPOI.XSSF.UserModel.XSSFDataValidation">
  2848. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  2849. </member>
  2850. <member name="T:NPOI.XSSF.UserModel.XSSFDataValidationConstraint">
  2851. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  2852. </member>
  2853. <member name="T:NPOI.XSSF.UserModel.XSSFDataValidationHelper">
  2854. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  2855. </member>
  2856. <member name="T:NPOI.XSSF.UserModel.XSSFDrawing">
  2857. Represents a SpreadsheetML Drawing
  2858. @author Yegor Kozlov
  2859. </member>
  2860. <member name="F:NPOI.XSSF.UserModel.XSSFDrawing.drawing">
  2861. Root element of the SpreadsheetML Drawing part
  2862. </member>
  2863. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.#ctor">
  2864. Create a new SpreadsheetML Drawing
  2865. @see NPOI.xssf.usermodel.XSSFSheet#CreateDrawingPatriarch()
  2866. </member>
  2867. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  2868. Construct a SpreadsheetML Drawing from a namespace part
  2869. @param part the namespace part holding the Drawing data,
  2870. the content type must be <code>application/vnd.openxmlformats-officedocument.Drawing+xml</code>
  2871. @param rel the namespace relationship holding this Drawing,
  2872. the relationship type must be http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing
  2873. </member>
  2874. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.NewDrawing">
  2875. Construct a new CT_Drawing bean. By default, it's just an empty placeholder for Drawing objects
  2876. @return a new CT_Drawing bean
  2877. </member>
  2878. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.GetCTDrawing">
  2879. Return the underlying CT_Drawing bean, the root element of the SpreadsheetML Drawing part.
  2880. @return the underlying CT_Drawing bean
  2881. </member>
  2882. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateTextbox(NPOI.SS.UserModel.IClientAnchor)">
  2883. Constructs a textbox under the Drawing.
  2884. @param anchor the client anchor describes how this group is attached
  2885. to the sheet.
  2886. @return the newly Created textbox.
  2887. </member>
  2888. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreatePicture(NPOI.XSSF.UserModel.XSSFClientAnchor,System.Int32)">
  2889. Creates a picture.
  2890. @param anchor the client anchor describes how this picture is attached to the sheet.
  2891. @param pictureIndex the index of the picture in the workbook collection of pictures,
  2892. {@link NPOI.xssf.usermodel.XSSFWorkbook#getAllPictures()} .
  2893. @return the newly Created picture shape.
  2894. </member>
  2895. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateChart(NPOI.SS.UserModel.IClientAnchor)">
  2896. <summary>
  2897. Creates a chart.
  2898. </summary>
  2899. <param name="anchor">the client anchor describes how this chart is attached to</param>
  2900. <returns>the newly created chart</returns>
  2901. </member>
  2902. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.AddPictureReference(System.Int32)">
  2903. Add the indexed picture to this Drawing relations
  2904. @param pictureIndex the index of the picture in the workbook collection of pictures,
  2905. {@link NPOI.xssf.usermodel.XSSFWorkbook#getAllPictures()} .
  2906. </member>
  2907. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateSimpleShape(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  2908. Creates a simple shape. This includes such shapes as lines, rectangles,
  2909. and ovals.
  2910. @param anchor the client anchor describes how this group is attached
  2911. to the sheet.
  2912. @return the newly Created shape.
  2913. </member>
  2914. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateConnector(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  2915. Creates a simple shape. This includes such shapes as lines, rectangles,
  2916. and ovals.
  2917. @param anchor the client anchor describes how this group is attached
  2918. to the sheet.
  2919. @return the newly Created shape.
  2920. </member>
  2921. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateGroup(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  2922. Creates a simple shape. This includes such shapes as lines, rectangles,
  2923. and ovals.
  2924. @param anchor the client anchor describes how this group is attached
  2925. to the sheet.
  2926. @return the newly Created shape.
  2927. </member>
  2928. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateCellComment(NPOI.SS.UserModel.IClientAnchor)">
  2929. Creates a comment.
  2930. @param anchor the client anchor describes how this comment is attached
  2931. to the sheet.
  2932. @return the newly Created comment.
  2933. </member>
  2934. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateGraphicFrame(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  2935. Creates a new graphic frame.
  2936. @param anchor the client anchor describes how this frame is attached
  2937. to the sheet
  2938. @return the newly Created graphic frame
  2939. </member>
  2940. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.GetCharts">
  2941. Returns all charts in this Drawing.
  2942. </member>
  2943. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateTwoCellAnchor(NPOI.SS.UserModel.IClientAnchor)">
  2944. Create and Initialize a CT_TwoCellAnchor that anchors a shape against top-left and bottom-right cells.
  2945. @return a new CT_TwoCellAnchor
  2946. </member>
  2947. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.GetShapes">
  2948. @return list of shapes in this drawing
  2949. </member>
  2950. <member name="T:NPOI.XSSF.UserModel.XSSFEvaluationCell">
  2951. XSSF wrapper for a cell under Evaluation
  2952. @author Josh Micich
  2953. </member>
  2954. <member name="T:NPOI.XSSF.UserModel.XSSFEvaluationSheet">
  2955. XSSF wrapper for a sheet under Evaluation
  2956. @author Josh Micich
  2957. </member>
  2958. <member name="T:NPOI.XSSF.UserModel.XSSFEvaluationWorkbook">
  2959. Internal POI use only
  2960. @author Josh Micich
  2961. </member>
  2962. <member name="M:NPOI.XSSF.UserModel.XSSFEvaluationWorkbook.ConvertFromExternSheetIndex(System.Int32)">
  2963. @return the sheet index of the sheet with the given external index.
  2964. </member>
  2965. <member name="M:NPOI.XSSF.UserModel.XSSFEvaluationWorkbook.ConvertToExternalSheetIndex(System.Int32)">
  2966. @return the external sheet index of the sheet with the given internal
  2967. index. Used by some of the more obscure formula and named range things.
  2968. Fairly easy on XSSF (we think...) since the internal and external
  2969. indicies are the same
  2970. </member>
  2971. <member name="M:NPOI.XSSF.UserModel.XSSFEvaluationWorkbook.CleanXSSFFormulaText(System.String)">
  2972. XSSF allows certain extra textual characters in the formula that
  2973. HSSF does not. As these can't be composed down to HSSF-compatible
  2974. Ptgs, this method strips them out for us.
  2975. </member>
  2976. <member name="T:NPOI.XSSF.UserModel.XSSFEvenFooter">
  2977. Even page footer value. Corresponds to even printed pages.
  2978. Even page(s) in the sheet may not be printed, for example, if the print area is specified to be
  2979. a range such that it falls outside an even page's scope.
  2980. If no even footer is specified, then the odd footer's value is assumed for even page footers.
  2981. </member>
  2982. <member name="M:NPOI.XSSF.UserModel.XSSFEvenFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  2983. Create an instance of XSSFEvenFooter from the supplied XML bean
  2984. @see XSSFSheet#GetEvenFooter()
  2985. @param headerFooter
  2986. </member>
  2987. <member name="P:NPOI.XSSF.UserModel.XSSFEvenFooter.Text">
  2988. Get the content text representing the footer
  2989. @return text
  2990. </member>
  2991. <member name="T:NPOI.XSSF.UserModel.XSSFEvenHeader">
  2992. <p>
  2993. Even page header value. Corresponds to even printed pages.
  2994. Even page(s) in the sheet may not be printed, for example, if the print area is specified to be
  2995. a range such that it falls outside an even page's scope.
  2996. If no even header is specified, then odd header value is assumed for even page headers.
  2997. </p>
  2998. </member>
  2999. <member name="M:NPOI.XSSF.UserModel.XSSFEvenHeader.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  3000. Create an instance of XSSFEvenHeader from the supplied XML bean
  3001. @see XSSFSheet#GetEvenHeader()
  3002. @param headerFooter
  3003. </member>
  3004. <member name="P:NPOI.XSSF.UserModel.XSSFEvenHeader.Text">
  3005. Get the content text representing this header
  3006. @return text
  3007. </member>
  3008. <member name="T:NPOI.XSSF.UserModel.XSSFFactory">
  3009. Instantiates sub-classes of POIXMLDocumentPart depending on their relationship type
  3010. @author Yegor Kozlov
  3011. </member>
  3012. <member name="T:NPOI.XSSF.UserModel.XSSFFirstFooter">
  3013. First page footer content. Corresponds to first printed page.
  3014. The first logical page in the sheet may not be printed, for example, if the print area is specified to
  3015. be a range such that it falls outside the first page's scope.
  3016. </member>
  3017. <member name="M:NPOI.XSSF.UserModel.XSSFFirstFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  3018. Create an instance of XSSFFirstFooter from the supplied XML bean
  3019. @see XSSFSheet#getFirstFooter()
  3020. @param headerFooter
  3021. </member>
  3022. <member name="P:NPOI.XSSF.UserModel.XSSFFirstFooter.Text">
  3023. Get the content text representing the footer
  3024. @return text
  3025. </member>
  3026. <member name="T:NPOI.XSSF.UserModel.XSSFFirstHeader">
  3027. First page header content. Corresponds to first printed page.
  3028. The first logical page in the sheet may not be printed, for example, if the print area is specified to
  3029. be a range such that it falls outside the first page's scope.
  3030. </member>
  3031. <member name="M:NPOI.XSSF.UserModel.XSSFFirstHeader.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  3032. Create an instance of XSSFFirstHeader from the supplied XML bean
  3033. @see XSSFSheet#getFirstHeader()
  3034. @param headerFooter
  3035. </member>
  3036. <member name="P:NPOI.XSSF.UserModel.XSSFFirstHeader.Text">
  3037. Get the content text representing this header
  3038. @return text
  3039. </member>
  3040. <member name="T:NPOI.XSSF.UserModel.XSSFFont">
  3041. Represents a font used in a workbook.
  3042. @author Gisella Bronzetti
  3043. </member>
  3044. <member name="F:NPOI.XSSF.UserModel.XSSFFont.DEFAULT_FONT_NAME">
  3045. By default, Microsoft Office Excel 2007 uses the Calibry font in font size 11
  3046. </member>
  3047. <member name="F:NPOI.XSSF.UserModel.XSSFFont.DEFAULT_FONT_SIZE">
  3048. By default, Microsoft Office Excel 2007 uses the Calibry font in font size 11
  3049. </member>
  3050. <member name="F:NPOI.XSSF.UserModel.XSSFFont.DEFAULT_FONT_COLOR">
  3051. Default font color is black
  3052. @see NPOI.SS.usermodel.IndexedColors#BLACK
  3053. </member>
  3054. <member name="M:NPOI.XSSF.UserModel.XSSFFont.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Font)">
  3055. Create a new XSSFFont
  3056. @param font the underlying CT_Font bean
  3057. </member>
  3058. <member name="M:NPOI.XSSF.UserModel.XSSFFont.#ctor">
  3059. Create a new XSSFont. This method is protected to be used only by XSSFWorkbook
  3060. </member>
  3061. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetCTFont">
  3062. get the underlying CT_Font font
  3063. </member>
  3064. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetXSSFColor">
  3065. get the color value for the font
  3066. References a color defined as Standard Alpha Red Green Blue color value (ARGB).
  3067. @return XSSFColor - rgb color to use
  3068. </member>
  3069. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetThemeColor">
  3070. get the color value for the font
  3071. References a color defined in theme.
  3072. @return short - theme defined to use
  3073. </member>
  3074. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetCharSet(System.Byte)">
  3075. set character-set to use.
  3076. @param charset - charset
  3077. @see FontCharset
  3078. </member>
  3079. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetCharSet(System.Int32)">
  3080. set character-set to use.
  3081. @param charset - charset
  3082. @see FontCharset
  3083. </member>
  3084. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetCharSet(NPOI.SS.UserModel.FontCharset)">
  3085. set character-set to use.
  3086. @param charSet
  3087. </member>
  3088. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetColor(NPOI.XSSF.UserModel.XSSFColor)">
  3089. set the color for the font in Standard Alpha Red Green Blue color value
  3090. @param color - color to use
  3091. </member>
  3092. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetThemeColor(System.Int16)">
  3093. set the theme color for the font to use
  3094. @param theme - theme color to use
  3095. </member>
  3096. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetUnderline(NPOI.SS.UserModel.FontUnderlineType)">
  3097. set an enumeration representing the style of underlining that is used.
  3098. The none style is equivalent to not using underlining at all.
  3099. The possible values for this attribute are defined by the FontUnderline
  3100. @param underline - FontUnderline enum value
  3101. </member>
  3102. <member name="M:NPOI.XSSF.UserModel.XSSFFont.RegisterTo(NPOI.XSSF.Model.StylesTable)">
  3103. **
  3104. </member>
  3105. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetThemesTable(NPOI.XSSF.Model.ThemesTable)">
  3106. Records the Themes Table that is associated with
  3107. the current font, used when looking up theme
  3108. based colours and properties.
  3109. </member>
  3110. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetScheme">
  3111. get the font scheme property.
  3112. is used only in StylesTable to create the default instance of font
  3113. @return FontScheme
  3114. @see NPOI.XSSF.model.StylesTable#CreateDefaultFont()
  3115. </member>
  3116. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetScheme(NPOI.SS.UserModel.FontScheme)">
  3117. set font scheme property
  3118. @param scheme - FontScheme enum value
  3119. @see FontScheme
  3120. </member>
  3121. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetFamily(NPOI.SS.UserModel.FontFamily)">
  3122. set an enumeration representing the font family this font belongs to.
  3123. A font family is a set of fonts having common stroke width and serif characteristics.
  3124. @param family font family
  3125. @link #SetFamily(int value)
  3126. </member>
  3127. <member name="P:NPOI.XSSF.UserModel.XSSFFont.IsBold">
  3128. get a bool value for the boldness to use.
  3129. @return bool - bold
  3130. </member>
  3131. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Charset">
  3132. get character-set to use.
  3133. @return int - character-set (0-255)
  3134. @see NPOI.SS.usermodel.FontCharset
  3135. </member>
  3136. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Color">
  3137. get the indexed color value for the font
  3138. References a color defined in IndexedColors.
  3139. @return short - indexed color to use
  3140. @see IndexedColors
  3141. </member>
  3142. <member name="P:NPOI.XSSF.UserModel.XSSFFont.FontHeight">
  3143. get the font height in point.
  3144. @return short - height in point
  3145. </member>
  3146. <member name="P:NPOI.XSSF.UserModel.XSSFFont.FontHeightInPoints">
  3147. @see #GetFontHeight()
  3148. </member>
  3149. <member name="P:NPOI.XSSF.UserModel.XSSFFont.FontName">
  3150. get the name of the font (i.e. Arial)
  3151. @return String - a string representing the name of the font to use
  3152. </member>
  3153. <member name="P:NPOI.XSSF.UserModel.XSSFFont.IsItalic">
  3154. get a bool value that specify whether to use italics or not
  3155. @return bool - value for italic
  3156. </member>
  3157. <member name="P:NPOI.XSSF.UserModel.XSSFFont.IsStrikeout">
  3158. get a bool value that specify whether to use a strikeout horizontal line through the text or not
  3159. @return bool - value for strikeout
  3160. </member>
  3161. <member name="P:NPOI.XSSF.UserModel.XSSFFont.TypeOffset">
  3162. get normal,super or subscript.
  3163. @return short - offset type to use (none,super,sub)
  3164. @see Font#SS_NONE
  3165. @see Font#SS_SUPER
  3166. @see Font#SS_SUB
  3167. </member>
  3168. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Underline">
  3169. get type of text underlining to use
  3170. @return byte - underlining type
  3171. @see NPOI.SS.usermodel.FontUnderline
  3172. </member>
  3173. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Boldweight">
  3174. get the boldness to use
  3175. @return boldweight
  3176. @see #BOLDWEIGHT_NORMAL
  3177. @see #BOLDWEIGHT_BOLD
  3178. </member>
  3179. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Family">
  3180. get the font family to use.
  3181. @return the font family to use
  3182. @see NPOI.SS.usermodel.FontFamily
  3183. </member>
  3184. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Index">
  3185. get the index within the XSSFWorkbook (sequence within the collection of Font objects)
  3186. @return unique index number of the underlying record this Font represents (probably you don't care
  3187. unless you're comparing which one is which)
  3188. </member>
  3189. <member name="T:NPOI.XSSF.UserModel.XSSFFontFormatting">
  3190. @author Yegor Kozlov
  3191. </member>
  3192. <member name="M:NPOI.XSSF.UserModel.XSSFFontFormatting.GetXSSFColor">
  3193. @return xssf color wrapper or null if color info is missing
  3194. </member>
  3195. <member name="M:NPOI.XSSF.UserModel.XSSFFontFormatting.SetFontStyle(System.Boolean,System.Boolean)">
  3196. Set font style options.
  3197. @param italic - if true, Set posture style to italic, otherwise to normal
  3198. @param bold if true, Set font weight to bold, otherwise to normal
  3199. </member>
  3200. <member name="M:NPOI.XSSF.UserModel.XSSFFontFormatting.ResetFontStyle">
  3201. Set font style options to default values (non-italic, non-bold)
  3202. </member>
  3203. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.EscapementType">
  3204. Get the type of super or subscript for the font
  3205. @return super or subscript option
  3206. @see #SS_NONE
  3207. @see #SS_SUPER
  3208. @see #SS_SUB
  3209. </member>
  3210. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.FontColorIndex">
  3211. @return font color index
  3212. </member>
  3213. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.FontHeight">
  3214. Gets the height of the font in 1/20th point units
  3215. @return fontheight (in points/20); or -1 if not modified
  3216. </member>
  3217. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.UnderlineType">
  3218. Get the type of underlining for the font
  3219. @return font underlining type
  3220. @see #U_NONE
  3221. @see #U_SINGLE
  3222. @see #U_DOUBLE
  3223. @see #U_SINGLE_ACCOUNTING
  3224. @see #U_DOUBLE_ACCOUNTING
  3225. </member>
  3226. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.IsBold">
  3227. Get whether the font weight is Set to bold or not
  3228. @return bold - whether the font is bold or not
  3229. </member>
  3230. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.IsItalic">
  3231. @return true if font style was Set to <i>italic</i>
  3232. </member>
  3233. <member name="T:NPOI.XSSF.UserModel.XSSFFormulaEvaluator">
  3234. Evaluates formula cells.<p/>
  3235. For performance reasons, this class keeps a cache of all previously calculated intermediate
  3236. cell values. Be sure to call {@link #ClearAllCachedResultValues()} if any workbook cells are Changed between
  3237. calls to Evaluate~ methods on this class.
  3238. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  3239. @author Josh Micich
  3240. </member>
  3241. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.#ctor(NPOI.XSSF.UserModel.XSSFWorkbook,NPOI.SS.Formula.IStabilityClassifier)">
  3242. @param stabilityClassifier used to optimise caching performance. Pass <code>null</code>
  3243. for the (conservative) assumption that any cell may have its defInition Changed After
  3244. Evaluation begins.
  3245. @deprecated (Sep 2009) (reduce overloading) use {@link #Create(XSSFWorkbook, NPOI.ss.formula.IStabilityClassifier, NPOI.ss.formula.udf.UDFFinder)}
  3246. </member>
  3247. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.Create(NPOI.XSSF.UserModel.XSSFWorkbook,NPOI.SS.Formula.IStabilityClassifier,NPOI.SS.Formula.Udf.UDFFinder)">
  3248. @param stabilityClassifier used to optimise caching performance. Pass <code>null</code>
  3249. for the (conservative) assumption that any cell may have its defInition Changed After
  3250. Evaluation begins.
  3251. @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
  3252. </member>
  3253. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.ClearAllCachedResultValues">
  3254. Should be called whenever there are major Changes (e.g. moving sheets) to input cells
  3255. in the Evaluated workbook.
  3256. Failure to call this method After changing cell values will cause incorrect behaviour
  3257. of the Evaluate~ methods of this class
  3258. </member>
  3259. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.Evaluate(NPOI.SS.UserModel.ICell)">
  3260. If cell Contains a formula, the formula is Evaluated and returned,
  3261. else the CellValue simply copies the appropriate cell value from
  3262. the cell and also its cell type. This method should be preferred over
  3263. EvaluateInCell() when the call should not modify the contents of the
  3264. original cell.
  3265. @param cell
  3266. </member>
  3267. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.EvaluateFormulaCell(NPOI.SS.UserModel.ICell)">
  3268. If cell Contains formula, it Evaluates the formula,
  3269. and saves the result of the formula. The cell
  3270. remains as a formula cell.
  3271. Else if cell does not contain formula, this method leaves
  3272. the cell unChanged.
  3273. Note that the type of the formula result is returned,
  3274. so you know what kind of value is also stored with
  3275. the formula.
  3276. <pre>
  3277. int EvaluatedCellType = Evaluator.EvaluateFormulaCell(cell);
  3278. </pre>
  3279. Be aware that your cell will hold both the formula,
  3280. and the result. If you want the cell Replaced with
  3281. the result of the formula, use {@link #Evaluate(NPOI.ss.usermodel.Cell)} }
  3282. @param cell The cell to Evaluate
  3283. @return The type of the formula result (the cell's type remains as HSSFCell.CELL_TYPE_FORMULA however)
  3284. </member>
  3285. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.EvaluateInCell(NPOI.SS.UserModel.ICell)">
  3286. If cell Contains formula, it Evaluates the formula, and
  3287. Puts the formula result back into the cell, in place
  3288. of the old formula.
  3289. Else if cell does not contain formula, this method leaves
  3290. the cell unChanged.
  3291. Note that the same instance of HSSFCell is returned to
  3292. allow chained calls like:
  3293. <pre>
  3294. int EvaluatedCellType = Evaluator.EvaluateInCell(cell).CellType;
  3295. </pre>
  3296. Be aware that your cell value will be Changed to hold the
  3297. result of the formula. If you simply want the formula
  3298. value computed for you, use {@link #EvaluateFormulaCell(NPOI.ss.usermodel.Cell)} }
  3299. @param cell
  3300. </member>
  3301. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.EvaluateAllFormulaCells(NPOI.SS.UserModel.IWorkbook)">
  3302. Loops over all cells in all sheets of the supplied
  3303. workbook.
  3304. For cells that contain formulas, their formulas are
  3305. Evaluated, and the results are saved. These cells
  3306. remain as formula cells.
  3307. For cells that do not contain formulas, no Changes
  3308. are made.
  3309. This is a helpful wrapper around looping over all
  3310. cells, and calling EvaluateFormulaCell on each one.
  3311. </member>
  3312. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.EvaluateAll">
  3313. Loops over all cells in all sheets of the supplied
  3314. workbook.
  3315. For cells that contain formulas, their formulas are
  3316. Evaluated, and the results are saved. These cells
  3317. remain as formula cells.
  3318. For cells that do not contain formulas, no Changes
  3319. are made.
  3320. This is a helpful wrapper around looping over all
  3321. cells, and calling EvaluateFormulaCell on each one.
  3322. </member>
  3323. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.EvaluateFormulaCellValue(NPOI.SS.UserModel.ICell)">
  3324. Returns a CellValue wrapper around the supplied ValueEval instance.
  3325. </member>
  3326. <member name="T:NPOI.XSSF.UserModel.XSSFGraphicFrame">
  3327. Represents DrawingML GraphicalObjectFrame.
  3328. @author Roman Kashitsyn
  3329. </member>
  3330. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_GraphicalObjectFrame)">
  3331. Construct a new XSSFGraphicFrame object.
  3332. @param Drawing the XSSFDrawing that owns this frame
  3333. @param ctGraphicFrame the XML bean that stores this frame content
  3334. </member>
  3335. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.Prototype">
  3336. Initialize default structure of a new graphic frame
  3337. </member>
  3338. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.SetMacro(System.String)">
  3339. Sets the frame macro.
  3340. </member>
  3341. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.SetChart(NPOI.XSSF.UserModel.XSSFChart,System.String)">
  3342. Assign a DrawingML chart to the graphic frame.
  3343. </member>
  3344. <!-- 对于成员“M:NPOI.XSSF.UserModel.XSSFGraphicFrame.AppendChartElement(NPOI.OpenXmlFormats.Dml.CT_GraphicalObjectData,System.String)”忽略有格式错误的 XML 注释 -->
  3345. <member name="P:NPOI.XSSF.UserModel.XSSFGraphicFrame.Name">
  3346. Returns the frame name.
  3347. @return name of the frame
  3348. </member>
  3349. <member name="P:NPOI.XSSF.UserModel.XSSFGraphicFrame.Anchor">
  3350. Returns the frame anchor.
  3351. @return the anchor this frame is attached to
  3352. </member>
  3353. <member name="P:NPOI.XSSF.UserModel.XSSFGraphicFrame.Id">
  3354. Gets the frame id.
  3355. </member>
  3356. <member name="T:NPOI.XSSF.UserModel.XSSFMap">
  3357. This class : the Map element (Open Office XML Part 4:
  3358. chapter 3.16.2)
  3359. This element Contains all of the properties related to the XML map,
  3360. and the behaviors expected during data refresh operations.
  3361. @author Roberto Manicardi
  3362. </member>
  3363. <member name="M:NPOI.XSSF.UserModel.XSSFMap.GetRelatedSingleXMLCell">
  3364. @return the list of Single Xml Cells that provide a map rule to this mapping.
  3365. </member>
  3366. <member name="M:NPOI.XSSF.UserModel.XSSFMap.GetRelatedTables">
  3367. @return the list of all Tables that provide a map rule to this mapping
  3368. </member>
  3369. <member name="T:NPOI.XSSF.UserModel.XSSFName">
  3370. Represents a defined named range in a SpreadsheetML workbook.
  3371. <p>
  3372. Defined names are descriptive text that is used to represents a cell, range of cells, formula, or constant value.
  3373. Use easy-to-understand names, such as Products, to refer to hard to understand ranges, such as <code>Sales!C20:C30</code>.
  3374. </p>
  3375. Example:
  3376. <pre><blockquote>
  3377. XSSFWorkbook wb = new XSSFWorkbook();
  3378. XSSFSheet sh = wb.CreateSheet("Sheet1");
  3379. //applies to the entire workbook
  3380. XSSFName name1 = wb.CreateName();
  3381. name1.SetNameName("FMLA");
  3382. name1.SetRefersToFormula("Sheet1!$B$3");
  3383. //applies to Sheet1
  3384. XSSFName name2 = wb.CreateName();
  3385. name2.SetNameName("SheetLevelName");
  3386. name2.SetComment("This name is scoped to Sheet1");
  3387. name2.SetLocalSheetId(0);
  3388. name2.SetRefersToFormula("Sheet1!$B$3");
  3389. </blockquote></pre>
  3390. @author Nick Burch
  3391. @author Yegor Kozlov
  3392. </member>
  3393. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_PRINT_AREA">
  3394. A built-in defined name that specifies the workbook's print area
  3395. </member>
  3396. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_PRINT_TITLE">
  3397. A built-in defined name that specifies the row(s) or column(s) to repeat
  3398. at the top of each printed page.
  3399. </member>
  3400. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_CRITERIA">
  3401. A built-in defined name that refers to a range Containing the criteria values
  3402. to be used in Applying an advanced filter to a range of data
  3403. </member>
  3404. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_EXTRACT">
  3405. this defined name refers to the range Containing the filtered
  3406. output values resulting from Applying an advanced filter criteria to a source
  3407. range
  3408. </member>
  3409. <!-- 对于成员“F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_FILTER_DB”忽略有格式错误的 XML 注释 -->
  3410. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_CONSOLIDATE_AREA">
  3411. A built-in defined name that refers to a consolidation area
  3412. </member>
  3413. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_DATABASE">
  3414. A built-in defined name that specified that the range specified is from a database data source
  3415. </member>
  3416. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_SHEET_TITLE">
  3417. A built-in defined name that refers to a sheet title.
  3418. </member>
  3419. <member name="M:NPOI.XSSF.UserModel.XSSFName.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_DefinedName,NPOI.XSSF.UserModel.XSSFWorkbook)">
  3420. Creates an XSSFName object - called internally by XSSFWorkbook.
  3421. @param name - the xml bean that holds data represenring this defined name.
  3422. @param workbook - the workbook object associated with the name
  3423. @see NPOI.XSSF.usermodel.XSSFWorkbook#CreateName()
  3424. </member>
  3425. <member name="M:NPOI.XSSF.UserModel.XSSFName.GetCTName">
  3426. Returns the underlying named range object
  3427. </member>
  3428. <member name="M:NPOI.XSSF.UserModel.XSSFName.Equals(System.Object)">
  3429. Compares this name to the specified object.
  3430. The result is <code>true</code> if the argument is XSSFName and the
  3431. underlying CTDefinedName bean Equals to the CTDefinedName representing this name
  3432. @param o the object to compare this <code>XSSFName</code> against.
  3433. @return <code>true</code> if the <code>XSSFName </code>are Equal;
  3434. <code>false</code> otherwise.
  3435. </member>
  3436. <member name="P:NPOI.XSSF.UserModel.XSSFName.NameName">
  3437. Returns the name that will appear in the user interface for the defined name.
  3438. @return text name of this defined name
  3439. </member>
  3440. <member name="P:NPOI.XSSF.UserModel.XSSFName.SheetIndex">
  3441. Returns the sheet index this name applies to.
  3442. @return the sheet index this name applies to, -1 if this name applies to the entire workbook
  3443. </member>
  3444. <member name="P:NPOI.XSSF.UserModel.XSSFName.Function">
  3445. Indicates that the defined name refers to a user-defined function.
  3446. This attribute is used when there is an Add-in or other code project associated with the file.
  3447. @return <code>true</code> indicates the name refers to a function.
  3448. </member>
  3449. <member name="P:NPOI.XSSF.UserModel.XSSFName.FunctionGroupId">
  3450. Returns the function group index if the defined name refers to a function. The function
  3451. group defines the general category for the function. This attribute is used when there is
  3452. an Add-in or other code project associated with the file.
  3453. @return the function group index that defines the general category for the function
  3454. </member>
  3455. <member name="P:NPOI.XSSF.UserModel.XSSFName.SheetName">
  3456. Get the sheets name which this named range is referenced to
  3457. @return sheet name, which this named range referred to.
  3458. Empty string if the referenced sheet name weas not found.
  3459. </member>
  3460. <member name="P:NPOI.XSSF.UserModel.XSSFName.IsFunctionName">
  3461. Is the name refers to a user-defined function ?
  3462. @return <code>true</code> if this name refers to a user-defined function
  3463. </member>
  3464. <member name="P:NPOI.XSSF.UserModel.XSSFName.Comment">
  3465. Returns the comment the user provided when the name was Created.
  3466. @return the user comment for this named range
  3467. </member>
  3468. <member name="T:NPOI.XSSF.UserModel.XSSFHyperlink">
  3469. XSSF Implementation of a Hyperlink.
  3470. Note - unlike with HSSF, many kinds of hyperlink
  3471. are largely stored as relations of the sheet
  3472. </member>
  3473. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.#ctor(NPOI.SS.UserModel.HyperlinkType)">
  3474. Create a new XSSFHyperlink. This method is protected to be used only by XSSFCreationHelper
  3475. @param type - the type of hyperlink to create
  3476. </member>
  3477. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Hyperlink,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  3478. Create a XSSFHyperlink amd Initialize it from the supplied CTHyperlink bean and namespace relationship
  3479. @param ctHyperlink the xml bean Containing xml properties
  3480. @param hyperlinkRel the relationship in the underlying OPC namespace which stores the actual link's Address
  3481. </member>
  3482. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.GetCTHyperlink">
  3483. @return the underlying CTHyperlink object
  3484. </member>
  3485. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.NeedsRelationToo">
  3486. Do we need to a relation too, to represent
  3487. this hyperlink?
  3488. </member>
  3489. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.GenerateRelationIfNeeded(NPOI.OpenXml4Net.OPC.PackagePart)">
  3490. Generates the relation if required
  3491. </member>
  3492. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.GetCellRef">
  3493. Get the reference of the cell this applies to,
  3494. es A55
  3495. </member>
  3496. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.SetCellReference(System.String)">
  3497. Assigns this hyperlink to the given cell reference
  3498. </member>
  3499. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Type">
  3500. Return the type of this hyperlink
  3501. @return the type of this hyperlink
  3502. </member>
  3503. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Address">
  3504. Hyperlink Address. Depending on the hyperlink type it can be URL, e-mail, path to a file
  3505. @return the Address of this hyperlink
  3506. </member>
  3507. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Label">
  3508. Return text label for this hyperlink
  3509. @return text to display
  3510. </member>
  3511. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Location">
  3512. Location within target. If target is a workbook (or this workbook) this shall refer to a
  3513. sheet and cell or a defined name. Can also be an HTML anchor if target is HTML file.
  3514. @return location
  3515. </member>
  3516. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.FirstColumn">
  3517. Return the column of the first cell that Contains the hyperlink
  3518. @return the 0-based column of the first cell that Contains the hyperlink
  3519. </member>
  3520. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.LastColumn">
  3521. Return the column of the last cell that Contains the hyperlink
  3522. @return the 0-based column of the last cell that Contains the hyperlink
  3523. </member>
  3524. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.FirstRow">
  3525. Return the row of the first cell that Contains the hyperlink
  3526. @return the 0-based row of the cell that Contains the hyperlink
  3527. </member>
  3528. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.LastRow">
  3529. Return the row of the last cell that Contains the hyperlink
  3530. @return the 0-based row of the last cell that Contains the hyperlink
  3531. </member>
  3532. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Tooltip">
  3533. <summary>
  3534. get or set additional text to help the user understand more about the hyperlink
  3535. </summary>
  3536. </member>
  3537. <member name="T:NPOI.XSSF.UserModel.XSSFOddFooter">
  3538. Odd page footer value. Corresponds to odd printed pages.
  3539. Odd page(s) in the sheet may not be printed, for example, if the print area is specified to be
  3540. a range such that it falls outside an odd page's scope.
  3541. </member>
  3542. <member name="M:NPOI.XSSF.UserModel.XSSFOddFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  3543. Create an instance of XSSFOddFooter from the supplied XML bean
  3544. @see XSSFSheet#GetOddFooter()
  3545. @param headerFooter
  3546. </member>
  3547. <member name="P:NPOI.XSSF.UserModel.XSSFOddFooter.Text">
  3548. Get the content text representing the footer
  3549. @return text
  3550. </member>
  3551. <member name="T:NPOI.XSSF.UserModel.XSSFOddHeader">
  3552. Odd page header value. Corresponds to odd printed pages.
  3553. Odd page(s) in the sheet may not be printed, for example, if the print area is specified to be
  3554. a range such that it falls outside an odd page's scope.
  3555. </member>
  3556. <member name="M:NPOI.XSSF.UserModel.XSSFOddHeader.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  3557. Create an instance of XSSFOddHeader from the supplied XML bean
  3558. @see XSSFSheet#GetOddHeader()
  3559. @param headerFooter
  3560. </member>
  3561. <member name="P:NPOI.XSSF.UserModel.XSSFOddHeader.Text">
  3562. Get the content text representing this header
  3563. @return text
  3564. </member>
  3565. <member name="T:NPOI.XSSF.UserModel.XSSFPatternFormatting">
  3566. @author Yegor Kozlov
  3567. </member>
  3568. <member name="T:NPOI.XSSF.UserModel.XSSFPicture">
  3569. Represents a picture shape in a SpreadsheetML Drawing.
  3570. @author Yegor Kozlov
  3571. </member>
  3572. <member name="F:NPOI.XSSF.UserModel.XSSFPicture.DEFAULT_COLUMN_WIDTH">
  3573. Column width measured as the number of characters of the maximum digit width of the
  3574. numbers 0, 1, 2, ..., 9 as rendered in the normal style's font. There are 4 pixels of margin
  3575. pAdding (two on each side), plus 1 pixel pAdding for the gridlines.
  3576. This value is the same for default font in Office 2007 (Calibry) and Office 2003 and earlier (Arial)
  3577. </member>
  3578. <member name="F:NPOI.XSSF.UserModel.XSSFPicture.prototype">
  3579. A default instance of CTShape used for creating new shapes.
  3580. </member>
  3581. <member name="F:NPOI.XSSF.UserModel.XSSFPicture.ctPicture">
  3582. This object specifies a picture object and all its properties
  3583. </member>
  3584. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Picture)">
  3585. Construct a new XSSFPicture object. This constructor is called from
  3586. {@link XSSFDrawing#CreatePicture(XSSFClientAnchor, int)}
  3587. @param Drawing the XSSFDrawing that owns this picture
  3588. </member>
  3589. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,System.Xml.XmlNode)">
  3590. Returns a prototype that is used to construct new shapes
  3591. @return a prototype that is used to construct new shapes
  3592. </member>
  3593. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.SetPictureReference(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  3594. Link this shape with the picture data
  3595. @param rel relationship referring the picture data
  3596. </member>
  3597. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetCTPicture">
  3598. Return the underlying CT_Picture bean that holds all properties for this picture
  3599. @return the underlying CT_Picture bean
  3600. </member>
  3601. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.Resize">
  3602. Reset the image to the original size.
  3603. <p>
  3604. Please note, that this method works correctly only for workbooks
  3605. with the default font size (Calibri 11pt for .xlsx).
  3606. If the default font is Changed the resized image can be streched vertically or horizontally.
  3607. </p>
  3608. </member>
  3609. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.Resize(System.Double)">
  3610. Reset the image to the original size.
  3611. <p>
  3612. Please note, that this method works correctly only for workbooks
  3613. with the default font size (Calibri 11pt for .xlsx).
  3614. If the default font is Changed the resized image can be streched vertically or horizontally.
  3615. </p>
  3616. @param scale the amount by which image dimensions are multiplied relative to the original size.
  3617. <code>resize(1.0)</code> Sets the original size, <code>resize(0.5)</code> resize to 50% of the original,
  3618. <code>resize(2.0)</code> resizes to 200% of the original.
  3619. </member>
  3620. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetPreferredSize">
  3621. Calculate the preferred size for this picture.
  3622. @return XSSFClientAnchor with the preferred size for this image
  3623. </member>
  3624. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetPreferredSize(System.Double)">
  3625. Calculate the preferred size for this picture.
  3626. @param scale the amount by which image dimensions are multiplied relative to the original size.
  3627. @return XSSFClientAnchor with the preferred size for this image
  3628. </member>
  3629. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetImageDimension(NPOI.OpenXml4Net.OPC.PackagePart,System.Int32)">
  3630. Return the dimension of this image
  3631. @param part the namespace part holding raw picture data
  3632. @param type type of the picture: {@link Workbook#PICTURE_TYPE_JPEG},
  3633. {@link Workbook#PICTURE_TYPE_PNG} or {@link Workbook#PICTURE_TYPE_DIB}
  3634. @return image dimension in pixels
  3635. </member>
  3636. <member name="T:NPOI.XSSF.UserModel.XSSFPictureData">
  3637. Raw picture data, normally attached to a SpreadsheetML Drawing.
  3638. As a rule, pictures are stored in the /xl/media/ part of a SpreadsheetML package.
  3639. </member>
  3640. <member name="F:NPOI.XSSF.UserModel.XSSFPictureData.RELATIONS">
  3641. Relationships for each known picture type
  3642. </member>
  3643. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.#ctor">
  3644. Create a new XSSFPictureData node
  3645. @see NPOI.xssf.usermodel.XSSFWorkbook#AddPicture(byte[], int)
  3646. </member>
  3647. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  3648. Construct XSSFPictureData from a namespace part
  3649. @param part the namespace part holding the Drawing data,
  3650. @param rel the namespace relationship holding this Drawing,
  3651. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/image
  3652. </member>
  3653. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.SuggestFileExtension">
  3654. Suggests a file extension for this image.
  3655. @return the file extension.
  3656. </member>
  3657. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.GetPictureType">
  3658. Return an integer constant that specifies type of this picture
  3659. @return an integer constant that specifies type of this picture
  3660. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_EMF
  3661. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_WMF
  3662. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_PICT
  3663. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_JPEG
  3664. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_PNG
  3665. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_DIB
  3666. </member>
  3667. <member name="P:NPOI.XSSF.UserModel.XSSFPictureData.Data">
  3668. <summary>
  3669. Gets the picture data as a byte array.
  3670. </summary>
  3671. </member>
  3672. <member name="T:NPOI.XSSF.UserModel.XSSFPrintSetup">
  3673. Page Setup and page margins Settings for the worksheet.
  3674. </member>
  3675. <member name="M:NPOI.XSSF.UserModel.XSSFPrintSetup.SetPaperSize(NPOI.SS.UserModel.PaperSize)">
  3676. Set the paper size as enum value.
  3677. @param size value for the paper size.
  3678. </member>
  3679. <member name="M:NPOI.XSSF.UserModel.XSSFPrintSetup.GetPaperSizeEnum">
  3680. Returns the paper size as enum.
  3681. @return PaperSize paper size
  3682. @see PaperSize
  3683. </member>
  3684. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Orientation">
  3685. Orientation of the page: landscape - portrait.
  3686. @return Orientation of the page
  3687. @see PrintOrientation
  3688. </member>
  3689. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.PageOrder">
  3690. Get print page order.
  3691. @return PageOrder
  3692. </member>
  3693. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.PaperSize">
  3694. Returns the paper size.
  3695. @return short - paper size
  3696. </member>
  3697. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Scale">
  3698. Returns the scale.
  3699. @return short - scale
  3700. </member>
  3701. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.PageStart">
  3702. Set the page numbering start.
  3703. Page number for first printed page. If no value is specified, then 'automatic' is assumed.
  3704. @return page number for first printed page
  3705. </member>
  3706. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.FitWidth">
  3707. Returns the number of pages wide to fit sheet in.
  3708. @return number of pages wide to fit sheet in
  3709. </member>
  3710. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.FitHeight">
  3711. Returns the number of pages high to fit the sheet in.
  3712. @return number of pages high to fit the sheet in
  3713. </member>
  3714. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.LeftToRight">
  3715. Returns the left to right print order.
  3716. @return left to right print order
  3717. </member>
  3718. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Landscape">
  3719. Returns the landscape mode.
  3720. @return landscape mode
  3721. </member>
  3722. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.ValidSettings">
  3723. Use the printer's defaults Settings for page Setup values and don't use the default values
  3724. specified in the schema. For example, if dpi is not present or specified in the XML, the
  3725. application shall not assume 600dpi as specified in the schema as a default and instead
  3726. shall let the printer specify the default dpi.
  3727. @return valid Settings
  3728. </member>
  3729. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.NoColor">
  3730. Returns the black and white Setting.
  3731. @return black and white Setting
  3732. </member>
  3733. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Draft">
  3734. Returns the draft mode.
  3735. @return draft mode
  3736. </member>
  3737. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Notes">
  3738. Returns the print notes.
  3739. @return print notes
  3740. </member>
  3741. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.NoOrientation">
  3742. Returns the no orientation.
  3743. @return no orientation
  3744. </member>
  3745. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.UsePage">
  3746. Returns the use page numbers.
  3747. @return use page numbers
  3748. </member>
  3749. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.HResolution">
  3750. Returns the horizontal resolution.
  3751. @return horizontal resolution
  3752. </member>
  3753. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.VResolution">
  3754. Returns the vertical resolution.
  3755. @return vertical resolution
  3756. </member>
  3757. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.HeaderMargin">
  3758. Returns the header margin.
  3759. @return header margin
  3760. </member>
  3761. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.FooterMargin">
  3762. Returns the footer margin.
  3763. @return footer margin
  3764. </member>
  3765. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Copies">
  3766. Returns the number of copies.
  3767. @return number of copies
  3768. </member>
  3769. <member name="T:NPOI.XSSF.UserModel.XSSFRelation">
  3770. </member>
  3771. <member name="F:NPOI.XSSF.UserModel.XSSFRelation._table">
  3772. A map to lookup POIXMLRelation by its relation type
  3773. </member>
  3774. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.GetContents(NPOI.OpenXml4Net.OPC.PackagePart)">
  3775. Fetches the InputStream to read the contents, based
  3776. of the specified core part, for which we are defined
  3777. as a suitable relationship
  3778. </member>
  3779. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.GetInstance(System.String)">
  3780. Get POIXMLRelation by relation type
  3781. @param rel relation type, for example,
  3782. <code>http://schemas.openxmlformats.org/officeDocument/2006/relationships/image</code>
  3783. @return registered POIXMLRelation or null if not found
  3784. </member>
  3785. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.RemoveRelation(NPOI.XSSF.UserModel.XSSFRelation)">
  3786. <summary>
  3787. Removes the relation from the internal table.
  3788. Following readings of files will ignoring the removed relation.
  3789. </summary>
  3790. <param name="relation">Relation to remove</param>
  3791. </member>
  3792. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.AddRelation(NPOI.XSSF.UserModel.XSSFRelation)">
  3793. <summary>
  3794. Adds the relation to the internal table.
  3795. Following readings of files will process the given relation.
  3796. </summary>
  3797. <param name="relation">Relation to add</param>
  3798. </member>
  3799. <member name="T:NPOI.XSSF.UserModel.XSSFRichTextString">
  3800. Rich text unicode string. These strings can have fonts applied to arbitary parts of the string.
  3801. <p>
  3802. Most strings in a workbook have formatting applied at the cell level, that is, the entire string in the cell has the
  3803. same formatting applied. In these cases, the formatting for the cell is stored in the styles part,
  3804. and the string for the cell can be shared across the workbook. The following code illustrates the example.
  3805. </p>
  3806. <blockquote>
  3807. <pre>
  3808. cell1.SetCellValue(new XSSFRichTextString("Apache POI"));
  3809. cell2.SetCellValue(new XSSFRichTextString("Apache POI"));
  3810. cell3.SetCellValue(new XSSFRichTextString("Apache POI"));
  3811. </pre>
  3812. </blockquote>
  3813. In the above example all three cells will use the same string cached on workbook level.
  3814. <p>
  3815. Some strings in the workbook may have formatting applied at a level that is more granular than the cell level.
  3816. For instance, specific characters within the string may be bolded, have coloring, italicizing, etc.
  3817. In these cases, the formatting is stored along with the text in the string table, and is treated as
  3818. a unique entry in the workbook. The following xml and code snippet illustrate this.
  3819. </p>
  3820. <blockquote>
  3821. <pre>
  3822. XSSFRichTextString s1 = new XSSFRichTextString("Apache POI");
  3823. s1.ApplyFont(boldArial);
  3824. cell1.SetCellValue(s1);
  3825. XSSFRichTextString s2 = new XSSFRichTextString("Apache POI");
  3826. s2.ApplyFont(italicCourier);
  3827. cell2.SetCellValue(s2);
  3828. </pre>
  3829. </blockquote>
  3830. @author Yegor Kozlov
  3831. </member>
  3832. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.#ctor(System.String)">
  3833. Create a rich text string
  3834. </member>
  3835. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.#ctor">
  3836. Create empty rich text string and Initialize it with empty string
  3837. </member>
  3838. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Rst)">
  3839. Create a rich text string from the supplied XML bean
  3840. </member>
  3841. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(System.Int32,System.Int32,System.Int16)">
  3842. Applies a font to the specified characters of a string.
  3843. @param startIndex The start index to apply the font to (inclusive)
  3844. @param endIndex The end index to apply the font to (exclusive)
  3845. @param fontIndex The font to use.
  3846. </member>
  3847. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(System.Int32,System.Int32,NPOI.SS.UserModel.IFont)">
  3848. Applies a font to the specified characters of a string.
  3849. @param startIndex The start index to apply the font to (inclusive)
  3850. @param endIndex The end index to apply to font to (exclusive)
  3851. @param font The index of the font to use.
  3852. </member>
  3853. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(NPOI.SS.UserModel.IFont)">
  3854. Sets the font of the entire string.
  3855. @param font The font to use.
  3856. </member>
  3857. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(System.Int16)">
  3858. Applies the specified font to the entire string.
  3859. @param fontIndex the font to Apply.
  3860. </member>
  3861. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.Append(System.String,NPOI.XSSF.UserModel.XSSFFont)">
  3862. Append new text to this text run and apply the specify font to it
  3863. @param text the text to append
  3864. @param font the font to apply to the Appended text or <code>null</code> if no formatting is required
  3865. </member>
  3866. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.Append(System.String)">
  3867. Append new text to this text run
  3868. @param text the text to append
  3869. </member>
  3870. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.SetRunAttributes(NPOI.OpenXmlFormats.Spreadsheet.CT_Font,NPOI.OpenXmlFormats.Spreadsheet.CT_RPrElt)">
  3871. Copy font attributes from CTFont bean into CTRPrElt bean
  3872. </member>
  3873. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ClearFormatting">
  3874. Removes any formatting that may have been applied to the string.
  3875. </member>
  3876. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetIndexOfFormattingRun(System.Int32)">
  3877. The index within the string to which the specified formatting run applies.
  3878. @param index the index of the formatting run
  3879. @return the index within the string.
  3880. </member>
  3881. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetLengthOfFormattingRun(System.Int32)">
  3882. Returns the number of characters this format run covers.
  3883. @param index the index of the formatting run
  3884. @return the number of characters this format run covers
  3885. </member>
  3886. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ToString">
  3887. Returns the plain string representation.
  3888. </member>
  3889. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetFontOfFormattingRun(System.Int32)">
  3890. Gets a copy of the font used in a particular formatting Run.
  3891. @param index the index of the formatting run
  3892. @return A copy of the font used or null if no formatting is applied to the specified text Run.
  3893. </member>
  3894. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetFontAtIndex(System.Int32)">
  3895. Return a copy of the font in use at a particular index.
  3896. @param index The index.
  3897. @return A copy of the font that's currently being applied at that
  3898. index or null if no font is being applied or the
  3899. index is out of range.
  3900. </member>
  3901. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetCTRst">
  3902. Return the underlying xml bean
  3903. </member>
  3904. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ToCTFont(NPOI.OpenXmlFormats.Spreadsheet.CT_RPrElt)">
  3905. CTRPrElt --> CTFont adapter
  3906. </member>
  3907. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.PreserveSpaces(System.String)">
  3908. **
  3909. </member>
  3910. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.UtfDecode(System.String)">
  3911. For all characters which cannot be represented in XML as defined by the XML 1.0 specification,
  3912. the characters are escaped using the Unicode numerical character representation escape character
  3913. format _xHHHH_, where H represents a hexadecimal character in the character's value.
  3914. <p>
  3915. Example: The Unicode character 0D is invalid in an XML 1.0 document,
  3916. so it shall be escaped as <code>_x000D_</code>.
  3917. </p>
  3918. See section 3.18.9 in the OOXML spec.
  3919. @param value the string to decode
  3920. @return the decoded string
  3921. </member>
  3922. <member name="P:NPOI.XSSF.UserModel.XSSFRichTextString.Length">
  3923. Returns the number of characters in this string.
  3924. </member>
  3925. <member name="P:NPOI.XSSF.UserModel.XSSFRichTextString.NumFormattingRuns">
  3926. @return The number of formatting Runs used.
  3927. </member>
  3928. <member name="T:NPOI.XSSF.UserModel.XSSFRow">
  3929. High level representation of a row of a spreadsheet.
  3930. </member>
  3931. <member name="F:NPOI.XSSF.UserModel.XSSFRow._row">
  3932. the xml bean Containing all cell defInitions for this row
  3933. </member>
  3934. <member name="F:NPOI.XSSF.UserModel.XSSFRow._cells">
  3935. Cells of this row keyed by their column indexes.
  3936. The TreeMap ensures that the cells are ordered by columnIndex in the ascending order.
  3937. </member>
  3938. <member name="F:NPOI.XSSF.UserModel.XSSFRow._sheet">
  3939. the parent sheet
  3940. </member>
  3941. <member name="M:NPOI.XSSF.UserModel.XSSFRow.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Row,NPOI.XSSF.UserModel.XSSFSheet)">
  3942. Construct a XSSFRow.
  3943. @param row the xml bean Containing all cell defInitions for this row.
  3944. @param sheet the parent sheet.
  3945. </member>
  3946. <!-- 对于成员“M:NPOI.XSSF.UserModel.XSSFRow.CellIterator”忽略有格式错误的 XML 注释 -->
  3947. <member name="M:NPOI.XSSF.UserModel.XSSFRow.GetEnumerator">
  3948. Alias for {@link #cellIterator()} to allow foreach loops:
  3949. <blockquote><pre>
  3950. for(Cell cell : row){
  3951. ...
  3952. }
  3953. </pre></blockquote>
  3954. @return an iterator over cells in this row.
  3955. </member>
  3956. <member name="M:NPOI.XSSF.UserModel.XSSFRow.CompareTo(NPOI.XSSF.UserModel.XSSFRow)">
  3957. Compares two <code>XSSFRow</code> objects. Two rows are equal if they belong to the same worksheet and
  3958. their row indexes are Equal.
  3959. @param row the <code>XSSFRow</code> to be Compared.
  3960. @return the value <code>0</code> if the row number of this <code>XSSFRow</code> is
  3961. equal to the row number of the argument <code>XSSFRow</code>; a value less than
  3962. <code>0</code> if the row number of this this <code>XSSFRow</code> is numerically less
  3963. than the row number of the argument <code>XSSFRow</code>; and a value greater
  3964. than <code>0</code> if the row number of this this <code>XSSFRow</code> is numerically
  3965. greater than the row number of the argument <code>XSSFRow</code>.
  3966. @throws ArgumentException if the argument row belongs to a different worksheet
  3967. </member>
  3968. <!-- 对于成员“M:NPOI.XSSF.UserModel.XSSFRow.CreateCell(System.Int32)”忽略有格式错误的 XML 注释 -->
  3969. <!-- 对于成员“M:NPOI.XSSF.UserModel.XSSFRow.CreateCell(System.Int32,NPOI.SS.UserModel.CellType)”忽略有格式错误的 XML 注释 -->
  3970. <member name="M:NPOI.XSSF.UserModel.XSSFRow.GetCell(System.Int32)">
  3971. Returns the cell at the given (0 based) index,
  3972. with the {@link NPOI.SS.usermodel.Row.MissingCellPolicy} from the parent Workbook.
  3973. @return the cell at the given (0 based) index
  3974. </member>
  3975. <member name="M:NPOI.XSSF.UserModel.XSSFRow.RetrieveCell(System.Int32)">
  3976. <summary>
  3977. Get the hssfcell representing a given column (logical cell)
  3978. 0-based. If you ask for a cell that is not defined, then
  3979. you Get a null.
  3980. This is the basic call, with no policies applied
  3981. </summary>
  3982. <param name="cellnum">0 based column number</param>
  3983. <returns>Cell representing that column or null if Undefined.</returns>
  3984. </member>
  3985. <!-- 对于成员“M:NPOI.XSSF.UserModel.XSSFRow.GetCell(System.Int32,NPOI.SS.UserModel.MissingCellPolicy)”忽略有格式错误的 XML 注释 -->
  3986. <member name="M:NPOI.XSSF.UserModel.XSSFRow.SetRowStyle(NPOI.SS.UserModel.ICellStyle)">
  3987. Applies a whole-row cell styling to the row.
  3988. If the value is null then the style information is Removed,
  3989. causing the cell to used the default workbook style.
  3990. </member>
  3991. <member name="M:NPOI.XSSF.UserModel.XSSFRow.RemoveCell(NPOI.SS.UserModel.ICell)">
  3992. Remove the Cell from this row.
  3993. @param cell the cell to remove
  3994. </member>
  3995. <member name="M:NPOI.XSSF.UserModel.XSSFRow.GetCTRow">
  3996. Returns the underlying CT_Row xml bean Containing all cell defInitions in this row
  3997. @return the underlying CT_Row xml bean
  3998. </member>
  3999. <member name="M:NPOI.XSSF.UserModel.XSSFRow.OnDocumentWrite">
  4000. Fired when the document is written to an output stream.
  4001. @see NPOI.XSSF.usermodel.XSSFSheet#Write(java.io.OutputStream) ()
  4002. </member>
  4003. <member name="M:NPOI.XSSF.UserModel.XSSFRow.ToString">
  4004. @return formatted xml representation of this row
  4005. </member>
  4006. <member name="M:NPOI.XSSF.UserModel.XSSFRow.Shift(System.Int32)">
  4007. update cell references when Shifting rows
  4008. @param n the number of rows to move
  4009. </member>
  4010. <member name="P:NPOI.XSSF.UserModel.XSSFRow.Sheet">
  4011. Returns the XSSFSheet this row belongs to
  4012. @return the XSSFSheet that owns this row
  4013. </member>
  4014. <member name="P:NPOI.XSSF.UserModel.XSSFRow.FirstCellNum">
  4015. Get the number of the first cell Contained in this row.
  4016. @return short representing the first logical cell in the row,
  4017. or -1 if the row does not contain any cells.
  4018. </member>
  4019. <member name="P:NPOI.XSSF.UserModel.XSSFRow.LastCellNum">
  4020. Gets the index of the last cell Contained in this row <b>PLUS ONE</b>. The result also
  4021. happens to be the 1-based column number of the last cell. This value can be used as a
  4022. standard upper bound when iterating over cells:
  4023. <pre>
  4024. short minColIx = row.GetFirstCellNum();
  4025. short maxColIx = row.GetLastCellNum();
  4026. for(short colIx=minColIx; colIx&lt;maxColIx; colIx++) {
  4027. XSSFCell cell = row.GetCell(colIx);
  4028. if(cell == null) {
  4029. continue;
  4030. }
  4031. //... do something with cell
  4032. }
  4033. </pre>
  4034. @return short representing the last logical cell in the row <b>PLUS ONE</b>,
  4035. or -1 if the row does not contain any cells.
  4036. </member>
  4037. <member name="P:NPOI.XSSF.UserModel.XSSFRow.Height">
  4038. Get the row's height measured in twips (1/20th of a point). If the height is not Set, the default worksheet value is returned,
  4039. See {@link NPOI.XSSF.usermodel.XSSFSheet#GetDefaultRowHeightInPoints()}
  4040. @return row height measured in twips (1/20th of a point)
  4041. </member>
  4042. <member name="P:NPOI.XSSF.UserModel.XSSFRow.HeightInPoints">
  4043. Returns row height measured in point size. If the height is not Set, the default worksheet value is returned,
  4044. See {@link NPOI.XSSF.usermodel.XSSFSheet#GetDefaultRowHeightInPoints()}
  4045. @return row height measured in point size
  4046. @see NPOI.XSSF.usermodel.XSSFSheet#GetDefaultRowHeightInPoints()
  4047. </member>
  4048. <member name="P:NPOI.XSSF.UserModel.XSSFRow.PhysicalNumberOfCells">
  4049. Gets the number of defined cells (NOT number of cells in the actual row!).
  4050. That is to say if only columns 0,4,5 have values then there would be 3.
  4051. @return int representing the number of defined cells in the row.
  4052. </member>
  4053. <member name="P:NPOI.XSSF.UserModel.XSSFRow.RowNum">
  4054. Get row number this row represents
  4055. @return the row number (0 based)
  4056. </member>
  4057. <member name="P:NPOI.XSSF.UserModel.XSSFRow.ZeroHeight">
  4058. Get whether or not to display this row with 0 height
  4059. @return - height is zero or not.
  4060. </member>
  4061. <member name="P:NPOI.XSSF.UserModel.XSSFRow.IsFormatted">
  4062. Is this row formatted? Most aren't, but some rows
  4063. do have whole-row styles. For those that do, you
  4064. can get the formatting from {@link #GetRowStyle()}
  4065. </member>
  4066. <member name="P:NPOI.XSSF.UserModel.XSSFRow.RowStyle">
  4067. Returns the whole-row cell style. Most rows won't
  4068. have one of these, so will return null. Call
  4069. {@link #isFormatted()} to check first.
  4070. </member>
  4071. <member name="T:NPOI.XSSF.UserModel.XSSFShapeGroup">
  4072. This object specifies a group shape that represents many shapes grouped together. This shape is to be treated
  4073. just as if it were a regular shape but instead of being described by a single geometry it is made up of all the
  4074. shape geometries encompassed within it. Within a group shape each of the shapes that make up the group are
  4075. specified just as they normally would.
  4076. @author Yegor Kozlov
  4077. </member>
  4078. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_GroupShape)">
  4079. Construct a new XSSFSimpleShape object.
  4080. @param Drawing the XSSFDrawing that owns this shape
  4081. @param ctGroup the XML bean that stores this group content
  4082. </member>
  4083. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.Prototype">
  4084. Initialize default structure of a new shape group
  4085. </member>
  4086. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreateTextbox(NPOI.XSSF.UserModel.XSSFChildAnchor)">
  4087. Constructs a textbox.
  4088. @param anchor the child anchor describes how this shape is attached
  4089. to the group.
  4090. @return the newly Created textbox.
  4091. </member>
  4092. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreateSimpleShape(NPOI.XSSF.UserModel.XSSFChildAnchor)">
  4093. Creates a simple shape. This includes such shapes as lines, rectangles,
  4094. and ovals.
  4095. @param anchor the child anchor describes how this shape is attached
  4096. to the group.
  4097. @return the newly Created shape.
  4098. </member>
  4099. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreateConnector(NPOI.XSSF.UserModel.XSSFChildAnchor)">
  4100. Creates a simple shape. This includes such shapes as lines, rectangles,
  4101. and ovals.
  4102. @param anchor the child anchor describes how this shape is attached
  4103. to the group.
  4104. @return the newly Created shape.
  4105. </member>
  4106. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreatePicture(NPOI.XSSF.UserModel.XSSFClientAnchor,System.Int32)">
  4107. Creates a picture.
  4108. @param anchor the client anchor describes how this picture is attached to the sheet.
  4109. @param pictureIndex the index of the picture in the workbook collection of pictures,
  4110. {@link XSSFWorkbook#getAllPictures()} .
  4111. @return the newly Created picture shape.
  4112. </member>
  4113. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.SetCoordinates(System.Int32,System.Int32,System.Int32,System.Int32)">
  4114. Sets the coordinate space of this group. All children are constrained
  4115. to these coordinates.
  4116. </member>
  4117. <member name="T:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting">
  4118. @author Yegor Kozlov
  4119. </member>
  4120. <member name="M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ComparisonOperator,System.String,System.String)">
  4121. A factory method allowing to create a conditional formatting rule
  4122. with a cell comparison operator<p/>
  4123. TODO - formulas Containing cell references are currently not Parsed properly
  4124. @param comparisonOperation - a constant value from
  4125. <tt>{@link NPOI.hssf.record.CFRuleRecord.ComparisonOperator}</tt>: <p>
  4126. <ul>
  4127. <li>BETWEEN</li>
  4128. <li>NOT_BETWEEN</li>
  4129. <li>EQUAL</li>
  4130. <li>NOT_EQUAL</li>
  4131. <li>GT</li>
  4132. <li>LT</li>
  4133. <li>GE</li>
  4134. <li>LE</li>
  4135. </ul>
  4136. </p>
  4137. @param formula1 - formula for the valued, Compared with the cell
  4138. @param formula2 - second formula (only used with
  4139. {@link NPOI.ss.usermodel.ComparisonOperator#BETWEEN}) and
  4140. {@link NPOI.ss.usermodel.ComparisonOperator#NOT_BETWEEN} operations)
  4141. </member>
  4142. <!-- 对于成员“M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingRule(System.String)”忽略有格式错误的 XML 注释 -->
  4143. <!-- 对于成员“M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.UserModel.IConditionalFormatting)”忽略有格式错误的 XML 注释 -->
  4144. <member name="M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.GetConditionalFormattingAt(System.Int32)">
  4145. Gets Conditional Formatting object at a particular index
  4146. @param index
  4147. of the Conditional Formatting object to fetch
  4148. @return Conditional Formatting object
  4149. </member>
  4150. <member name="M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.RemoveConditionalFormatting(System.Int32)">
  4151. Removes a Conditional Formatting object by index
  4152. @param index of a Conditional Formatting object to remove
  4153. </member>
  4154. <member name="P:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.NumConditionalFormattings">
  4155. @return number of Conditional Formatting objects of the sheet
  4156. </member>
  4157. <member name="T:NPOI.XSSF.UserModel.XSSFSimpleShape">
  4158. Represents a shape with a predefined geometry in a SpreadsheetML Drawing.
  4159. Possible shape types are defined in {@link NPOI.ss.usermodel.ShapeTypes}
  4160. @author Yegor Kozlov
  4161. </member>
  4162. <member name="F:NPOI.XSSF.UserModel.XSSFSimpleShape.prototype">
  4163. A default instance of CT_Shape used for creating new shapes.
  4164. </member>
  4165. <member name="F:NPOI.XSSF.UserModel.XSSFSimpleShape.ctShape">
  4166. Xml bean that stores properties of this shape
  4167. </member>
  4168. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.Prototype">
  4169. Prototype with the default structure of a new auto-shape.
  4170. </member>
  4171. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.ApplyAttributes(NPOI.OpenXmlFormats.Spreadsheet.CT_RPrElt,NPOI.OpenXmlFormats.Dml.CT_TextCharacterProperties)">
  4172. org.openxmlformats.schemas.spreadsheetml.x2006.main.CTRPrElt to
  4173. org.openxmlformats.schemas.drawingml.x2006.main.CTFont adapter
  4174. </member>
  4175. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.ShapeType">
  4176. Gets the shape type, one of the constants defined in {@link NPOI.ss.usermodel.ShapeTypes}.
  4177. @return the shape type
  4178. @see NPOI.ss.usermodel.ShapeTypes
  4179. </member>
  4180. <member name="T:NPOI.XSSF.UserModel.XSSFTable">
  4181. This class : the Table Part (Open Office XML Part 4:
  4182. chapter 3.5.1)
  4183. This implementation works under the assumption that a table Contains mappings to a subtree of an XML.
  4184. The root element of this subtree an occur multiple times (one for each row of the table). The child nodes
  4185. of the root element can be only attributes or element with maxOccurs=1 property set
  4186. @author Roberto Manicardi
  4187. </member>
  4188. <member name="M:NPOI.XSSF.UserModel.XSSFTable.MapsTo(System.Int64)">
  4189. Checks if this Table element Contains even a single mapping to the map identified by id
  4190. @param id the XSSFMap ID
  4191. @return true if the Table element contain mappings
  4192. </member>
  4193. <member name="M:NPOI.XSSF.UserModel.XSSFTable.GetCommonXpath">
  4194. Calculates the xpath of the root element for the table. This will be the common part
  4195. of all the mapping's xpaths
  4196. @return the xpath of the table's root element
  4197. </member>
  4198. <member name="M:NPOI.XSSF.UserModel.XSSFTable.GetStartCellReference">
  4199. @return The reference for the cell in the top-left part of the table
  4200. (see Open Office XML Part 4: chapter 3.5.1.2, attribute ref)
  4201. </member>
  4202. <member name="M:NPOI.XSSF.UserModel.XSSFTable.GetEndCellReference">
  4203. @return The reference for the cell in the bottom-right part of the table
  4204. (see Open Office XML Part 4: chapter 3.5.1.2, attribute ref)
  4205. </member>
  4206. <member name="M:NPOI.XSSF.UserModel.XSSFTable.UpdateHeaders">
  4207. Synchronize table headers with cell values in the parent sheet.
  4208. Headers <em>must</em> be in sync, otherwise Excel will display a
  4209. "Found unreadable content" message on startup.
  4210. </member>
  4211. <member name="P:NPOI.XSSF.UserModel.XSSFTable.Name">
  4212. @return the name of the Table, if set
  4213. </member>
  4214. <member name="P:NPOI.XSSF.UserModel.XSSFTable.DisplayName">
  4215. @return the display name of the Table, if set
  4216. </member>
  4217. <member name="P:NPOI.XSSF.UserModel.XSSFTable.NumberOfMappedColumns">
  4218. @return the number of mapped table columns (see Open Office XML Part 4: chapter 3.5.1.4)
  4219. </member>
  4220. <member name="P:NPOI.XSSF.UserModel.XSSFTable.RowCount">
  4221. @return the total number of rows in the selection. (Note: in this version autofiltering is ignored)
  4222. </member>
  4223. <member name="T:NPOI.XSSF.UserModel.XSSFTextBox">
  4224. Represents a text box in a SpreadsheetML Drawing.
  4225. @author Yegor Kozlov
  4226. </member>
  4227. <member name="T:NPOI.XSSF.UserModel.XSSFVMLDrawing">
  4228. Represents a SpreadsheetML VML Drawing.
  4229. <p>
  4230. In Excel 2007 VML Drawings are used to describe properties of cell comments,
  4231. although the spec says that VML is deprecated:
  4232. </p>
  4233. <p>
  4234. The VML format is a legacy format originally introduced with Office 2000 and is included and fully defined
  4235. in this Standard for backwards compatibility reasons. The DrawingML format is a newer and richer format
  4236. Created with the goal of eventually replacing any uses of VML in the Office Open XML formats. VML should be
  4237. considered a deprecated format included in Office Open XML for legacy reasons only and new applications that
  4238. need a file format for Drawings are strongly encouraged to use preferentially DrawingML
  4239. </p>
  4240. <p>
  4241. Warning - Excel is known to Put invalid XML into these files!
  4242. For example, &gt;br&lt; without being closed or escaped crops up.
  4243. </p>
  4244. See 6.4 VML - SpreadsheetML Drawing in Office Open XML Part 4 - Markup Language Reference.pdf
  4245. @author Yegor Kozlov
  4246. </member>
  4247. <member name="F:NPOI.XSSF.UserModel.XSSFVMLDrawing.ptrn_shapeId">
  4248. regexp to parse shape ids, in VML they have weird form of id="_x0000_s1026"
  4249. </member>
  4250. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.#ctor">
  4251. Create a new SpreadsheetML Drawing
  4252. @see XSSFSheet#CreateDrawingPatriarch()
  4253. </member>
  4254. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  4255. Construct a SpreadsheetML Drawing from a namespace part
  4256. @param part the namespace part holding the Drawing data,
  4257. the content type must be <code>application/vnd.Openxmlformats-officedocument.Drawing+xml</code>
  4258. @param rel the namespace relationship holding this Drawing,
  4259. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/drawing
  4260. </member>
  4261. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.newDrawing">
  4262. Initialize a new Speadsheet VML Drawing
  4263. </member>
  4264. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.FindCommentShape(System.Int32,System.Int32)">
  4265. Find a shape with ClientData of type "NOTE" and the specified row and column
  4266. @return the comment shape or <code>null</code>
  4267. </member>
  4268. <member name="T:NPOI.XSSF.UserModel.XSSFWorkbook">
  4269. High level representation of a SpreadsheetML workbook. This is the first object most users
  4270. will construct whether they are Reading or writing a workbook. It is also the
  4271. top level object for creating new sheets/etc.
  4272. </member>
  4273. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.DEFAULT_CHARACTER_WIDTH">
  4274. Width of one character of the default font in pixels. Same for Calibry and Arial.
  4275. </member>
  4276. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.Max_SENSITIVE_SHEET_NAME_LEN">
  4277. Excel silently tRuncates long sheet names to 31 chars.
  4278. This constant is used to ensure uniqueness in the first 31 chars
  4279. </member>
  4280. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_EMF">
  4281. Extended windows meta file
  4282. </member>
  4283. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_WMF">
  4284. Windows Meta File
  4285. </member>
  4286. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_PICT">
  4287. Mac PICT format
  4288. </member>
  4289. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_JPEG">
  4290. JPEG format
  4291. </member>
  4292. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_PNG">
  4293. PNG format
  4294. </member>
  4295. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_DIB">
  4296. Device independent bitmap
  4297. </member>
  4298. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_GIF">
  4299. Images formats supported by XSSF but not by HSSF
  4300. </member>
  4301. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.workbook">
  4302. The underlying XML bean
  4303. </member>
  4304. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.sheets">
  4305. this holds the XSSFSheet objects attached to this workbook
  4306. </member>
  4307. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.namedRanges">
  4308. this holds the XSSFName objects attached to this workbook
  4309. </member>
  4310. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.sharedStringSource">
  4311. shared string table - a cache of strings in this workbook
  4312. </member>
  4313. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.stylesSource">
  4314. A collection of shared objects used for styling content,
  4315. e.g. fonts, cell styles, colors, etc.
  4316. </member>
  4317. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook._udfFinder">
  4318. The locator of user-defined functions.
  4319. By default includes functions from the Excel Analysis Toolpack
  4320. </member>
  4321. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.calcChain">
  4322. TODO
  4323. </member>
  4324. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.mapInfo">
  4325. A collection of custom XML mappings
  4326. </member>
  4327. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.formatter">
  4328. Used to keep track of the data formatter so that all
  4329. CreateDataFormatter calls return the same one for a given
  4330. book. This ensures that updates from one places is visible
  4331. someplace else.
  4332. </member>
  4333. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook._missingCellPolicy">
  4334. The policy to apply in the event of missing or
  4335. blank cells when fetching from a row.
  4336. See {@link NPOI.ss.usermodel.Row.MissingCellPolicy}
  4337. </member>
  4338. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.pictures">
  4339. array of pictures for this workbook
  4340. </member>
  4341. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook._creationHelper">
  4342. cached instance of XSSFCreationHelper for this workbook
  4343. @see {@link #getCreationHelper()}
  4344. </member>
  4345. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor">
  4346. Create a new SpreadsheetML workbook.
  4347. </member>
  4348. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage)">
  4349. Constructs a XSSFWorkbook object given a OpenXML4J <code>Package</code> object,
  4350. see <a href="http://poi.apache.org/oxml4j/">http://poi.apache.org/oxml4j/</a>.
  4351. Once you have finished working with the Workbook, you should close the package
  4352. by calling pkg.close, to avoid leaving file handles open.
  4353. Creating a XSSFWorkbook from a file-backed OPC Package has a lower memory
  4354. footprint than an InputStream backed one.
  4355. @param pkg the OpenXML4J <code>OPC Package</code> object.
  4356. </member>
  4357. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(System.IO.Stream)">
  4358. Constructs a XSSFWorkbook object, by buffering the whole stream into memory
  4359. and then opening an {@link OPCPackage} object for it.
  4360. Using an {@link InputStream} requires more memory than using a File, so
  4361. if a {@link File} is available then you should instead do something like
  4362. <pre><code>
  4363. OPCPackage pkg = OPCPackage.open(path);
  4364. XSSFWorkbook wb = new XSSFWorkbook(pkg);
  4365. // work with the wb object
  4366. ......
  4367. pkg.close(); // gracefully closes the underlying zip file
  4368. </code></pre>
  4369. </member>
  4370. <!-- 对于成员“M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(System.String)”忽略有格式错误的 XML 注释 -->
  4371. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.OnWorkbookCreate">
  4372. Create a new CT_Workbook with all values Set to default
  4373. </member>
  4374. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.newPackage">
  4375. Create a new SpreadsheetML namespace and Setup the default minimal content
  4376. </member>
  4377. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCTWorkbook">
  4378. Return the underlying XML bean
  4379. @return the underlying CT_Workbook bean
  4380. </member>
  4381. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddPicture(System.Byte[],System.Int32)">
  4382. Adds a picture to the workbook.
  4383. @param pictureData The bytes of the picture
  4384. @param format The format of the picture.
  4385. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  4386. @see Workbook#PICTURE_TYPE_EMF
  4387. @see Workbook#PICTURE_TYPE_WMF
  4388. @see Workbook#PICTURE_TYPE_PICT
  4389. @see Workbook#PICTURE_TYPE_JPEG
  4390. @see Workbook#PICTURE_TYPE_PNG
  4391. @see Workbook#PICTURE_TYPE_DIB
  4392. @see #getAllPictures()
  4393. </member>
  4394. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddPicture(System.IO.Stream,System.Int32)">
  4395. Adds a picture to the workbook.
  4396. @param is The sream to read image from
  4397. @param format The format of the picture.
  4398. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  4399. @see Workbook#PICTURE_TYPE_EMF
  4400. @see Workbook#PICTURE_TYPE_WMF
  4401. @see Workbook#PICTURE_TYPE_PICT
  4402. @see Workbook#PICTURE_TYPE_JPEG
  4403. @see Workbook#PICTURE_TYPE_PNG
  4404. @see Workbook#PICTURE_TYPE_DIB
  4405. @see #getAllPictures()
  4406. </member>
  4407. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CloneSheet(System.Int32)">
  4408. Create an XSSFSheet from an existing sheet in the XSSFWorkbook.
  4409. The Cloned sheet is a deep copy of the original.
  4410. @return XSSFSheet representing the Cloned sheet.
  4411. @throws ArgumentException if the sheet index in invalid
  4412. @throws POIXMLException if there were errors when cloning
  4413. </member>
  4414. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateCellStyle">
  4415. Create a new XSSFCellStyle and add it to the workbook's style table
  4416. @return the new XSSFCellStyle object
  4417. </member>
  4418. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateDataFormat">
  4419. Returns the instance of XSSFDataFormat for this workbook.
  4420. @return the XSSFDataFormat object
  4421. @see NPOI.ss.usermodel.DataFormat
  4422. </member>
  4423. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateFont">
  4424. Create a new Font and add it to the workbook's font table
  4425. @return new font object
  4426. </member>
  4427. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateSheet">
  4428. Create an XSSFSheet for this workbook, Adds it to the sheets and returns
  4429. the high level representation. Use this to create new sheets.
  4430. @return XSSFSheet representing the new sheet.
  4431. </member>
  4432. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateSheet(System.String)">
  4433. Create a new sheet for this Workbook and return the high level representation.
  4434. Use this to create new sheets.
  4435. <p>
  4436. Note that Excel allows sheet names up to 31 chars in length but other applications
  4437. (such as OpenOffice) allow more. Some versions of Excel crash with names longer than 31 chars,
  4438. others - tRuncate such names to 31 character.
  4439. </p>
  4440. <p>
  4441. POI's SpreadsheetAPI silently tRuncates the input argument to 31 characters.
  4442. Example:
  4443. <pre><code>
  4444. Sheet sheet = workbook.CreateSheet("My very long sheet name which is longer than 31 chars"); // will be tRuncated
  4445. assert 31 == sheet.SheetName.Length;
  4446. assert "My very long sheet name which i" == sheet.SheetName;
  4447. </code></pre>
  4448. </p>
  4449. Except the 31-character constraint, Excel applies some other rules:
  4450. <p>
  4451. Sheet name MUST be unique in the workbook and MUST NOT contain the any of the following characters:
  4452. <ul>
  4453. <li> 0x0000 </li>
  4454. <li> 0x0003 </li>
  4455. <li> colon (:) </li>
  4456. <li> backslash (\) </li>
  4457. <li> asterisk (*) </li>
  4458. <li> question mark (?) </li>
  4459. <li> forward slash (/) </li>
  4460. <li> opening square bracket ([) </li>
  4461. <li> closing square bracket (]) </li>
  4462. </ul>
  4463. The string MUST NOT begin or end with the single quote (') character.
  4464. </p>
  4465. <p>
  4466. See {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)}
  4467. for a safe way to create valid names
  4468. </p>
  4469. @param sheetname sheetname to set for the sheet.
  4470. @return Sheet representing the new sheet.
  4471. @throws IllegalArgumentException if the name is null or invalid
  4472. or workbook already contains a sheet with this name
  4473. @see org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)
  4474. </member>
  4475. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.FindFont(System.Int16,System.Int16,System.Int16,System.String,System.Boolean,System.Boolean,NPOI.SS.UserModel.FontSuperScript,NPOI.SS.UserModel.FontUnderlineType)">
  4476. Finds a font that matches the one with the supplied attributes
  4477. </member>
  4478. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetAllPictures">
  4479. Gets all pictures from the Workbook.
  4480. @return the list of pictures (a list of {@link XSSFPictureData} objects.)
  4481. @see #AddPicture(byte[], int)
  4482. </member>
  4483. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCellStyleAt(System.Int16)">
  4484. Get the cell style object at the given index
  4485. @param idx index within the Set of styles
  4486. @return XSSFCellStyle object at the index
  4487. </member>
  4488. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetFontAt(System.Int16)">
  4489. Get the font at the given index number
  4490. @param idx index number
  4491. @return XSSFFont at the index
  4492. </member>
  4493. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetNameIndex(System.String)">
  4494. Gets the named range index by his name
  4495. <i>Note:</i>Excel named ranges are case-insensitive and
  4496. this method performs a case-insensitive search.
  4497. @param name named range name
  4498. @return named range index
  4499. </member>
  4500. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetPrintArea(System.Int32)">
  4501. Retrieves the reference for the printarea of the specified sheet, the sheet name is Appended to the reference even if it was not specified.
  4502. @param sheetIndex Zero-based sheet index (0 Represents the first sheet to keep consistent with java)
  4503. @return String Null if no print area has been defined
  4504. </member>
  4505. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheet(System.String)">
  4506. Get sheet with the given name (case insensitive match)
  4507. @param name of the sheet
  4508. @return XSSFSheet with the name provided or <code>null</code> if it does not exist
  4509. </member>
  4510. <!-- 对于成员“M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetAt(System.Int32)”忽略有格式错误的 XML 注释 -->
  4511. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetIndex(System.String)">
  4512. <summary>
  4513. Returns the index of the sheet by his name (case insensitive match)
  4514. </summary>
  4515. <param name="name">the sheet name</param>
  4516. <returns>index of the sheet (0 based) or -1 if not found</returns>
  4517. </member>
  4518. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetIndex(NPOI.SS.UserModel.ISheet)">
  4519. Returns the index of the given sheet
  4520. @param sheet the sheet to look up
  4521. @return index of the sheet (0 based). <tt>-1</tt> if not found
  4522. </member>
  4523. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetName(System.Int32)">
  4524. Get the sheet name
  4525. @param sheetIx Number
  4526. @return Sheet name
  4527. </member>
  4528. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetEnumerator">
  4529. Allows foreach loops:
  4530. <pre><code>
  4531. XSSFWorkbook wb = new XSSFWorkbook(package);
  4532. for(XSSFSheet sheet : wb){
  4533. }
  4534. </code></pre>
  4535. </member>
  4536. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsMacroEnabled">
  4537. Are we a normal workbook (.xlsx), or a
  4538. macro enabled workbook (.xlsm)?
  4539. </member>
  4540. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.RemoveName(NPOI.XSSF.UserModel.XSSFName)">
  4541. As {@link #removeName(String)} is not necessarily unique
  4542. (name + sheet index is unique), this method is more accurate.
  4543. @param name the name to remove.
  4544. </member>
  4545. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.RemovePrintArea(System.Int32)">
  4546. Delete the printarea for the sheet specified
  4547. @param sheetIndex 0-based sheet index (0 = First Sheet)
  4548. </member>
  4549. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.RemoveSheetAt(System.Int32)">
  4550. Removes sheet at the given index.<p/>
  4551. Care must be taken if the Removed sheet is the currently active or only selected sheet in
  4552. the workbook. There are a few situations when Excel must have a selection and/or active
  4553. sheet. (For example when printing - see Bug 40414).<br/>
  4554. This method Makes sure that if the Removed sheet was active, another sheet will become
  4555. active in its place. Furthermore, if the Removed sheet was the only selected sheet, another
  4556. sheet will become selected. The newly active/selected sheet will have the same index, or
  4557. one less if the Removed sheet was the last in the workbook.
  4558. @param index of the sheet (0-based)
  4559. </member>
  4560. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.OnSheetDelete(System.Int32)">
  4561. Gracefully remove references to the sheet being deleted
  4562. @param index the 0-based index of the sheet to delete
  4563. </member>
  4564. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.ValidateSheetIndex(System.Int32)">
  4565. Validate sheet index
  4566. @param index the index to validate
  4567. @throws ArgumentException if the index is out of range (index
  4568. &lt; 0 || index &gt;= NumberOfSheets).
  4569. </member>
  4570. <!-- 对于成员“M:NPOI.XSSF.UserModel.XSSFWorkbook.SetPrintArea(System.Int32,System.String)”忽略有格式错误的 XML 注释 -->
  4571. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetPrintArea(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  4572. For the Convenience of Java Programmers maintaining pointers.
  4573. @see #setPrintArea(int, String)
  4574. @param sheetIndex Zero-based sheet index (0 = First Sheet)
  4575. @param startColumn Column to begin printarea
  4576. @param endColumn Column to end the printarea
  4577. @param startRow Row to begin the printarea
  4578. @param endRow Row to end the printarea
  4579. </member>
  4580. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetRepeatingRowsAndColumns(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  4581. Sets the repeating rows and columns for a sheet.
  4582. <p/>
  4583. To Set just repeating columns:
  4584. <pre>
  4585. workbook.SetRepeatingRowsAndColumns(0,0,1,-1,-1);
  4586. </pre>
  4587. To Set just repeating rows:
  4588. <pre>
  4589. workbook.SetRepeatingRowsAndColumns(0,-1,-1,0,4);
  4590. </pre>
  4591. To remove all repeating rows and columns for a sheet.
  4592. <pre>
  4593. workbook.SetRepeatingRowsAndColumns(0,-1,-1,-1,-1);
  4594. </pre>
  4595. @param sheetIndex 0 based index to sheet.
  4596. @param startColumn 0 based start of repeating columns.
  4597. @param endColumn 0 based end of repeating columns.
  4598. @param startRow 0 based start of repeating rows.
  4599. @param endRow 0 based end of repeating rows.
  4600. </member>
  4601. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateBuiltInName(System.String,System.Int32)">
  4602. Generates a NameRecord to represent a built-in region
  4603. @return a new NameRecord
  4604. @throws ArgumentException if sheetNumber is invalid
  4605. @throws POIXMLException if such a name already exists in the workbook
  4606. </member>
  4607. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSelectedTab(System.Int32)">
  4608. We only Set one sheet as selected for compatibility with HSSF.
  4609. </member>
  4610. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetName(System.Int32,System.String)">
  4611. Set the sheet name.
  4612. @param sheetIndex sheet number (0 based)
  4613. @param sheetname the new sheet name
  4614. @throws ArgumentException if the name is null or invalid
  4615. or workbook already Contains a sheet with this name
  4616. @see {@link #CreateSheet(String)}
  4617. @see {@link NPOI.ss.util.WorkbookUtil#CreateSafeSheetName(String nameProposal)}
  4618. for a safe way to create valid names
  4619. </member>
  4620. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetOrder(System.String,System.Int32)">
  4621. Sets the order of appearance for a given sheet.
  4622. @param sheetname the name of the sheet to reorder
  4623. @param pos the position that we want to insert the sheet into (0 based)
  4624. </member>
  4625. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SaveNamedRanges">
  4626. marshal named ranges from the {@link #namedRanges} collection to the underlying CT_Workbook bean
  4627. </member>
  4628. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSharedStringSource">
  4629. Returns SharedStringsTable - tha cache of string for this workbook
  4630. @return the shared string table
  4631. </member>
  4632. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetStylesSource">
  4633. Return a object representing a collection of shared objects used for styling content,
  4634. e.g. fonts, cell styles, colors, etc.
  4635. </member>
  4636. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetTheme">
  4637. Returns the Theme of current workbook.
  4638. </member>
  4639. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCreationHelper">
  4640. Returns an object that handles instantiating concrete
  4641. classes of the various instances for XSSF.
  4642. </member>
  4643. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.ContainsSheet(System.String,System.Int32)">
  4644. Determines whether a workbook Contains the provided sheet name.
  4645. For the purpose of comparison, long names are tRuncated to 31 chars.
  4646. @param name the name to Test (case insensitive match)
  4647. @param excludeSheetIdx the sheet to exclude from the check or -1 to include all sheets in the Check.
  4648. @return true if the sheet Contains the name, false otherwise.
  4649. </member>
  4650. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsDate1904">
  4651. Gets a bool value that indicates whether the date systems used in the workbook starts in 1904.
  4652. <p>
  4653. The default value is false, meaning that the workbook uses the 1900 date system,
  4654. where 1/1/1900 is the first day in the system..
  4655. </p>
  4656. @return true if the date systems used in the workbook starts in 1904
  4657. </member>
  4658. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetAllEmbedds">
  4659. Get the document's embedded files.
  4660. </member>
  4661. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsSheetHidden(System.Int32)">
  4662. Check whether a sheet is hidden.
  4663. <p>
  4664. Note that a sheet could instead be Set to be very hidden, which is different
  4665. ({@link #isSheetVeryHidden(int)})
  4666. </p>
  4667. @param sheetIx Number
  4668. @return <code>true</code> if sheet is hidden
  4669. </member>
  4670. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsSheetVeryHidden(System.Int32)">
  4671. Check whether a sheet is very hidden.
  4672. <p>
  4673. This is different from the normal hidden status
  4674. ({@link #isSheetHidden(int)})
  4675. </p>
  4676. @param sheetIx sheet index to check
  4677. @return <code>true</code> if sheet is very hidden
  4678. </member>
  4679. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetHidden(System.Int32,System.Boolean)">
  4680. Sets the visible state of this sheet.
  4681. <p>
  4682. Calling <code>setSheetHidden(sheetIndex, true)</code> is equivalent to
  4683. <code>setSheetHidden(sheetIndex, Workbook.SHEET_STATE_HIDDEN)</code>.
  4684. <br/>
  4685. Calling <code>setSheetHidden(sheetIndex, false)</code> is equivalent to
  4686. <code>setSheetHidden(sheetIndex, Workbook.SHEET_STATE_VISIBLE)</code>.
  4687. </p>
  4688. @param sheetIx the 0-based index of the sheet
  4689. @param hidden whether this sheet is hidden
  4690. @see #setSheetHidden(int, int)
  4691. </member>
  4692. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetHidden(System.Int32,NPOI.SS.UserModel.SheetState)">
  4693. Hide or unhide a sheet.
  4694. <ul>
  4695. <li>0 - visible. </li>
  4696. <li>1 - hidden. </li>
  4697. <li>2 - very hidden.</li>
  4698. </ul>
  4699. @param sheetIx the sheet index (0-based)
  4700. @param state one of the following <code>Workbook</code> constants:
  4701. <code>Workbook.SHEET_STATE_VISIBLE</code>,
  4702. <code>Workbook.SHEET_STATE_HIDDEN</code>, or
  4703. <code>Workbook.SHEET_STATE_VERY_HIDDEN</code>.
  4704. @throws ArgumentException if the supplied sheet index or state is invalid
  4705. </member>
  4706. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetHidden(System.Int32,System.Int32)">
  4707. <summary>
  4708. Hide or unhide a sheet.
  4709. </summary>
  4710. <param name="sheetIx">The sheet number</param>
  4711. <param name="hidden">0 for not hidden, 1 for hidden, 2 for very hidden</param>
  4712. </member>
  4713. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.OnDeleteFormula(NPOI.XSSF.UserModel.XSSFCell)">
  4714. Fired when a formula is deleted from this workbook,
  4715. for example when calling cell.SetCellFormula(null)
  4716. @see XSSFCell#setCellFormula(String)
  4717. </member>
  4718. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCalculationChain">
  4719. Return the CalculationChain object for this workbook
  4720. <p>
  4721. The calculation chain object specifies the order in which the cells in a workbook were last calculated
  4722. </p>
  4723. @return the <code>CalculationChain</code> object or <code>null</code> if not defined
  4724. </member>
  4725. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCustomXMLMappings">
  4726. @return a collection of custom XML mappings defined in this workbook
  4727. </member>
  4728. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetMapInfo">
  4729. @return the helper class used to query the custom XML mapping defined in this workbook
  4730. </member>
  4731. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsStructureLocked">
  4732. Specifies a bool value that indicates whether structure of workbook is locked. <br/>
  4733. A value true indicates the structure of the workbook is locked. Worksheets in the workbook can't be Moved,
  4734. deleted, hidden, unhidden, or Renamed, and new worksheets can't be inserted.<br/>
  4735. A value of false indicates the structure of the workbook is not locked.<br/>
  4736. @return true if structure of workbook is locked
  4737. </member>
  4738. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsWindowsLocked">
  4739. Specifies a bool value that indicates whether the windows that comprise the workbook are locked. <br/>
  4740. A value of true indicates the workbook windows are locked. Windows are the same size and position each time the
  4741. workbook is opened.<br/>
  4742. A value of false indicates the workbook windows are not locked.
  4743. @return true if windows that comprise the workbook are locked
  4744. </member>
  4745. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsRevisionLocked">
  4746. Specifies a bool value that indicates whether the workbook is locked for revisions.
  4747. @return true if the workbook is locked for revisions.
  4748. </member>
  4749. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LockStructure">
  4750. Locks the structure of workbook.
  4751. </member>
  4752. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.UnlockStructure">
  4753. Unlocks the structure of workbook.
  4754. </member>
  4755. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LockWindows">
  4756. Locks the windows that comprise the workbook.
  4757. </member>
  4758. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.UnlockWindows">
  4759. Unlocks the windows that comprise the workbook.
  4760. </member>
  4761. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LockRevision">
  4762. Locks the workbook for revisions.
  4763. </member>
  4764. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.UnlockRevision">
  4765. Unlocks the workbook for revisions.
  4766. </member>
  4767. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetUDFFinder">
  4768. Returns the locator of user-defined functions.
  4769. <p>
  4770. The default instance : the built-in functions with the Excel Analysis Tool Pack.
  4771. To Set / Evaluate custom functions you need to register them as follows:
  4772. </p>
  4773. @return wrapped instance of UDFFinder that allows seeking functions both by index and name
  4774. </member>
  4775. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddToolPack(NPOI.SS.Formula.Udf.UDFFinder)">
  4776. Register a new toolpack in this workbook.
  4777. @param toopack the toolpack to register
  4778. </member>
  4779. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetForceFormulaRecalculation(System.Boolean)">
  4780. Whether the application shall perform a full recalculation when the workbook is opened.
  4781. <p>
  4782. Typically you want to force formula recalculation when you modify cell formulas or values
  4783. of a workbook previously Created by Excel. When Set to true, this flag will tell Excel
  4784. that it needs to recalculate all formulas in the workbook the next time the file is opened.
  4785. </p>
  4786. <p>
  4787. Note, that recalculation updates cached formula results and, thus, modifies the workbook.
  4788. Depending on the version, Excel may prompt you with "Do you want to save the Changes in <em>filename</em>?"
  4789. on close.
  4790. </p>
  4791. @param value true if the application will perform a full recalculation of
  4792. workbook values when the workbook is opened
  4793. @since 3.8
  4794. </member>
  4795. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetForceFormulaRecalculation">
  4796. Whether Excel will be asked to recalculate all formulas when the workbook is opened.
  4797. @since 3.8
  4798. </member>
  4799. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.ActiveSheetIndex">
  4800. Convenience method to Get the active sheet. The active sheet is is the sheet
  4801. which is currently displayed when the workbook is viewed in Excel.
  4802. 'Selected' sheet(s) is a distinct concept.
  4803. </member>
  4804. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumCellStyles">
  4805. Get the number of styles the workbook Contains
  4806. @return count of cell styles
  4807. </member>
  4808. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumberOfFonts">
  4809. Get the number of fonts in the this workbook
  4810. @return number of fonts
  4811. </member>
  4812. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumberOfNames">
  4813. Get the number of named ranges in the this workbook
  4814. @return number of named ranges
  4815. </member>
  4816. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumberOfSheets">
  4817. Get the number of worksheets in the this workbook
  4818. @return number of worksheets
  4819. </member>
  4820. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.MissingCellPolicy">
  4821. Retrieves the current policy on what to do when
  4822. Getting missing or blank cells from a row.
  4823. The default is to return blank and null cells.
  4824. {@link MissingCellPolicy}
  4825. </member>
  4826. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.FirstVisibleTab">
  4827. Gets the first tab that is displayed in the list of tabs in excel.
  4828. @return integer that Contains the index to the active sheet in this book view.
  4829. </member>
  4830. <member name="T:NPOI.XSSF.Util.EvilUnclosedBRFixingInputStream">
  4831. This is a seriously sick fix for the fact that some .xlsx
  4832. files contain raw bits of HTML, without being escaped
  4833. or properly turned into XML.
  4834. The result is that they contain things like &gt;br&lt;,
  4835. which breaks the XML parsing.
  4836. This very sick InputStream wrapper attempts to spot
  4837. these go past, and fix them.
  4838. Only works for UTF-8 and US-ASCII based streams!
  4839. It should only be used where experience Shows the problem
  4840. can occur...
  4841. </member>
  4842. <member name="M:NPOI.XSSF.Util.EvilUnclosedBRFixingInputStream.Read">
  4843. Warning - doesn't fix!
  4844. </member>
  4845. <member name="M:NPOI.XSSF.Util.EvilUnclosedBRFixingInputStream.ReadFromSpare(System.Byte[],System.Int32,System.Int32)">
  4846. Reads into the buffer from the spare bytes
  4847. </member>
  4848. <member name="T:NPOI.XWPF.Extractor.XWPFWordExtractor">
  4849. Helper class to extract text from an OOXML Word file
  4850. </member>
  4851. <member name="M:NPOI.XWPF.Extractor.XWPFWordExtractor.SetFetchHyperlinks(System.Boolean)">
  4852. Should we also fetch the hyperlinks, when fetching
  4853. the text content? Default is to only output the
  4854. hyperlink label, and not the contents
  4855. </member>
  4856. <member name="T:NPOI.XWPF.Model.XMLParagraph">
  4857. Base class for XWPF paragraphs
  4858. @author Yury Batrakov (batrakov at gmail.com)
  4859. </member>
  4860. <member name="T:NPOI.XWPF.Model.XWPFCommentsDecorator">
  4861. Decorator class for XWPFParagraph allowing to add comments
  4862. found in paragraph to its text
  4863. @author Yury Batrakov (batrakov at gmail.com)
  4864. </member>
  4865. <member name="T:NPOI.XWPF.Model.XWPFParagraphDecorator">
  4866. Base decorator class for XWPFParagraph
  4867. </member>
  4868. <member name="T:NPOI.XWPF.Model.XWPFHeaderFooterPolicy">
  4869. A .docx file can have no headers/footers, the same header/footer
  4870. on each page, odd/even page footers, and optionally also
  4871. a different header/footer on the first page.
  4872. This class handles sorting out what there is, and giving you
  4873. the right headers and footers for the document.
  4874. </member>
  4875. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.#ctor(NPOI.XWPF.UserModel.XWPFDocument)">
  4876. Figures out the policy for the given document,
  4877. and Creates any header and footer objects
  4878. as required.
  4879. </member>
  4880. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.#ctor(NPOI.XWPF.UserModel.XWPFDocument,NPOI.OpenXmlFormats.Wordprocessing.CT_SectPr)">
  4881. Figures out the policy for the given document,
  4882. and Creates any header and footer objects
  4883. as required.
  4884. </member>
  4885. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.buildHdrFtr(System.String,NPOI.XWPF.UserModel.XWPFParagraph[],NPOI.XWPF.UserModel.XWPFHeaderFooter)">
  4886. MB 24 May 2010. Created this overloaded buildHdrFtr() method because testing demonstrated
  4887. that the XWPFFooter or XWPFHeader object returned by calls to the CreateHeader(int, XWPFParagraph[])
  4888. and CreateFooter(int, XWPFParagraph[]) methods or the GetXXXXXHeader/Footer methods where
  4889. headers or footers had been Added to a document since it had been Created/opened, returned
  4890. an object that Contained no XWPFParagraph objects even if the header/footer itself did contain
  4891. text. The reason was that this line of code; CTHdrFtr ftr = CTHdrFtr.Factory.NewInstance();
  4892. Created a brand new instance of the CTHDRFtr class which was then populated with data when
  4893. it should have recovered the CTHdrFtr object encapsulated within the XWPFHeaderFooter object
  4894. that had previoulsy been instantiated in the CreateHeader(int, XWPFParagraph[]) or
  4895. CreateFooter(int, XWPFParagraph[]) methods.
  4896. </member>
  4897. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.GetOddPageHeader">
  4898. Returns the odd page header. This is
  4899. also the same as the default one...
  4900. </member>
  4901. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.GetOddPageFooter">
  4902. Returns the odd page footer. This is
  4903. also the same as the default one...
  4904. </member>
  4905. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.GetHeader(System.Int32)">
  4906. Get the header that applies to the given
  4907. (1 based) page.
  4908. @param pageNumber The one based page number
  4909. </member>
  4910. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.GetFooter(System.Int32)">
  4911. Get the footer that applies to the given
  4912. (1 based) page.
  4913. @param pageNumber The one based page number
  4914. </member>
  4915. <member name="T:NPOI.XWPF.Model.XWPFHyperlinkDecorator">
  4916. Decorator class for XWPFParagraph allowing to add hyperlinks
  4917. found in paragraph to its text.
  4918. Note - Adds the hyperlink at the end, not in the right place...
  4919. @deprecated Use {@link XWPFHyperlinkRun} instead
  4920. </member>
  4921. <member name="M:NPOI.XWPF.Model.XWPFHyperlinkDecorator.#ctor(NPOI.XWPF.Model.XWPFParagraphDecorator,System.Boolean)">
  4922. @param nextDecorator The next decorator to use
  4923. @param outputHyperlinkUrls Should we output the links too, or just the link text?
  4924. </member>
  4925. <member name="M:NPOI.XWPF.Model.XWPFHyperlinkDecorator.#ctor(NPOI.XWPF.UserModel.XWPFParagraph,NPOI.XWPF.Model.XWPFParagraphDecorator,System.Boolean)">
  4926. @param prgrph The paragraph of text to work on
  4927. @param outputHyperlinkUrls Should we output the links too, or just the link text?
  4928. </member>
  4929. <member name="T:NPOI.XWPF.UserModel.BodyElementType">
  4930. <p>
  4931. 9 Jan 2010
  4932. </p>
  4933. <p>
  4934. // TODO insert Javadoc here!
  4935. </p>
  4936. @author epp
  4937. </member>
  4938. <member name="T:NPOI.XWPF.UserModel.BodyType">
  4939. <p>
  4940. 9 Jan 2010
  4941. </p>
  4942. <p>
  4943. // TODO insert Javadoc here!
  4944. </p>
  4945. @author epp
  4946. </member>
  4947. <member name="T:NPOI.XWPF.UserModel.Borders">
  4948. Specifies all types of borders which can be specified for WordProcessingML
  4949. objects which have a border. Borders can be Separated into two types:
  4950. <ul>
  4951. <li> Line borders: which specify a pattern to be used when Drawing a line around the
  4952. specified object.
  4953. </li>
  4954. <li> Art borders: which specify a repeated image to be used
  4955. when Drawing a border around the specified object. Line borders may be
  4956. specified on any object which allows a border, however, art borders may only
  4957. be used as a border at the page level - the borders under the pgBorders
  4958. element
  4959. </li>
  4960. </ul>
  4961. @author Gisella Bronzetti
  4962. </member>
  4963. <member name="F:NPOI.XWPF.UserModel.Borders.SINGLE">
  4964. Specifies a line border consisting of a single line around the parent
  4965. object.
  4966. </member>
  4967. <member name="F:NPOI.XWPF.UserModel.Borders.APPLES">
  4968. Specifies an art border consisting of a repeated image of an apple
  4969. </member>
  4970. <member name="F:NPOI.XWPF.UserModel.Borders.ARCHED_SCALLOPS">
  4971. Specifies an art border consisting of a repeated image of a shell pattern
  4972. </member>
  4973. <member name="F:NPOI.XWPF.UserModel.Borders.BABY_PACIFIER">
  4974. Specifies an art border consisting of a repeated image of a baby pacifier
  4975. </member>
  4976. <member name="F:NPOI.XWPF.UserModel.Borders.BABY_RATTLE">
  4977. Specifies an art border consisting of a repeated image of a baby rattle
  4978. </member>
  4979. <member name="F:NPOI.XWPF.UserModel.Borders.BALLOONS_3_COLORS">
  4980. Specifies an art border consisting of a repeated image of a Set of
  4981. balloons
  4982. </member>
  4983. <member name="F:NPOI.XWPF.UserModel.Borders.BALLOONS_HOT_AIR">
  4984. Specifies an art border consisting of a repeated image of a hot air
  4985. balloon
  4986. </member>
  4987. <member name="F:NPOI.XWPF.UserModel.Borders.BASIC_BLACK_DASHES">
  4988. Specifies an art border consisting of a repeating image of a black and
  4989. white background.
  4990. </member>
  4991. <member name="F:NPOI.XWPF.UserModel.Borders.BASIC_BLACK_DOTS">
  4992. Specifies an art border consisting of a repeating image of a black dot on
  4993. a white background.
  4994. </member>
  4995. <member name="F:NPOI.XWPF.UserModel.Borders.BASIC_BLACK_SQUARES">
  4996. Specifies an art border consisting of a repeating image of a black and
  4997. white background
  4998. </member>
  4999. <member name="F:NPOI.XWPF.UserModel.Borders.BASIC_THIN_LINES">
  5000. Specifies an art border consisting of a repeating image of a black and
  5001. white background.
  5002. </member>
  5003. <member name="F:NPOI.XWPF.UserModel.Borders.BASIC_WHITE_DASHES">
  5004. Specifies an art border consisting of a repeating image of a black and
  5005. white background.
  5006. </member>
  5007. <member name="F:NPOI.XWPF.UserModel.Borders.BASIC_WHITE_DOTS">
  5008. Specifies an art border consisting of a repeating image of a white dot on
  5009. a black background.
  5010. </member>
  5011. <member name="F:NPOI.XWPF.UserModel.Borders.BASIC_WHITE_SQUARES">
  5012. Specifies an art border consisting of a repeating image of a black and
  5013. white background.
  5014. </member>
  5015. <member name="F:NPOI.XWPF.UserModel.Borders.BASIC_WIDE_INLINE">
  5016. Specifies an art border consisting of a repeating image of a black and
  5017. white background.
  5018. </member>
  5019. <member name="F:NPOI.XWPF.UserModel.Borders.BASIC_WIDE_MIDLINE">
  5020. Specifies an art border consisting of a repeating image of a black and
  5021. white background
  5022. </member>
  5023. <member name="F:NPOI.XWPF.UserModel.Borders.BASIC_WIDE_OUTLINE">
  5024. Specifies an art border consisting of a repeating image of a black and
  5025. white background
  5026. </member>
  5027. <member name="F:NPOI.XWPF.UserModel.Borders.BATS">
  5028. Specifies an art border consisting of a repeated image of bats
  5029. </member>
  5030. <member name="F:NPOI.XWPF.UserModel.Borders.BIRDS">
  5031. Specifies an art border consisting of repeating images of birds
  5032. </member>
  5033. <member name="F:NPOI.XWPF.UserModel.Borders.BIRDS_FLIGHT">
  5034. Specifies an art border consisting of a repeated image of birds flying
  5035. </member>
  5036. <member name="F:NPOI.XWPF.UserModel.Borders.CABINS">
  5037. Specifies an art border consisting of a repeated image of a cabin
  5038. </member>
  5039. <member name="F:NPOI.XWPF.UserModel.Borders.CAKE_SLICE">
  5040. Specifies an art border consisting of a repeated image of a piece of cake
  5041. </member>
  5042. <member name="F:NPOI.XWPF.UserModel.Borders.CANDY_CORN">
  5043. Specifies an art border consisting of a repeated image of candy corn
  5044. </member>
  5045. <member name="F:NPOI.XWPF.UserModel.Borders.CELTIC_KNOTWORK">
  5046. Specifies an art border consisting of a repeated image of a knot work
  5047. pattern
  5048. </member>
  5049. <member name="F:NPOI.XWPF.UserModel.Borders.CERTIFICATE_BANNER">
  5050. Specifies an art border consisting of a banner.
  5051. <p>
  5052. If the border is on the left or right, no border is displayed.
  5053. </p>
  5054. </member>
  5055. <member name="F:NPOI.XWPF.UserModel.Borders.CHAIN_LINK">
  5056. Specifies an art border consisting of a repeating image of a chain link
  5057. pattern.
  5058. </member>
  5059. <member name="F:NPOI.XWPF.UserModel.Borders.CHAMPAGNE_BOTTLE">
  5060. Specifies an art border consisting of a repeated image of a champagne
  5061. bottle
  5062. </member>
  5063. <member name="F:NPOI.XWPF.UserModel.Borders.CHECKED_BAR_BLACK">
  5064. Specifies an art border consisting of repeating images of a compass
  5065. </member>
  5066. <member name="F:NPOI.XWPF.UserModel.Borders.CHECKED_BAR_COLOR">
  5067. Specifies an art border consisting of a repeating image of a colored
  5068. pattern.
  5069. </member>
  5070. <member name="F:NPOI.XWPF.UserModel.Borders.CHECKERED">
  5071. Specifies an art border consisting of a repeated image of a Checkerboard
  5072. </member>
  5073. <member name="F:NPOI.XWPF.UserModel.Borders.CHRISTMAS_TREE">
  5074. Specifies an art border consisting of a repeated image of a Christmas
  5075. tree
  5076. </member>
  5077. <member name="F:NPOI.XWPF.UserModel.Borders.CIRCLES_LINES">
  5078. Specifies an art border consisting of repeating images of lines and
  5079. circles
  5080. </member>
  5081. <member name="F:NPOI.XWPF.UserModel.Borders.CIRCLES_RECTANGLES">
  5082. Specifies an art border consisting of a repeated image of a rectangular
  5083. pattern
  5084. </member>
  5085. <member name="F:NPOI.XWPF.UserModel.Borders.CLASSICAL_WAVE">
  5086. Specifies an art border consisting of a repeated image of a wave
  5087. </member>
  5088. <member name="F:NPOI.XWPF.UserModel.Borders.CLOCKS">
  5089. Specifies an art border consisting of a repeated image of a clock
  5090. </member>
  5091. <member name="F:NPOI.XWPF.UserModel.Borders.COMPASS">
  5092. Specifies an art border consisting of repeating images of a compass
  5093. </member>
  5094. <member name="F:NPOI.XWPF.UserModel.Borders.CONFETTI">
  5095. Specifies an art border consisting of a repeated image of confetti
  5096. </member>
  5097. <member name="F:NPOI.XWPF.UserModel.Borders.CONFETTI_GRAYS">
  5098. Specifies an art border consisting of a repeated image of confetti
  5099. </member>
  5100. <member name="F:NPOI.XWPF.UserModel.Borders.CONFETTI_OUTLINE">
  5101. Specifies an art border consisting of a repeated image of confetti
  5102. </member>
  5103. <member name="F:NPOI.XWPF.UserModel.Borders.CONFETTI_STREAMERS">
  5104. Specifies an art border consisting of a repeated image of confetti
  5105. streamers
  5106. </member>
  5107. <member name="F:NPOI.XWPF.UserModel.Borders.CONFETTI_WHITE">
  5108. Specifies an art border consisting of a repeated image of confetti
  5109. </member>
  5110. <member name="F:NPOI.XWPF.UserModel.Borders.CORNER_TRIANGLES">
  5111. Specifies an art border consisting of a repeated image
  5112. </member>
  5113. <member name="F:NPOI.XWPF.UserModel.Borders.COUPON_CUTOUT_DASHES">
  5114. Specifies an art border consisting of a dashed line
  5115. </member>
  5116. <member name="F:NPOI.XWPF.UserModel.Borders.COUPON_CUTOUT_DOTS">
  5117. Specifies an art border consisting of a dotted line
  5118. </member>
  5119. <member name="F:NPOI.XWPF.UserModel.Borders.CRAZY_MAZE">
  5120. Specifies an art border consisting of a repeated image of a maze-like
  5121. pattern
  5122. </member>
  5123. <member name="F:NPOI.XWPF.UserModel.Borders.CREATURES_BUTTERFLY">
  5124. Specifies an art border consisting of a repeated image of a butterfly
  5125. </member>
  5126. <member name="F:NPOI.XWPF.UserModel.Borders.CREATURES_FISH">
  5127. Specifies an art border consisting of a repeated image of a fish
  5128. </member>
  5129. <member name="F:NPOI.XWPF.UserModel.Borders.CREATURES_INSECTS">
  5130. Specifies an art border consisting of repeating images of insects.
  5131. </member>
  5132. <member name="F:NPOI.XWPF.UserModel.Borders.CREATURES_LADY_BUG">
  5133. Specifies an art border consisting of a repeated image of a ladybug
  5134. </member>
  5135. <member name="F:NPOI.XWPF.UserModel.Borders.CROSS_STITCH">
  5136. Specifies an art border consisting of repeating images of a cross-stitch
  5137. pattern
  5138. </member>
  5139. <member name="F:NPOI.XWPF.UserModel.Borders.CUP">
  5140. Specifies an art border consisting of a repeated image of Cupid
  5141. </member>
  5142. <member name="T:NPOI.XWPF.UserModel.BreakClear">
  5143. Specifies the Set of possible restart locations which may be used as to
  5144. determine the next available line when a break's type attribute has a value
  5145. of textWrapping.
  5146. @author Gisella Bronzetti
  5147. </member>
  5148. <member name="F:NPOI.XWPF.UserModel.BreakClear.NONE">
  5149. Specifies that the text wrapping break shall advance the text to the next
  5150. line in the WordProcessingML document, regardless of its position left to
  5151. right or the presence of any floating objects which intersect with the
  5152. line,
  5153. This is the Setting for a typical line break in a document.
  5154. </member>
  5155. <member name="F:NPOI.XWPF.UserModel.BreakClear.LEFT">
  5156. Specifies that the text wrapping break shall behave as follows:
  5157. <ul>
  5158. <li> If this line is broken into multiple regions (a floating object in
  5159. the center of the page has text wrapping on both sides:
  5160. <ul>
  5161. <li> If this is the leftmost region of text flow on this line, advance
  5162. the text to the next position on the line </li>
  5163. <li>Otherwise, treat this as a text wrapping break of type all. </li>
  5164. </ul>
  5165. </li>
  5166. <li> If this line is not broken into multiple regions, then treat this
  5167. break as a text wrapping break of type none. </li>
  5168. </ul>
  5169. <li> If the parent paragraph is right to left, then these behaviors are
  5170. also reversed. </li>
  5171. </member>
  5172. <!-- 对于成员“F:NPOI.XWPF.UserModel.BreakClear.RIGHT”忽略有格式错误的 XML 注释 -->
  5173. <member name="F:NPOI.XWPF.UserModel.BreakClear.ALL">
  5174. Specifies that the text wrapping break shall advance the text to the next
  5175. line in the WordProcessingML document which spans the full width of the
  5176. line.
  5177. </member>
  5178. <member name="T:NPOI.XWPF.UserModel.BreakType">
  5179. Specifies the possible types of break characters in a WordProcessingML
  5180. document.
  5181. The break type determines the next location where text shall be
  5182. placed After this manual break is applied to the text contents
  5183. @author Gisella Bronzetti
  5184. </member>
  5185. <member name="F:NPOI.XWPF.UserModel.BreakType.PAGE">
  5186. Specifies that the current break shall restart itself on the next page of
  5187. the document when the document is displayed in page view.
  5188. </member>
  5189. <member name="F:NPOI.XWPF.UserModel.BreakType.COLUMN">
  5190. Specifies that the current break shall restart itself on the next column
  5191. available on the current page when the document is displayed in page
  5192. view.
  5193. <p>
  5194. If the current section is not divided into columns, or the column break
  5195. occurs in the last column on the current page when displayed, then the
  5196. restart location for text shall be the next page in the document.
  5197. </p>
  5198. </member>
  5199. <member name="F:NPOI.XWPF.UserModel.BreakType.TEXTWRAPPING">
  5200. Specifies that the current break shall restart itself on the next line in
  5201. the document when the document is displayed in page view.
  5202. The determine of the next line shall be done subject to the value of the clear
  5203. attribute on the specified break character.
  5204. </member>
  5205. <member name="F:NPOI.XWPF.UserModel.PictureType.EMF">
  5206. Extended windows meta file
  5207. </member>
  5208. <member name="F:NPOI.XWPF.UserModel.PictureType.WMF">
  5209. Windows Meta File
  5210. </member>
  5211. <member name="F:NPOI.XWPF.UserModel.PictureType.PICT">
  5212. Mac PICT format
  5213. </member>
  5214. <member name="F:NPOI.XWPF.UserModel.PictureType.JPEG">
  5215. JPEG format
  5216. </member>
  5217. <member name="F:NPOI.XWPF.UserModel.PictureType.PNG">
  5218. PNG format
  5219. </member>
  5220. <member name="F:NPOI.XWPF.UserModel.PictureType.DIB">
  5221. Device independent bitmap
  5222. </member>
  5223. <member name="F:NPOI.XWPF.UserModel.PictureType.GIF">
  5224. GIF image format
  5225. </member>
  5226. <member name="F:NPOI.XWPF.UserModel.PictureType.TIFF">
  5227. Tag Image File (.tiff)
  5228. </member>
  5229. <member name="F:NPOI.XWPF.UserModel.PictureType.EPS">
  5230. Encapsulated Postscript (.eps)
  5231. </member>
  5232. <member name="F:NPOI.XWPF.UserModel.PictureType.BMP">
  5233. Windows Bitmap (.bmp)
  5234. </member>
  5235. <member name="F:NPOI.XWPF.UserModel.PictureType.WPG">
  5236. WordPerfect graphics (.wpg)
  5237. </member>
  5238. <member name="T:NPOI.XWPF.UserModel.IBody">
  5239. <p>
  5240. 8 Jan 2010
  5241. </p>
  5242. <p>
  5243. // This Interface represents an object, which is able to have a collection of paragraphs and tables
  5244. this can be XWFPDocument, XWPFHeader, XWPFFooter, XWPFTableCell
  5245. </p>
  5246. @author Philipp Epp
  5247. </member>
  5248. <member name="M:NPOI.XWPF.UserModel.IBody.GetPart">
  5249. returns the Part, to which the body belongs, which you need for Adding relationship to other parts
  5250. Actually it is needed of the class XWPFTableCell. Because you have to know to which part the tableCell
  5251. belongs.
  5252. @return the Part, to which the body belongs
  5253. </member>
  5254. <member name="M:NPOI.XWPF.UserModel.IBody.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  5255. if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this header or footer
  5256. the method will return this paragraph
  5257. if there is no corresponding {@link XWPFParagraph} the method will return null
  5258. @param p is instance of CTP and is searching for an XWPFParagraph
  5259. @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this header or footer
  5260. XWPFParagraph with the correspondig CTP p
  5261. </member>
  5262. <member name="M:NPOI.XWPF.UserModel.IBody.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  5263. if there is a corresponding {@link XWPFTable} of the parameter ctTable in the tableList of this header
  5264. the method will return this table
  5265. if there is no corresponding {@link XWPFTable} the method will return null
  5266. @param ctTable
  5267. </member>
  5268. <member name="M:NPOI.XWPF.UserModel.IBody.GetParagraphArray(System.Int32)">
  5269. Returns the paragraph that of position pos
  5270. </member>
  5271. <member name="M:NPOI.XWPF.UserModel.IBody.GetTableArray(System.Int32)">
  5272. Returns the table at position pos
  5273. </member>
  5274. <member name="M:NPOI.XWPF.UserModel.IBody.InsertNewParagraph(System.Xml.XmlDocument)">
  5275. inserts a new paragraph at position of the cursor
  5276. @param cursor
  5277. </member>
  5278. <member name="M:NPOI.XWPF.UserModel.IBody.InsertNewTbl(System.Xml.XmlDocument)">
  5279. inserts a new Table at the cursor position.
  5280. @param cursor
  5281. </member>
  5282. <member name="M:NPOI.XWPF.UserModel.IBody.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  5283. inserts a new Table at position pos
  5284. @param pos
  5285. @param table
  5286. </member>
  5287. <member name="M:NPOI.XWPF.UserModel.IBody.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  5288. returns the TableCell to which the Table belongs
  5289. @param cell
  5290. </member>
  5291. <member name="M:NPOI.XWPF.UserModel.IBody.GetXWPFDocument">
  5292. Return XWPFDocument
  5293. </member>
  5294. <member name="P:NPOI.XWPF.UserModel.IBody.PartType">
  5295. Get the PartType of the body, for example
  5296. DOCUMENT, HEADER, FOOTER, FOOTNOTE,
  5297. @return the PartType of the body
  5298. </member>
  5299. <member name="P:NPOI.XWPF.UserModel.IBody.BodyElements">
  5300. Returns an Iterator with paragraphs and tables,
  5301. in the order that they occur in the text.
  5302. </member>
  5303. <member name="P:NPOI.XWPF.UserModel.IBody.Paragraphs">
  5304. Returns the paragraph(s) that holds
  5305. the text of the header or footer.
  5306. </member>
  5307. <member name="P:NPOI.XWPF.UserModel.IBody.Tables">
  5308. Return the table(s) that holds the text
  5309. of the IBodyPart, for complex cases
  5310. where a paragraph isn't used.
  5311. </member>
  5312. <member name="T:NPOI.XWPF.UserModel.IBodyElement">
  5313. 9 Jan 2010
  5314. @author Philipp Epp
  5315. </member>
  5316. <member name="T:NPOI.XWPF.UserModel.LineSpacingRule">
  5317. Specifies the logic which shall be used to calculate the line spacing of the
  5318. parent object when it is displayed in the document.
  5319. @author Gisella Bronzetti
  5320. </member>
  5321. <member name="F:NPOI.XWPF.UserModel.LineSpacingRule.AUTO">
  5322. Specifies that the line spacing of the parent object shall be
  5323. automatically determined by the size of its contents, with no
  5324. predetermined minimum or maximum size.
  5325. </member>
  5326. <member name="F:NPOI.XWPF.UserModel.LineSpacingRule.EXACT">
  5327. Specifies that the height of the line shall be exactly the value
  5328. specified, regardless of the size of the contents If the contents are too
  5329. large for the specified height, then they shall be clipped as necessary.
  5330. </member>
  5331. <member name="F:NPOI.XWPF.UserModel.LineSpacingRule.ATLEAST">
  5332. Specifies that the height of the line shall be at least the value
  5333. specified, but may be expanded to fit its content as needed.
  5334. </member>
  5335. <member name="T:NPOI.XWPF.UserModel.ParagraphAlignment">
  5336. Specifies all types of alignment which are available to be applied to objects in a
  5337. WordProcessingML document
  5338. @author Yegor Kozlov
  5339. </member>
  5340. <member name="T:NPOI.XWPF.UserModel.PositionInParagraph">
  5341. * postion of a character in a paragrapho
  5342. * 1st RunPositon
  5343. * 2nd TextPosition
  5344. * 3rd CharacterPosition
  5345. *
  5346. *
  5347. </member>
  5348. <member name="T:NPOI.XWPF.UserModel.TextAlignment">
  5349. Specifies all types of vertical alignment which are available to be applied to of all text
  5350. on each line displayed within a paragraph.
  5351. @author Gisella Bronzetti
  5352. </member>
  5353. <member name="F:NPOI.XWPF.UserModel.TextAlignment.TOP">
  5354. Specifies that all text in the parent object shall be
  5355. aligned to the top of each character when displayed
  5356. </member>
  5357. <member name="F:NPOI.XWPF.UserModel.TextAlignment.CENTER">
  5358. Specifies that all text in the parent object shall be
  5359. aligned to the center of each character when displayed.
  5360. </member>
  5361. <member name="F:NPOI.XWPF.UserModel.TextAlignment.BASELINE">
  5362. Specifies that all text in the parent object shall be
  5363. aligned to the baseline of each character when displayed.
  5364. </member>
  5365. <member name="F:NPOI.XWPF.UserModel.TextAlignment.BOTTOM">
  5366. Specifies that all text in the parent object shall be
  5367. aligned to the bottom of each character when displayed.
  5368. </member>
  5369. <member name="F:NPOI.XWPF.UserModel.TextAlignment.AUTO">
  5370. Specifies that all text in the parent object shall be
  5371. aligned automatically when displayed.
  5372. </member>
  5373. <member name="T:NPOI.XWPF.UserModel.TextSegement">
  5374. saves the begin and end position of a text in a Paragraph
  5375. </member>
  5376. <member name="P:NPOI.XWPF.UserModel.TextSegement.BeginRun">
  5377. <summary>
  5378. The index of the start run
  5379. </summary>
  5380. </member>
  5381. <member name="P:NPOI.XWPF.UserModel.TextSegement.BeginText">
  5382. <summary>
  5383. The index of the start CT_Text
  5384. </summary>
  5385. </member>
  5386. <member name="P:NPOI.XWPF.UserModel.TextSegement.BeginChar">
  5387. <summary>
  5388. The index of the start text character
  5389. </summary>
  5390. </member>
  5391. <member name="P:NPOI.XWPF.UserModel.TextSegement.EndText">
  5392. <summary>
  5393. the index of the end CT_Text
  5394. </summary>
  5395. </member>
  5396. <member name="P:NPOI.XWPF.UserModel.TextSegement.EndChar">
  5397. <summary>
  5398. the index of the end text character
  5399. </summary>
  5400. </member>
  5401. <member name="T:NPOI.XWPF.UserModel.UnderlinePatterns">
  5402. Specifies the types of patterns which may be used to create the underline
  5403. applied beneath the text in a Run.
  5404. @author Gisella Bronzetti
  5405. </member>
  5406. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Single">
  5407. Specifies an underline consisting of a single line beneath all characters
  5408. in this Run.
  5409. </member>
  5410. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Words">
  5411. Specifies an underline consisting of a single line beneath all non-space
  5412. characters in the Run. There shall be no underline beneath any space
  5413. character (breaking or non-breaking).
  5414. </member>
  5415. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Double">
  5416. Specifies an underline consisting of two lines beneath all characters in
  5417. this run
  5418. </member>
  5419. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Thick">
  5420. Specifies an underline consisting of a single thick line beneath all
  5421. characters in this Run.
  5422. </member>
  5423. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Dotted">
  5424. Specifies an underline consisting of a series of dot characters beneath
  5425. all characters in this Run.
  5426. </member>
  5427. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DottedHeavy">
  5428. Specifies an underline consisting of a series of thick dot characters
  5429. beneath all characters in this Run.
  5430. </member>
  5431. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Dash">
  5432. Specifies an underline consisting of a dashed line beneath all characters
  5433. in this Run.
  5434. </member>
  5435. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashedHeavy">
  5436. Specifies an underline consisting of a series of thick dashes beneath all
  5437. characters in this Run.
  5438. </member>
  5439. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashLong">
  5440. Specifies an underline consisting of long dashed characters beneath all
  5441. characters in this Run.
  5442. </member>
  5443. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashLongHeavy">
  5444. Specifies an underline consisting of thick long dashed characters beneath
  5445. all characters in this Run.
  5446. </member>
  5447. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DotDash">
  5448. Specifies an underline consisting of a series of dash, dot characters
  5449. beneath all characters in this Run.
  5450. </member>
  5451. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashDotHeavy">
  5452. Specifies an underline consisting of a series of thick dash, dot
  5453. characters beneath all characters in this Run.
  5454. </member>
  5455. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DotDotDash">
  5456. Specifies an underline consisting of a series of dash, dot, dot
  5457. characters beneath all characters in this Run.
  5458. </member>
  5459. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashDotDotHeavy">
  5460. Specifies an underline consisting of a series of thick dash, dot, dot
  5461. characters beneath all characters in this Run.
  5462. </member>
  5463. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Wave">
  5464. Specifies an underline consisting of a single wavy line beneath all
  5465. characters in this Run.
  5466. </member>
  5467. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.WavyHeavy">
  5468. Specifies an underline consisting of a single thick wavy line beneath all
  5469. characters in this Run.
  5470. </member>
  5471. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.WavyDouble">
  5472. Specifies an underline consisting of a pair of wavy lines beneath all
  5473. characters in this Run.
  5474. </member>
  5475. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.None">
  5476. Specifies no underline beneath this Run.
  5477. </member>
  5478. <member name="T:NPOI.XWPF.UserModel.VerticalAlign">
  5479. Specifies possible values for the alignment of the contents of this run in
  5480. relation to the default appearance of the Run's text. This allows the text to
  5481. be repositioned as subscript or superscript without altering the font size of
  5482. the run properties.
  5483. @author Gisella Bronzetti
  5484. </member>
  5485. <member name="F:NPOI.XWPF.UserModel.VerticalAlign.BASELINE">
  5486. Specifies that the text in the parent run shall be located at the
  5487. baseline and presented in the same size as surrounding text.
  5488. </member>
  5489. <member name="F:NPOI.XWPF.UserModel.VerticalAlign.SUPERSCRIPT">
  5490. Specifies that this text should be subscript. This Setting shall lower
  5491. the text in this run below the baseline and change it to a smaller size,
  5492. if a smaller size is available.
  5493. </member>
  5494. <member name="F:NPOI.XWPF.UserModel.VerticalAlign.SUBSCRIPT">
  5495. Specifies that this text should be superscript. This Setting shall raise
  5496. the text in this run above the baseline and change it to a smaller size,
  5497. if a smaller size is available.
  5498. </member>
  5499. <member name="T:NPOI.XWPF.UserModel.XWPFAbstractNum">
  5500. @author Philipp Epp
  5501. </member>
  5502. <member name="P:NPOI.XWPF.UserModel.XWPFAbstractNum.MultiLevelType">
  5503. <summary>
  5504. Abstract Numbering Definition Type
  5505. </summary>
  5506. </member>
  5507. <member name="T:NPOI.XWPF.UserModel.MultiLevelType">
  5508. <summary>
  5509. Numbering Definition Type
  5510. </summary>
  5511. </member>
  5512. <member name="F:NPOI.XWPF.UserModel.MultiLevelType.SingleLevel">
  5513. <summary>
  5514. Single Level Numbering Definition
  5515. </summary>
  5516. </member>
  5517. <member name="F:NPOI.XWPF.UserModel.MultiLevelType.Multilevel">
  5518. <summary>
  5519. Multilevel Numbering Definition
  5520. </summary>
  5521. </member>
  5522. <member name="F:NPOI.XWPF.UserModel.MultiLevelType.HybridMultilevel">
  5523. <summary>
  5524. Hybrid Multilevel Numbering Definition
  5525. </summary>
  5526. </member>
  5527. <member name="T:NPOI.XWPF.UserModel.NumberFormat">
  5528. <summary>
  5529. Numbering Format
  5530. </summary>
  5531. </member>
  5532. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Decimal">
  5533. <summary>
  5534. Decimal Numbers
  5535. </summary>
  5536. </member>
  5537. <member name="F:NPOI.XWPF.UserModel.NumberFormat.UpperRoman">
  5538. <summary>
  5539. Uppercase Roman Numerals
  5540. </summary>
  5541. </member>
  5542. <member name="F:NPOI.XWPF.UserModel.NumberFormat.LowerRoman">
  5543. <summary>
  5544. Lowercase Roman Numerals
  5545. </summary>
  5546. </member>
  5547. <member name="F:NPOI.XWPF.UserModel.NumberFormat.UpperLetter">
  5548. <summary>
  5549. Uppercase Latin Alphabet
  5550. </summary>
  5551. </member>
  5552. <member name="F:NPOI.XWPF.UserModel.NumberFormat.LowerLetter">
  5553. <summary>
  5554. Lowercase Latin Alphabet
  5555. </summary>
  5556. </member>
  5557. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Ordinal">
  5558. <summary>
  5559. Ordinal
  5560. </summary>
  5561. </member>
  5562. <member name="F:NPOI.XWPF.UserModel.NumberFormat.CardinalText">
  5563. <summary>
  5564. Cardinal Text
  5565. </summary>
  5566. </member>
  5567. <member name="F:NPOI.XWPF.UserModel.NumberFormat.OrdinalText">
  5568. <summary>
  5569. Ordinal Text
  5570. </summary>
  5571. </member>
  5572. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Hex">
  5573. <summary>
  5574. Hexadecimal Numbering
  5575. </summary>
  5576. </member>
  5577. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Chicago">
  5578. <summary>
  5579. Chicago Manual of Style
  5580. </summary>
  5581. </member>
  5582. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographDigital">
  5583. <summary>
  5584. Ideographs
  5585. </summary>
  5586. </member>
  5587. <member name="F:NPOI.XWPF.UserModel.NumberFormat.JapaneseCounting">
  5588. <summary>
  5589. Japanese Counting System
  5590. </summary>
  5591. </member>
  5592. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Aiueo">
  5593. <summary>
  5594. AIUEO Order Hiragana
  5595. </summary>
  5596. </member>
  5597. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Iroha">
  5598. <summary>
  5599. Iroha Ordered Katakana
  5600. </summary>
  5601. </member>
  5602. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalFullWidth">
  5603. <summary>
  5604. Double Byte Arabic Numerals
  5605. </summary>
  5606. </member>
  5607. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalHalfWidth">
  5608. <summary>
  5609. Single Byte Arabic Numerals
  5610. </summary>
  5611. </member>
  5612. <member name="F:NPOI.XWPF.UserModel.NumberFormat.JapaneseLegal">
  5613. <summary>
  5614. Japanese Legal Numbering
  5615. </summary>
  5616. </member>
  5617. <member name="F:NPOI.XWPF.UserModel.NumberFormat.JapaneseDigitalTenThousand">
  5618. <summary>
  5619. Japanese Digital Ten Thousand Counting System
  5620. </summary>
  5621. </member>
  5622. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalEnclosedCircle">
  5623. <summary>
  5624. Decimal Numbers Enclosed in a Circle
  5625. </summary>
  5626. </member>
  5627. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalFullWidth2">
  5628. <summary>
  5629. Double Byte Arabic Numerals Alternate
  5630. </summary>
  5631. </member>
  5632. <member name="F:NPOI.XWPF.UserModel.NumberFormat.AiueoFullWidth">
  5633. <summary>
  5634. Full-Width AIUEO Order Hiragana
  5635. </summary>
  5636. </member>
  5637. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IrohaFullWidth">
  5638. <summary>
  5639. Full-Width Iroha Ordered Katakana
  5640. </summary>
  5641. </member>
  5642. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalZero">
  5643. <summary>
  5644. Initial Zero Arabic Numerals
  5645. </summary>
  5646. </member>
  5647. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Bullet">
  5648. <summary>
  5649. Bullet
  5650. </summary>
  5651. </member>
  5652. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Ganada">
  5653. <summary>
  5654. Korean Ganada Numbering
  5655. </summary>
  5656. </member>
  5657. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Chosung">
  5658. <summary>
  5659. Korean Chosung Numbering
  5660. </summary>
  5661. </member>
  5662. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalEnclosedFullstop">
  5663. <summary>
  5664. Decimal Numbers Followed by a Period
  5665. </summary>
  5666. </member>
  5667. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalEnclosedParen">
  5668. <summary>
  5669. Decimal Numbers Enclosed in Parenthesis
  5670. </summary>
  5671. </member>
  5672. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalEnclosedCircleChinese">
  5673. <summary>
  5674. Decimal Numbers Enclosed in a Circle
  5675. </summary>
  5676. </member>
  5677. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographEnclosedCircle">
  5678. <summary>
  5679. Ideographs Enclosed in a Circle
  5680. </summary>
  5681. </member>
  5682. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographTraditional">
  5683. <summary>
  5684. Traditional Ideograph Format
  5685. </summary>
  5686. </member>
  5687. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographZodiac">
  5688. <summary>
  5689. Zodiac Ideograph Format
  5690. </summary>
  5691. </member>
  5692. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographZodiacTraditional">
  5693. <summary>
  5694. Traditional Zodiac Ideograph Format
  5695. </summary>
  5696. </member>
  5697. <member name="F:NPOI.XWPF.UserModel.NumberFormat.TaiwaneseCounting">
  5698. <summary>
  5699. Taiwanese Counting System
  5700. </summary>
  5701. </member>
  5702. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographLegalTraditional">
  5703. <summary>
  5704. Traditional Legal Ideograph Format
  5705. </summary>
  5706. </member>
  5707. <member name="F:NPOI.XWPF.UserModel.NumberFormat.TaiwaneseCountingThousand">
  5708. <summary>
  5709. Taiwanese Counting Thousand System
  5710. </summary>
  5711. </member>
  5712. <member name="F:NPOI.XWPF.UserModel.NumberFormat.TaiwaneseDigital">
  5713. <summary>
  5714. Taiwanese Digital Counting System
  5715. </summary>
  5716. </member>
  5717. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ChineseCounting">
  5718. <summary>
  5719. Chinese Counting System
  5720. </summary>
  5721. </member>
  5722. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ChineseLegalSimplified">
  5723. <summary>
  5724. Chinese Legal Simplified Format
  5725. </summary>
  5726. </member>
  5727. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ChineseCountingThousand">
  5728. <summary>
  5729. Chinese Counting Thousand System
  5730. </summary>
  5731. </member>
  5732. <member name="F:NPOI.XWPF.UserModel.NumberFormat.KoreanDigital">
  5733. <summary>
  5734. Korean Digital Counting System
  5735. </summary>
  5736. </member>
  5737. <member name="F:NPOI.XWPF.UserModel.NumberFormat.KoreanCounting">
  5738. <summary>
  5739. Korean Counting System
  5740. </summary>
  5741. </member>
  5742. <member name="F:NPOI.XWPF.UserModel.NumberFormat.KoreanLegal">
  5743. <summary>
  5744. Korean Legal Numbering
  5745. </summary>
  5746. </member>
  5747. <member name="F:NPOI.XWPF.UserModel.NumberFormat.KoreanDigital2">
  5748. <summary>
  5749. Korean Digital Counting System Alternate
  5750. </summary>
  5751. </member>
  5752. <member name="F:NPOI.XWPF.UserModel.NumberFormat.VietnameseCounting">
  5753. <summary>
  5754. Vietnamese Numerals
  5755. </summary>
  5756. </member>
  5757. <member name="F:NPOI.XWPF.UserModel.NumberFormat.RussianLower">
  5758. <summary>
  5759. Lowercase Russian Alphabet
  5760. </summary>
  5761. </member>
  5762. <member name="F:NPOI.XWPF.UserModel.NumberFormat.RussianUpper">
  5763. <summary>
  5764. Uppercase Russian Alphabet
  5765. </summary>
  5766. </member>
  5767. <member name="F:NPOI.XWPF.UserModel.NumberFormat.None">
  5768. <summary>
  5769. No Numbering
  5770. </summary>
  5771. </member>
  5772. <member name="F:NPOI.XWPF.UserModel.NumberFormat.NumberInDash">
  5773. <summary>
  5774. Number With Dashes
  5775. </summary>
  5776. </member>
  5777. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Hebrew1">
  5778. <summary>
  5779. Hebrew Numerals
  5780. </summary>
  5781. </member>
  5782. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Hebrew2">
  5783. <summary>
  5784. Hebrew Alphabet
  5785. </summary>
  5786. </member>
  5787. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ArabicAlpha">
  5788. <summary>
  5789. Arabic Alphabet
  5790. </summary>
  5791. </member>
  5792. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ArabicAbjad">
  5793. <summary>
  5794. Arabic Abjad Numerals
  5795. </summary>
  5796. </member>
  5797. <member name="F:NPOI.XWPF.UserModel.NumberFormat.HindiVowels">
  5798. <summary>
  5799. Hindi Vowels
  5800. </summary>
  5801. </member>
  5802. <member name="F:NPOI.XWPF.UserModel.NumberFormat.HindiConsonants">
  5803. <summary>
  5804. Hindi Consonants
  5805. </summary>
  5806. </member>
  5807. <member name="F:NPOI.XWPF.UserModel.NumberFormat.HindiNumbers">
  5808. <summary>
  5809. Hindi Numbers
  5810. </summary>
  5811. </member>
  5812. <member name="F:NPOI.XWPF.UserModel.NumberFormat.HindiCounting">
  5813. <summary>
  5814. Hindi Counting System
  5815. </summary>
  5816. </member>
  5817. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ThaiLetters">
  5818. <summary>
  5819. Thai Letters
  5820. </summary>
  5821. </member>
  5822. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ThaiNumbers">
  5823. <summary>
  5824. Thai Numerals
  5825. </summary>
  5826. </member>
  5827. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ThaiCounting">
  5828. <summary>
  5829. Thai Counting System
  5830. </summary>
  5831. </member>
  5832. <member name="T:NPOI.XWPF.UserModel.XWPFComment">
  5833. * Sketch of XWPF comment class
  5834. *
  5835. * @author Yury Batrakov (batrakov at gmail.com)
  5836. *
  5837. </member>
  5838. <member name="T:NPOI.XWPF.UserModel.XWPFDocument">
  5839. Experimental class to do low level Processing
  5840. of docx files.
  5841. If you're using these low level classes, then you
  5842. will almost certainly need to refer to the OOXML
  5843. specifications from
  5844. http://www.ecma-international.org/publications/standards/Ecma-376.htm
  5845. WARNING - APIs expected to change rapidly
  5846. </member>
  5847. <member name="F:NPOI.XWPF.UserModel.XWPFDocument.drawingIdManager">
  5848. Keeps track on all id-values used in this document and included parts, like headers, footers, etc.
  5849. </member>
  5850. <member name="F:NPOI.XWPF.UserModel.XWPFDocument.headerFooterPolicy">
  5851. Handles the joy of different headers/footers for different pages
  5852. </member>
  5853. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.NewPackage">
  5854. Create a new WordProcessingML package and Setup the default minimal content
  5855. </member>
  5856. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.OnDocumentCreate">
  5857. Create a new CT_Document with all values Set to default
  5858. </member>
  5859. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetTableArray(System.Int32)">
  5860. @see NPOI.XWPF.UserModel.IBody#getTableArray(int)
  5861. </member>
  5862. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPartById(System.String)">
  5863. Get the document part that's defined as the
  5864. given relationship of the core document.
  5865. </member>
  5866. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetHeaderFooterPolicy">
  5867. Returns the policy on headers and footers, which
  5868. also provides a way to Get at them.
  5869. </member>
  5870. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetCTStyle">
  5871. Returns the styles object used
  5872. </member>
  5873. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetAllEmbedds">
  5874. Get the document's embedded files.
  5875. </member>
  5876. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetBodyElementSpecificPos(System.Int32,System.Collections.Generic.List{NPOI.XWPF.UserModel.IBodyElement})">
  5877. Finds that for example the 2nd entry in the body list is the 1st paragraph
  5878. </member>
  5879. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetParagraphPos(System.Int32)">
  5880. Look up the paragraph at the specified position in the body elemnts list
  5881. and return this paragraphs position in the paragraphs list
  5882. @param pos
  5883. The position of the relevant paragraph in the body elements
  5884. list
  5885. @return the position of the paragraph in the paragraphs list, if there is
  5886. a paragraph at the position in the bodyelements list. Else it
  5887. will return -1
  5888. </member>
  5889. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetTablePos(System.Int32)">
  5890. Get with the position of a table in the bodyelement array list
  5891. the position of this table in the table array list
  5892. @param pos position of the table in the bodyelement array list
  5893. @return if there is a table at the position in the bodyelement array list,
  5894. else it will return null.
  5895. </member>
  5896. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.InsertNewParagraph(System.Xml.XmlDocument)">
  5897. Add a new paragraph at position of the cursor. The cursor must be on the
  5898. {@link org.apache.xmlbeans.XmlCursor.TokenType#START} tag of an subelement
  5899. of the documents body. When this method is done, the cursor passed as
  5900. parameter points to the {@link org.apache.xmlbeans.XmlCursor.TokenType#END}
  5901. of the newly inserted paragraph.
  5902. @param cursor
  5903. @return the {@link XWPFParagraph} object representing the newly inserted
  5904. CTP object
  5905. </member>
  5906. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsCursorInBody(System.Xml.XmlDocument)">
  5907. verifies that cursor is on the right position
  5908. @param cursor
  5909. </member>
  5910. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPosOfParagraph(NPOI.XWPF.UserModel.XWPFParagraph)">
  5911. Get the position of the paragraph, within the list
  5912. of all the body elements.
  5913. @param p The paragraph to find
  5914. @return The location, or -1 if the paragraph couldn't be found
  5915. </member>
  5916. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPosOfTable(NPOI.XWPF.UserModel.XWPFTable)">
  5917. Get the position of the table, within the list of
  5918. all the body elements.
  5919. @param t The table to find
  5920. @return The location, or -1 if the table couldn't be found
  5921. </member>
  5922. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.Commit">
  5923. Commit and saves the document
  5924. </member>
  5925. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetRelationIndex(NPOI.XWPF.UserModel.XWPFRelation)">
  5926. Gets the index of the relation we're trying to create
  5927. @param relation
  5928. @return i
  5929. </member>
  5930. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateParagraph">
  5931. Appends a new paragraph to this document
  5932. @return a new paragraph
  5933. </member>
  5934. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateNumbering">
  5935. Creates an empty numbering if one does not already exist and Sets the numbering member
  5936. @return numbering
  5937. </member>
  5938. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateStyles">
  5939. Creates an empty styles for the document if one does not already exist
  5940. @return styles
  5941. </member>
  5942. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateFootnotes">
  5943. Creates an empty footnotes element for the document if one does not already exist
  5944. @return footnotes
  5945. </member>
  5946. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.RemoveBodyElement(System.Int32)">
  5947. remove a BodyElement from bodyElements array list
  5948. @param pos
  5949. @return true if removing was successfully, else return false
  5950. </member>
  5951. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.SetParagraph(NPOI.XWPF.UserModel.XWPFParagraph,System.Int32)">
  5952. copies content of a paragraph to a existing paragraph in the list paragraphs at position pos
  5953. @param paragraph
  5954. @param pos
  5955. </member>
  5956. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetLastParagraph">
  5957. @return the LastParagraph of the document
  5958. </member>
  5959. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateTable">
  5960. Create an empty table with one row and one column as default.
  5961. @return a new table
  5962. </member>
  5963. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateTable(System.Int32,System.Int32)">
  5964. Create an empty table with a number of rows and cols specified
  5965. @param rows
  5966. @param cols
  5967. @return table
  5968. </member>
  5969. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateTOC">
  5970. </member>
  5971. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.SetTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  5972. Replace content of table in array tables at position pos with a
  5973. @param pos
  5974. @param table
  5975. </member>
  5976. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedReadonlyProtection">
  5977. Verifies that the documentProtection tag in Settings.xml file <br/>
  5978. specifies that the protection is enforced (w:enforcement="1") <br/>
  5979. and that the kind of protection is ReadOnly (w:edit="readOnly")<br/>
  5980. <br/>
  5981. sample snippet from Settings.xml
  5982. <pre>
  5983. &lt;w:settings ... &gt;
  5984. &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
  5985. </pre>
  5986. @return true if documentProtection is enforced with option ReadOnly
  5987. </member>
  5988. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedFillingFormsProtection">
  5989. Verifies that the documentProtection tag in Settings.xml file <br/>
  5990. specifies that the protection is enforced (w:enforcement="1") <br/>
  5991. and that the kind of protection is forms (w:edit="forms")<br/>
  5992. <br/>
  5993. sample snippet from Settings.xml
  5994. <pre>
  5995. &lt;w:settings ... &gt;
  5996. &lt;w:documentProtection w:edit=&quot;forms&quot; w:enforcement=&quot;1&quot;/&gt;
  5997. </pre>
  5998. @return true if documentProtection is enforced with option forms
  5999. </member>
  6000. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedCommentsProtection">
  6001. Verifies that the documentProtection tag in Settings.xml file <br/>
  6002. specifies that the protection is enforced (w:enforcement="1") <br/>
  6003. and that the kind of protection is comments (w:edit="comments")<br/>
  6004. <br/>
  6005. sample snippet from Settings.xml
  6006. <pre>
  6007. &lt;w:settings ... &gt;
  6008. &lt;w:documentProtection w:edit=&quot;comments&quot; w:enforcement=&quot;1&quot;/&gt;
  6009. </pre>
  6010. @return true if documentProtection is enforced with option comments
  6011. </member>
  6012. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedTrackedChangesProtection">
  6013. Verifies that the documentProtection tag in Settings.xml file <br/>
  6014. specifies that the protection is enforced (w:enforcement="1") <br/>
  6015. and that the kind of protection is trackedChanges (w:edit="trackedChanges")<br/>
  6016. <br/>
  6017. sample snippet from Settings.xml
  6018. <pre>
  6019. &lt;w:settings ... &gt;
  6020. &lt;w:documentProtection w:edit=&quot;trackedChanges&quot; w:enforcement=&quot;1&quot;/&gt;
  6021. </pre>
  6022. @return true if documentProtection is enforced with option trackedChanges
  6023. </member>
  6024. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceReadonlyProtection">
  6025. Enforces the ReadOnly protection.<br/>
  6026. In the documentProtection tag inside Settings.xml file, <br/>
  6027. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  6028. and the value of edit to ReadOnly (w:edit="readOnly")<br/>
  6029. <br/>
  6030. sample snippet from Settings.xml
  6031. <pre>
  6032. &lt;w:settings ... &gt;
  6033. &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
  6034. </pre>
  6035. </member>
  6036. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceFillingFormsProtection">
  6037. Enforce the Filling Forms protection.<br/>
  6038. In the documentProtection tag inside Settings.xml file, <br/>
  6039. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  6040. and the value of edit to forms (w:edit="forms")<br/>
  6041. <br/>
  6042. sample snippet from Settings.xml
  6043. <pre>
  6044. &lt;w:settings ... &gt;
  6045. &lt;w:documentProtection w:edit=&quot;forms&quot; w:enforcement=&quot;1&quot;/&gt;
  6046. </pre>
  6047. </member>
  6048. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceCommentsProtection">
  6049. Enforce the Comments protection.<br/>
  6050. In the documentProtection tag inside Settings.xml file,<br/>
  6051. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  6052. and the value of edit to comments (w:edit="comments")<br/>
  6053. <br/>
  6054. sample snippet from Settings.xml
  6055. <pre>
  6056. &lt;w:settings ... &gt;
  6057. &lt;w:documentProtection w:edit=&quot;comments&quot; w:enforcement=&quot;1&quot;/&gt;
  6058. </pre>
  6059. </member>
  6060. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceTrackedChangesProtection">
  6061. Enforce the Tracked Changes protection.<br/>
  6062. In the documentProtection tag inside Settings.xml file, <br/>
  6063. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  6064. and the value of edit to trackedChanges (w:edit="trackedChanges")<br/>
  6065. <br/>
  6066. sample snippet from Settings.xml
  6067. <pre>
  6068. &lt;w:settings ... &gt;
  6069. &lt;w:documentProtection w:edit=&quot;trackedChanges&quot; w:enforcement=&quot;1&quot;/&gt;
  6070. </pre>
  6071. </member>
  6072. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.RemoveProtectionEnforcement">
  6073. Remove protection enforcement.<br/>
  6074. In the documentProtection tag inside Settings.xml file <br/>
  6075. it Sets the value of enforcement to "0" (w:enforcement="0") <br/>
  6076. </member>
  6077. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceUpdateFields">
  6078. Enforces fields update on document open (in Word).
  6079. In the settings.xml file <br/>
  6080. sets the updateSettings value to true (w:updateSettings w:val="true")
  6081. NOTICES:
  6082. <ul>
  6083. <li>Causing Word to ask on open: "This document contains fields that may refer to other files. Do you want to update the fields in this document?"
  6084. (if "Update automatic links at open" is enabled)</li>
  6085. <li>Flag is removed after saving with changes in Word </li>
  6086. </ul>
  6087. </member>
  6088. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  6089. inserts an existing XWPFTable to the arrays bodyElements and tables
  6090. @param pos
  6091. @param table
  6092. </member>
  6093. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetNextPicNameNumber(System.Int32)">
  6094. Get the next free ImageNumber
  6095. @param format
  6096. @return the next free ImageNumber
  6097. @throws InvalidFormatException
  6098. </member>
  6099. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPictureDataByID(System.String)">
  6100. returns the PictureData by blipID
  6101. @param blipID
  6102. @return XWPFPictureData of a specificID
  6103. </member>
  6104. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetNumbering">
  6105. GetNumbering
  6106. @return numbering
  6107. </member>
  6108. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetStyles">
  6109. Get Styles
  6110. @return styles for this document
  6111. </member>
  6112. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  6113. Get the paragraph with the CTP class p
  6114. @param p
  6115. @return the paragraph with the CTP class p
  6116. </member>
  6117. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  6118. Get a table by its CTTbl-Object
  6119. @param ctTbl
  6120. @see NPOI.XWPF.UserModel.IBody#getTable(org.Openxmlformats.schemas.wordProcessingml.x2006.main.CTTbl)
  6121. @return a table by its CTTbl-Object or null
  6122. </member>
  6123. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetParagraphArray(System.Int32)">
  6124. Returns the paragraph that of position pos
  6125. @see NPOI.XWPF.UserModel.IBody#getParagraphArray(int)
  6126. </member>
  6127. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPart">
  6128. returns the Part, to which the body belongs, which you need for Adding relationship to other parts
  6129. Actually it is needed of the class XWPFTableCell. Because you have to know to which part the tableCell
  6130. belongs.
  6131. @see NPOI.XWPF.UserModel.IBody#getPart()
  6132. </member>
  6133. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  6134. Get the TableCell which belongs to the TableCell
  6135. @param cell
  6136. </member>
  6137. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.Document">
  6138. Returns the low level document base object
  6139. </member>
  6140. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.BodyElements">
  6141. returns an Iterator with paragraphs and tables
  6142. @see NPOI.XWPF.UserModel.IBody#getBodyElements()
  6143. </member>
  6144. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.Paragraphs">
  6145. @see NPOI.XWPF.UserModel.IBody#getParagraphs()
  6146. </member>
  6147. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.Tables">
  6148. @see NPOI.XWPF.UserModel.IBody#getTables()
  6149. </member>
  6150. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.FooterList">
  6151. @return the list of footers
  6152. </member>
  6153. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.HeaderList">
  6154. @return the list of headers
  6155. </member>
  6156. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.AllPictures">
  6157. Returns all Pictures, which are referenced from the document itself.
  6158. @return a {@link List} of {@link XWPFPictureData}. The returned {@link List} is unmodifiable. Use #a
  6159. </member>
  6160. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.AllPackagePictures">
  6161. @return all Pictures in this package
  6162. </member>
  6163. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.PartType">
  6164. Get the PartType of the body, for example
  6165. DOCUMENT, HEADER, FOOTER, FOOTNOTE,
  6166. @see NPOI.XWPF.UserModel.IBody#getPartType()
  6167. </member>
  6168. <member name="T:NPOI.XWPF.UserModel.XWPFFactory">
  6169. @author Yegor Kozlov
  6170. </member>
  6171. <member name="T:NPOI.XWPF.UserModel.XWPFFooter">
  6172. Sketch of XWPF footer class
  6173. </member>
  6174. <member name="T:NPOI.XWPF.UserModel.XWPFHeaderFooter">
  6175. Parent of XWPF headers and footers
  6176. </member>
  6177. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.SetHeaderFooter(NPOI.OpenXmlFormats.Wordprocessing.CT_HdrFtr)">
  6178. Set a new headerFooter
  6179. </member>
  6180. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  6181. if there is a corresponding {@link XWPFTable} of the parameter ctTable in the tableList of this header
  6182. the method will return this table
  6183. if there is no corresponding {@link XWPFTable} the method will return null
  6184. @param ctTable
  6185. </member>
  6186. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  6187. if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this header or footer
  6188. the method will return this paragraph
  6189. if there is no corresponding {@link XWPFParagraph} the method will return null
  6190. @param p is instance of CTP and is searching for an XWPFParagraph
  6191. @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this header or footer
  6192. XWPFParagraph with the correspondig CTP p
  6193. </member>
  6194. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetParagraphArray(System.Int32)">
  6195. Returns the paragraph that holds
  6196. the text of the header or footer.
  6197. </member>
  6198. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetListParagraph">
  6199. Get a List of all Paragraphs
  6200. @return a list of {@link XWPFParagraph}
  6201. </member>
  6202. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.AddPictureData(System.Byte[],System.Int32)">
  6203. Adds a picture to the document.
  6204. @param pictureData The picture data
  6205. @param format The format of the picture.
  6206. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  6207. @throws InvalidFormatException
  6208. </member>
  6209. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.AddPictureData(System.IO.Stream,System.Int32)">
  6210. Adds a picture to the document.
  6211. @param is The stream to read image from
  6212. @param format The format of the picture.
  6213. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  6214. @throws InvalidFormatException
  6215. @
  6216. </member>
  6217. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetPictureDataByID(System.String)">
  6218. returns the PictureData by blipID
  6219. @param blipID
  6220. @return XWPFPictureData of a specificID
  6221. @throws Exception
  6222. </member>
  6223. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetTableArray(System.Int32)">
  6224. Returns the table at position pos
  6225. @see NPOI.XWPF.UserModel.IBody#getTableArray(int)
  6226. </member>
  6227. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  6228. inserts an existing XWPFTable to the arrays bodyElements and tables
  6229. @param pos
  6230. @param table
  6231. </member>
  6232. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  6233. Get the TableCell which belongs to the TableCell
  6234. @param cell
  6235. </member>
  6236. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetPart">
  6237. returns the Part, to which the body belongs, which you need for Adding relationship to other parts
  6238. @see NPOI.XWPF.UserModel.IBody#getPart()
  6239. </member>
  6240. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Paragraphs">
  6241. Returns the paragraph(s) that holds
  6242. the text of the header or footer.
  6243. Normally there is only the one paragraph, but
  6244. there could be more in certain cases, or
  6245. a table.
  6246. </member>
  6247. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Tables">
  6248. Return the table(s) that holds the text
  6249. of the header or footer, for complex cases
  6250. where a paragraph isn't used.
  6251. Normally there's just one paragraph, but some
  6252. complex headers/footers have a table or two
  6253. in Addition.
  6254. </member>
  6255. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Text">
  6256. Returns the textual content of the header/footer,
  6257. by flattening out the text of its paragraph(s)
  6258. </member>
  6259. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.AllPackagePictures">
  6260. Get all Pictures in this package
  6261. @return all Pictures in this package
  6262. </member>
  6263. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Owner">
  6264. verifies that cursor is on the right position
  6265. @param cursor
  6266. </member>
  6267. <member name="M:NPOI.XWPF.UserModel.XWPFFooter.Commit">
  6268. save and Commit footer
  6269. </member>
  6270. <member name="P:NPOI.XWPF.UserModel.XWPFFooter.PartType">
  6271. Get the PartType of the body
  6272. @see NPOI.XWPF.UserModel.IBody#getPartType()
  6273. </member>
  6274. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetTableArray(System.Int32)">
  6275. <summary>
  6276. </summary>
  6277. <param name="pos">position in table array</param>
  6278. <returns>The table at position pos</returns>
  6279. </member>
  6280. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  6281. <summary>
  6282. inserts an existing XWPFTable to the arrays bodyElements and tables
  6283. </summary>
  6284. <param name="pos"></param>
  6285. <param name="table"></param>
  6286. </member>
  6287. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  6288. if there is a corresponding {@link XWPFTable} of the parameter ctTable in the tableList of this header
  6289. the method will return this table
  6290. if there is no corresponding {@link XWPFTable} the method will return null
  6291. @param ctTable
  6292. @see NPOI.XWPF.UserModel.IBody#getTable(CTTbl ctTable)
  6293. </member>
  6294. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  6295. if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this header or footer
  6296. the method will return this paragraph
  6297. if there is no corresponding {@link XWPFParagraph} the method will return null
  6298. @param p is instance of CTP and is searching for an XWPFParagraph
  6299. @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this header or footer
  6300. XWPFParagraph with the correspondig CTP p
  6301. @see NPOI.XWPF.UserModel.IBody#getParagraph(CTP p)
  6302. </member>
  6303. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetParagraphArray(System.Int32)">
  6304. <summary>
  6305. Returns the paragraph that holds the text of the header or footer.
  6306. </summary>
  6307. <param name="pos"></param>
  6308. <returns></returns>
  6309. </member>
  6310. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  6311. <summary>
  6312. Get the TableCell which belongs to the TableCell
  6313. </summary>
  6314. <param name="cell"></param>
  6315. <returns></returns>
  6316. </member>
  6317. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.IsCursorInFtn(System.Xml.XmlDocument)">
  6318. verifies that cursor is on the right position
  6319. @param cursor
  6320. </member>
  6321. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.InsertNewTbl(System.Xml.XmlDocument)">
  6322. @param cursor
  6323. @return the inserted table
  6324. @see NPOI.XWPF.UserModel.IBody#insertNewTbl(XmlCursor cursor)
  6325. </member>
  6326. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.InsertNewParagraph(System.Xml.XmlDocument)">
  6327. add a new paragraph at position of the cursor
  6328. @param cursor
  6329. @return the inserted paragraph
  6330. @see NPOI.XWPF.UserModel.IBody#insertNewParagraph(XmlCursor cursor)
  6331. </member>
  6332. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.AddNewTbl(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  6333. add a new table to the end of the footnote
  6334. @param table
  6335. @return the Added XWPFTable
  6336. </member>
  6337. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.AddNewParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  6338. add a new paragraph to the end of the footnote
  6339. @param paragraph
  6340. @return the Added XWPFParagraph
  6341. </member>
  6342. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetXWPFDocument">
  6343. @see NPOI.XWPF.UserModel.IBody#getXWPFDocument()
  6344. </member>
  6345. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetPart">
  6346. returns the Part, to which the body belongs, which you need for Adding relationship to other parts
  6347. @see NPOI.XWPF.UserModel.IBody#getPart()
  6348. </member>
  6349. <member name="P:NPOI.XWPF.UserModel.XWPFFootnote.PartType">
  6350. Get the PartType of the body
  6351. @see NPOI.XWPF.UserModel.IBody#getPartType()
  6352. </member>
  6353. <member name="T:NPOI.XWPF.UserModel.XWPFFootnotes">
  6354. Looks After the collection of Footnotes for a document
  6355. @author Mike McEuen (mceuen@hp.com)
  6356. </member>
  6357. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  6358. Construct XWPFFootnotes from a package part
  6359. @param part the package part holding the data of the footnotes,
  6360. @param rel the package relationship of type "http://schemas.Openxmlformats.org/officeDocument/2006/relationships/footnotes"
  6361. </member>
  6362. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.#ctor">
  6363. Construct XWPFFootnotes from scratch for a new document.
  6364. </member>
  6365. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.OnDocumentRead">
  6366. Read document
  6367. </member>
  6368. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.SetFootnotes(NPOI.OpenXmlFormats.Wordprocessing.CT_Footnotes)">
  6369. Sets the ctFootnotes
  6370. @param footnotes
  6371. </member>
  6372. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.AddFootnote(NPOI.XWPF.UserModel.XWPFFootnote)">
  6373. add an XWPFFootnote to the document
  6374. @param footnote
  6375. @throws IOException
  6376. </member>
  6377. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.AddFootnote(NPOI.OpenXmlFormats.Wordprocessing.CT_FtnEdn)">
  6378. add a footnote to the document
  6379. @param note
  6380. @throws IOException
  6381. </member>
  6382. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.GetXWPFDocument">
  6383. @see NPOI.XWPF.UserModel.IBody#getPart()
  6384. </member>
  6385. <member name="T:NPOI.XWPF.UserModel.XWPFHeader">
  6386. Sketch of XWPF header class
  6387. </member>
  6388. <member name="M:NPOI.XWPF.UserModel.XWPFHeader.Commit">
  6389. <summary>
  6390. Save and commit footer
  6391. </summary>
  6392. </member>
  6393. <member name="M:NPOI.XWPF.UserModel.XWPFHeader.OnDocumentRead">
  6394. <summary>
  6395. Read the document
  6396. </summary>
  6397. </member>
  6398. <member name="P:NPOI.XWPF.UserModel.XWPFHeader.PartType">
  6399. <summary>
  6400. Get the PartType of the body
  6401. </summary>
  6402. </member>
  6403. <member name="T:NPOI.XWPF.UserModel.XWPFHyperlink">
  6404. * Sketch of XWPF hyperlink class
  6405. *
  6406. * @author Yury Batrakov (batrakov at gmail.com)
  6407. *
  6408. </member>
  6409. <member name="T:NPOI.XWPF.UserModel.XWPFHyperlinkRun">
  6410. A run of text with a Hyperlink applied to it.
  6411. Any given Hyperlink may be made up of multiple of these.
  6412. </member>
  6413. <member name="T:NPOI.XWPF.UserModel.XWPFRun">
  6414. XWPFrun.object defines a region of text with a common Set of properties
  6415. @author Yegor Kozlov
  6416. @author Gregg Morris (gregg dot morris at gmail dot com) - added getColor(), setColor()
  6417. </member>
  6418. <member name="M:NPOI.XWPF.UserModel.XWPFRun.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_R,NPOI.XWPF.UserModel.XWPFParagraph)">
  6419. @param r the CT_R bean which holds the run.attributes
  6420. @param p the parent paragraph
  6421. </member>
  6422. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetCTR">
  6423. Get the currently used CT_R object
  6424. @return CT_R object
  6425. </member>
  6426. <member name="M:NPOI.XWPF.UserModel.XWPFRun.IsCTOnOff(NPOI.OpenXmlFormats.Wordprocessing.CT_OnOff)">
  6427. For isBold, isItalic etc
  6428. </member>
  6429. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetBold(System.Boolean)">
  6430. Whether the bold property shall be applied to all non-complex script
  6431. characters in the contents of this run.when displayed in a document.
  6432. <p>
  6433. This formatting property is a toggle property, which specifies that its
  6434. behavior differs between its use within a style defInition and its use as
  6435. direct formatting. When used as part of a style defInition, Setting this
  6436. property shall toggle the current state of that property as specified up
  6437. to this point in the hierarchy (i.e. applied to not applied, and vice
  6438. versa). Setting it to <code>false</code> (or an equivalent) shall
  6439. result in the current Setting remaining unChanged. However, when used as
  6440. direct formatting, Setting this property to true or false shall Set the
  6441. absolute state of the resulting property.
  6442. </p>
  6443. <p>
  6444. If this element is not present, the default value is to leave the
  6445. formatting applied at previous level in the style hierarchy. If this
  6446. element is never applied in the style hierarchy, then bold shall not be
  6447. applied to non-complex script characters.
  6448. </p>
  6449. @param value <code>true</code> if the bold property is applied to
  6450. this run
  6451. </member>
  6452. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetColor">
  6453. Get text color. The returned value is a string in the hex form "RRGGBB".
  6454. </member>
  6455. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetColor(System.String)">
  6456. Set text color.
  6457. @param rgbStr - the desired color, in the hex form "RRGGBB".
  6458. </member>
  6459. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetText(System.Int32)">
  6460. Return the string content of this text run
  6461. @return the text of this text run.or <code>null</code> if not Set
  6462. </member>
  6463. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetText(System.String)">
  6464. Sets the text of this text run
  6465. @param value the literal text which shall be displayed in the document
  6466. </member>
  6467. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetText(System.String,System.Int32)">
  6468. Sets the text of this text run.in the
  6469. @param value the literal text which shall be displayed in the document
  6470. @param pos - position in the text array (NB: 0 based)
  6471. </member>
  6472. <member name="M:NPOI.XWPF.UserModel.XWPFRun.InsertText(System.String,System.Int32)">
  6473. <summary>
  6474. insert text at start index in the run
  6475. </summary>
  6476. <param name="text">insert text</param>
  6477. <param name="startIndex">start index of the insertion in the run text</param>
  6478. </member>
  6479. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetUnderline(NPOI.XWPF.UserModel.UnderlinePatterns)">
  6480. Specifies that the contents of this run.should be displayed along with an
  6481. underline appearing directly below the character heigh
  6482. If this element is not present, the default value is to leave the
  6483. formatting applied at previous level in the style hierarchy. If this
  6484. element is never applied in the style hierarchy, then an underline shall
  6485. not be applied to the contents of this run.
  6486. @param value -
  6487. underline type
  6488. @see UnderlinePatterns : all possible patterns that could be applied
  6489. </member>
  6490. <!-- 对于成员“M:NPOI.XWPF.UserModel.XWPFRun.SetStrike(System.Boolean)”忽略有格式错误的 XML 注释 -->
  6491. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetTextPosition">
  6492. This element specifies the amount by which text shall be raised or
  6493. lowered for this run.in relation to the default baseline of the
  6494. surrounding non-positioned text. This allows the text to be repositioned
  6495. without altering the font size of the contents.
  6496. @return a big integer representing the amount of text shall be "moved"
  6497. </member>
  6498. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetTextPosition(System.Int32)">
  6499. This element specifies the amount by which text shall be raised or
  6500. lowered for this run.in relation to the default baseline of the
  6501. surrounding non-positioned text. This allows the text to be repositioned
  6502. without altering the font size of the contents.
  6503. If the val attribute is positive, then the parent run.shall be raised
  6504. above the baseline of the surrounding text by the specified number of
  6505. half-points. If the val attribute is negative, then the parent run.shall
  6506. be lowered below the baseline of the surrounding text by the specified
  6507. number of half-points.
  6508. *
  6509. If this element is not present, the default value is to leave the
  6510. formatting applied at previous level in the style hierarchy. If this
  6511. element is never applied in the style hierarchy, then the text shall not
  6512. be raised or lowered relative to the default baseline location for the
  6513. contents of this run.
  6514. </member>
  6515. <member name="M:NPOI.XWPF.UserModel.XWPFRun.RemoveBreak">
  6516. </member>
  6517. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddBreak">
  6518. Specifies that a break shall be placed at the current location in the run
  6519. content.
  6520. A break is a special character which is used to override the
  6521. normal line breaking that would be performed based on the normal layout
  6522. of the document's contents.
  6523. @see #AddCarriageReturn()
  6524. </member>
  6525. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddBreak(NPOI.XWPF.UserModel.BreakType)">
  6526. Specifies that a break shall be placed at the current location in the run
  6527. content.
  6528. A break is a special character which is used to override the
  6529. normal line breaking that would be performed based on the normal layout
  6530. of the document's contents.
  6531. <p>
  6532. The behavior of this break character (the
  6533. location where text shall be restarted After this break) shall be
  6534. determined by its type values.
  6535. </p>
  6536. @see BreakType
  6537. </member>
  6538. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddBreak(NPOI.XWPF.UserModel.BreakClear)">
  6539. Specifies that a break shall be placed at the current location in the run
  6540. content. A break is a special character which is used to override the
  6541. normal line breaking that would be performed based on the normal layout
  6542. of the document's contents.
  6543. <p>
  6544. The behavior of this break character (the
  6545. location where text shall be restarted After this break) shall be
  6546. determined by its type (in this case is BreakType.TEXT_WRAPPING as default) and clear attribute values.
  6547. </p>
  6548. @see BreakClear
  6549. </member>
  6550. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddCarriageReturn">
  6551. Specifies that a carriage return shall be placed at the
  6552. current location in the run.content.
  6553. A carriage return is used to end the current line of text in
  6554. WordProcess.
  6555. The behavior of a carriage return in run.content shall be
  6556. identical to a break character with null type and clear attributes, which
  6557. shall end the current line and find the next available line on which to
  6558. continue.
  6559. The carriage return character forced the following text to be
  6560. restarted on the next available line in the document.
  6561. </member>
  6562. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddPicture(System.IO.Stream,System.Int32,System.String,System.Int32,System.Int32)">
  6563. Adds a picture to the run. This method handles
  6564. attaching the picture data to the overall file.
  6565. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_EMF
  6566. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_WMF
  6567. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_PICT
  6568. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_JPEG
  6569. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_PNG
  6570. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_DIB
  6571. @param pictureData The raw picture data
  6572. @param pictureType The type of the picture, eg {@link Document#PICTURE_TYPE_JPEG}
  6573. @param width width in EMUs. To convert to / from points use {@link org.apache.poi.util.Units}
  6574. @param height height in EMUs. To convert to / from points use {@link org.apache.poi.util.Units}
  6575. @throws NPOI.Openxml4j.exceptions.InvalidFormatException
  6576. @throws IOException
  6577. </member>
  6578. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetEmbeddedPictures">
  6579. Returns the embedded pictures of the run. These
  6580. are pictures which reference an external,
  6581. embedded picture image such as a .png or .jpg
  6582. </member>
  6583. <member name="M:NPOI.XWPF.UserModel.XWPFRun.preserveSpaces(NPOI.OpenXmlFormats.Wordprocessing.CT_Text)">
  6584. Add the xml:spaces="preserve" attribute if the string has leading or trailing white spaces
  6585. @param xs the string to check
  6586. </member>
  6587. <member name="M:NPOI.XWPF.UserModel.XWPFRun.ToString">
  6588. Returns the string version of the text, with tabs and
  6589. carriage returns in place of their xml equivalents.
  6590. </member>
  6591. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Paragraph">
  6592. Get the currenty referenced paragraph object
  6593. @return current paragraph
  6594. </member>
  6595. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Document">
  6596. @return The {@link XWPFDocument} instance, this run.belongs to, or
  6597. <code>null</code> if parent structure (paragraph > document) is not properly Set.
  6598. </member>
  6599. <member name="P:NPOI.XWPF.UserModel.XWPFRun.IsBold">
  6600. Whether the bold property shall be applied to all non-complex script
  6601. characters in the contents of this run.when displayed in a document
  6602. @return <code>true</code> if the bold property is applied
  6603. </member>
  6604. <member name="P:NPOI.XWPF.UserModel.XWPFRun.PictureText">
  6605. Returns text embedded in pictures
  6606. </member>
  6607. <member name="P:NPOI.XWPF.UserModel.XWPFRun.IsItalic">
  6608. Whether the italic property should be applied to all non-complex script
  6609. characters in the contents of this run.when displayed in a document.
  6610. @return <code>true</code> if the italic property is applied
  6611. </member>
  6612. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Underline">
  6613. Specifies that the contents of this run.should be displayed along with an
  6614. underline appearing directly below the character heigh
  6615. @return the Underline pattern Applyed to this run
  6616. @see UnderlinePatterns
  6617. </member>
  6618. <member name="P:NPOI.XWPF.UserModel.XWPFRun.IsStrike">
  6619. Specifies that the contents of this run.shall be displayed with a single
  6620. horizontal line through the center of the line.
  6621. @return <code>true</code> if the strike property is applied
  6622. </member>
  6623. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Subscript">
  6624. Specifies the alignment which shall be applied to the contents of this
  6625. run.in relation to the default appearance of the run.s text.
  6626. This allows the text to be repositioned as subscript or superscript without
  6627. altering the font size of the run.properties.
  6628. @return VerticalAlign
  6629. @see VerticalAlign all possible value that could be Applyed to this run
  6630. </member>
  6631. <member name="P:NPOI.XWPF.UserModel.XWPFRun.FontFamily">
  6632. Specifies the fonts which shall be used to display the text contents of
  6633. this run. Specifies a font which shall be used to format all characters
  6634. in the ASCII range (0 - 127) within the parent run
  6635. @return a string representing the font family
  6636. </member>
  6637. <member name="P:NPOI.XWPF.UserModel.XWPFRun.FontSize">
  6638. Specifies the font size which shall be applied to all non complex script
  6639. characters in the contents of this run.when displayed.
  6640. @return value representing the font size
  6641. </member>
  6642. <member name="M:NPOI.XWPF.UserModel.XWPFHyperlinkRun.GetHyperlinkId">
  6643. Returns the ID of the hyperlink, if one is Set.
  6644. </member>
  6645. <member name="M:NPOI.XWPF.UserModel.XWPFHyperlinkRun.GetHyperlink(NPOI.XWPF.UserModel.XWPFDocument)">
  6646. If this Hyperlink is an external reference hyperlink,
  6647. return the object for it.
  6648. </member>
  6649. <member name="M:NPOI.XWPF.UserModel.XWPFLatentStyles.IsLatentStyle(System.String)">
  6650. Checks wheter specific LatentStyleID is a latentStyle
  6651. </member>
  6652. <member name="T:NPOI.XWPF.UserModel.XWPFNum">
  6653. @author Philipp Epp
  6654. </member>
  6655. <member name="T:NPOI.XWPF.UserModel.XWPFNumbering">
  6656. @author Philipp Epp
  6657. </member>
  6658. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  6659. create a new styles object with an existing document
  6660. </member>
  6661. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.#ctor">
  6662. create a new XWPFNumbering object for use in a new document
  6663. </member>
  6664. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.OnDocumentRead">
  6665. read numbering form an existing package
  6666. </member>
  6667. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.Commit">
  6668. save and Commit numbering
  6669. </member>
  6670. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.SetNumbering(NPOI.OpenXmlFormats.Wordprocessing.CT_Numbering)">
  6671. Sets the ctNumbering
  6672. @param numbering
  6673. </member>
  6674. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.NumExist(System.String)">
  6675. Checks whether number with numID exists
  6676. @param numID
  6677. @return bool true if num exist, false if num not exist
  6678. </member>
  6679. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddNum(NPOI.XWPF.UserModel.XWPFNum)">
  6680. add a new number to the numbering document
  6681. @param num
  6682. </member>
  6683. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddNum(System.String)">
  6684. Add a new num with an abstractNumID
  6685. @return return NumId of the Added num
  6686. </member>
  6687. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddNum(System.String,System.String)">
  6688. Add a new num with an abstractNumID and a numID
  6689. @param abstractNumID
  6690. @param numID
  6691. </member>
  6692. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.GetNum(System.String)">
  6693. Get Num by NumID
  6694. @param numID
  6695. @return abstractNum with NumId if no Num exists with that NumID
  6696. null will be returned
  6697. </member>
  6698. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.GetAbstractNum(System.String)">
  6699. Get AbstractNum by abstractNumID
  6700. @param abstractNumID
  6701. @return abstractNum with abstractNumId if no abstractNum exists with that abstractNumID
  6702. null will be returned
  6703. </member>
  6704. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.GetIdOfAbstractNum(NPOI.XWPF.UserModel.XWPFAbstractNum)">
  6705. Compare AbstractNum with abstractNums of this numbering document.
  6706. If the content of abstractNum Equals with an abstractNum of the List in numbering
  6707. the Bigint Value of it will be returned.
  6708. If no equal abstractNum is existing null will be returned
  6709. @param abstractNum
  6710. @return Bigint
  6711. </member>
  6712. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddAbstractNum(NPOI.XWPF.UserModel.XWPFAbstractNum)">
  6713. add a new AbstractNum and return its AbstractNumID
  6714. @param abstractNum
  6715. </member>
  6716. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddAbstractNum">
  6717. <summary>
  6718. Add a new AbstractNum
  6719. </summary>
  6720. <returns></returns>
  6721. @author antony liu
  6722. </member>
  6723. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.RemoveAbstractNum(System.String)">
  6724. remove an existing abstractNum
  6725. @param abstractNumID
  6726. @return true if abstractNum with abstractNumID exists in NumberingArray,
  6727. false if abstractNum with abstractNumID not exists
  6728. </member>
  6729. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.GetAbstractNumID(System.String)">
  6730. return the abstractNumID
  6731. If the AbstractNumID not exists
  6732. return null
  6733. @param numID
  6734. @return abstractNumID
  6735. </member>
  6736. <member name="T:NPOI.XWPF.UserModel.XWPFParagraph">
  6737. Sketch of XWPF paragraph class
  6738. </member>
  6739. <member name="F:NPOI.XWPF.UserModel.XWPFParagraph.document">
  6740. For access to the document's hyperlink, comments, tables etc
  6741. </member>
  6742. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.BuildRunsInOrderFromXml(System.Collections.ArrayList)">
  6743. Identifies (in order) the parts of the paragraph /
  6744. sub-paragraph that correspond to character text
  6745. runs, and builds the appropriate runs for these.
  6746. </member>
  6747. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetNumID">
  6748. If style exist for this paragraph
  6749. NumId of the paragraph will be returned.
  6750. If style not exist null will be returned
  6751. @return NumID as Bigint
  6752. </member>
  6753. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SetNumID(System.String)">
  6754. SetNumID of Paragraph
  6755. @param numPos
  6756. </member>
  6757. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SetNumID(System.String,System.String)">
  6758. <summary>
  6759. Set NumID and level of Paragraph
  6760. </summary>
  6761. <param name="numId"></param>
  6762. <param name="ilvl"></param>
  6763. </member>
  6764. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.CreateRun">
  6765. <summary>
  6766. Appends a new run to this paragraph
  6767. </summary>
  6768. <returns>a new text run</returns>
  6769. </member>
  6770. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetCTPBrd(System.Boolean)">
  6771. Get a <b>copy</b> of the currently used CTPBrd, if none is used, return
  6772. a new instance.
  6773. </member>
  6774. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetCTSpacing(System.Boolean)">
  6775. Get a <b>copy</b> of the currently used CTSpacing, if none is used,
  6776. return a new instance.
  6777. </member>
  6778. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetCTInd(System.Boolean)">
  6779. Get a <b>copy</b> of the currently used CTPInd, if none is used, return
  6780. a new instance.
  6781. </member>
  6782. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetCTPPr">
  6783. Get a <b>copy</b> of the currently used CTPPr, if none is used, return
  6784. a new instance.
  6785. </member>
  6786. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.AddRun(NPOI.OpenXmlFormats.Wordprocessing.CT_R)">
  6787. add a new run at the end of the position of
  6788. the content of parameter run
  6789. @param run
  6790. </member>
  6791. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.ReplaceText(System.String,System.String)">
  6792. <summary>
  6793. Replace text inside each run (cross run is not supported yet)
  6794. </summary>
  6795. <param name="oldText">target text</param>
  6796. <param name="newText">replacement text</param>
  6797. </member>
  6798. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SearchText(System.String,NPOI.XWPF.UserModel.PositionInParagraph)">
  6799. <summary>
  6800. this methods parse the paragraph and search for the string searched.
  6801. If it finds the string, it will return true and the position of the String will be saved in the parameter startPos.
  6802. </summary>
  6803. <param name="searched"></param>
  6804. <param name="startPos"></param>
  6805. <returns></returns>
  6806. </member>
  6807. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.InsertNewRun(System.Int32)">
  6808. <summary>
  6809. insert a new Run in RunArray
  6810. </summary>
  6811. <param name="pos"></param>
  6812. <returns>the inserted run</returns>
  6813. </member>
  6814. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetText(NPOI.XWPF.UserModel.TextSegement)">
  6815. Get a Text
  6816. @param segment
  6817. </member>
  6818. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.RemoveRun(System.Int32)">
  6819. Removes a Run at the position pos in the paragraph
  6820. @param pos
  6821. @return true if the run was Removed
  6822. </member>
  6823. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetPart">
  6824. returns the part of the bodyElement
  6825. @see NPOI.XWPF.UserModel.IBody#getPart()
  6826. </member>
  6827. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.AddRun(NPOI.XWPF.UserModel.XWPFRun)">
  6828. Adds a new Run to the Paragraph
  6829. @param r
  6830. </member>
  6831. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetRun(NPOI.OpenXmlFormats.Wordprocessing.CT_R)">
  6832. return the XWPFRun-Element which owns the CTR Run-Element
  6833. @param r
  6834. </member>
  6835. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.Text">
  6836. Return the textual content of the paragraph, including text from pictures
  6837. in it.
  6838. </member>
  6839. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.StyleID">
  6840. Return styleID of the paragraph if style exist for this paragraph
  6841. if not, null will be returned
  6842. @return styleID as String
  6843. </member>
  6844. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.ParagraphText">
  6845. Returns the text of the paragraph, but not of any objects in the
  6846. paragraph
  6847. </member>
  6848. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.PictureText">
  6849. Returns any text from any suitable pictures in the paragraph
  6850. </member>
  6851. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.FootnoteText">
  6852. Returns the footnote text of the paragraph
  6853. @return the footnote text or empty string if the paragraph does not have footnotes
  6854. </member>
  6855. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.Alignment">
  6856. Returns the paragraph alignment which shall be applied to text in this
  6857. paragraph.
  6858. <p>
  6859. If this element is not Set on a given paragraph, its value is determined
  6860. by the Setting previously Set at any level of the style hierarchy (i.e.
  6861. that previous Setting remains unChanged). If this Setting is never
  6862. specified in the style hierarchy, then no alignment is applied to the
  6863. paragraph.
  6864. </p>
  6865. @return the paragraph alignment of this paragraph.
  6866. </member>
  6867. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.VerticalAlignment">
  6868. Returns the text vertical alignment which shall be applied to text in
  6869. this paragraph.
  6870. <p>
  6871. If the line height (before any Added spacing) is larger than one or more
  6872. characters on the line, all characters will be aligned to each other as
  6873. specified by this element.
  6874. </p>
  6875. <p>
  6876. If this element is omitted on a given paragraph, its value is determined
  6877. by the Setting previously Set at any level of the style hierarchy (i.e.
  6878. that previous Setting remains unChanged). If this Setting is never
  6879. specified in the style hierarchy, then the vertical alignment of all
  6880. characters on the line shall be automatically determined by the consumer.
  6881. </p>
  6882. @return the vertical alignment of this paragraph.
  6883. </member>
  6884. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.BorderTop">
  6885. <summary>
  6886. the top border for the paragraph
  6887. </summary>
  6888. </member>
  6889. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.BorderBottom">
  6890. <summary>
  6891. Specifies the border which shall be displayed below a Set of
  6892. paragraphs which have the same Set of paragraph border Settings.
  6893. </summary>
  6894. <returns>the bottom border for the paragraph</returns>
  6895. </member>
  6896. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.BorderLeft">
  6897. <summary>
  6898. Specifies the border which shall be displayed on the left side of the
  6899. page around the specified paragraph.
  6900. </summary>
  6901. <returns>the left border for the paragraph</returns>
  6902. </member>
  6903. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.BorderRight">
  6904. Specifies the border which shall be displayed on the right side of the
  6905. page around the specified paragraph.
  6906. @return ParagraphBorder - the right border for the paragraph
  6907. @see #setBorderRight(Borders)
  6908. @see Borders for a list of all possible borders
  6909. </member>
  6910. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.BorderBetween">
  6911. Specifies the border which shall be displayed between each paragraph in a
  6912. Set of paragraphs which have the same Set of paragraph border Settings.
  6913. @return ParagraphBorder - the between border for the paragraph
  6914. @see #setBorderBetween(Borders)
  6915. @see Borders for a list of all possible borders
  6916. </member>
  6917. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IsPageBreak">
  6918. Specifies that when rendering this document in a paginated
  6919. view, the contents of this paragraph are rendered on the start of a new
  6920. page in the document.
  6921. <p>
  6922. If this element is omitted on a given paragraph,
  6923. its value is determined by the Setting previously Set at any level of the
  6924. style hierarchy (i.e. that previous Setting remains unChanged). If this
  6925. Setting is never specified in the style hierarchy, then this property
  6926. shall not be applied. Since the paragraph is specified to start on a new
  6927. page, it begins page two even though it could have fit on page one.
  6928. </p>
  6929. @return bool - if page break is Set
  6930. </member>
  6931. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingAfter">
  6932. Specifies the spacing that should be Added After the last line in this
  6933. paragraph in the document in absolute units.
  6934. @return int - value representing the spacing After the paragraph
  6935. </member>
  6936. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingAfterLines">
  6937. Specifies the spacing that should be Added After the last line in this
  6938. paragraph in the document in absolute units.
  6939. @return bigint - value representing the spacing After the paragraph
  6940. @see #setSpacingAfterLines(int)
  6941. </member>
  6942. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingBefore">
  6943. Specifies the spacing that should be Added above the first line in this
  6944. paragraph in the document in absolute units.
  6945. @return the spacing that should be Added above the first line
  6946. @see #setSpacingBefore(int)
  6947. </member>
  6948. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingBeforeLines">
  6949. Specifies the spacing that should be Added before the first line in this paragraph in the
  6950. document in line units.
  6951. The value of this attribute is specified in one hundredths of a line.
  6952. @return the spacing that should be Added before the first line in this paragraph
  6953. @see #setSpacingBeforeLines(int)
  6954. </member>
  6955. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingLineRule">
  6956. Specifies how the spacing between lines is calculated as stored in the
  6957. line attribute. If this attribute is omitted, then it shall be assumed to
  6958. be of a value auto if a line attribute value is present.
  6959. @return rule
  6960. @see LineSpacingRule
  6961. @see #setSpacingLineRule(LineSpacingRule)
  6962. </member>
  6963. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IndentationLeft">
  6964. Specifies the indentation which shall be placed between the left text
  6965. margin for this paragraph and the left edge of that paragraph's content
  6966. in a left to right paragraph, and the right text margin and the right
  6967. edge of that paragraph's text in a right to left paragraph
  6968. <p>
  6969. If this attribute is omitted, its value shall be assumed to be zero.
  6970. Negative values are defined such that the text is Moved past the text margin,
  6971. positive values Move the text inside the text margin.
  6972. </p>
  6973. @return indentation or null if indentation is not Set
  6974. </member>
  6975. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IndentationRight">
  6976. Specifies the indentation which shall be placed between the right text
  6977. margin for this paragraph and the right edge of that paragraph's content
  6978. in a left to right paragraph, and the right text margin and the right
  6979. edge of that paragraph's text in a right to left paragraph
  6980. <p>
  6981. If this attribute is omitted, its value shall be assumed to be zero.
  6982. Negative values are defined such that the text is Moved past the text margin,
  6983. positive values Move the text inside the text margin.
  6984. </p>
  6985. @return indentation or null if indentation is not Set
  6986. </member>
  6987. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IndentationHanging">
  6988. Specifies the indentation which shall be Removed from the first line of
  6989. the parent paragraph, by moving the indentation on the first line back
  6990. towards the beginning of the direction of text flow.
  6991. This indentation is
  6992. specified relative to the paragraph indentation which is specified for
  6993. all other lines in the parent paragraph.
  6994. The firstLine and hanging
  6995. attributes are mutually exclusive, if both are specified, then the
  6996. firstLine value is ignored.
  6997. @return indentation or null if indentation is not Set
  6998. </member>
  6999. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IndentationFirstLine">
  7000. Specifies the Additional indentation which shall be applied to the first
  7001. line of the parent paragraph. This Additional indentation is specified
  7002. relative to the paragraph indentation which is specified for all other
  7003. lines in the parent paragraph.
  7004. The firstLine and hanging attributes are
  7005. mutually exclusive, if both are specified, then the firstLine value is
  7006. ignored.
  7007. If the firstLineChars attribute is also specified, then this
  7008. value is ignored.
  7009. If this attribute is omitted, then its value shall be
  7010. assumed to be zero (if needed).
  7011. @return indentation or null if indentation is not Set
  7012. </member>
  7013. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IsWordWrap">
  7014. This element specifies whether a consumer shall break Latin text which
  7015. exceeds the text extents of a line by breaking the word across two lines
  7016. (breaking on the character level) or by moving the word to the following
  7017. line (breaking on the word level).
  7018. @return bool
  7019. </member>
  7020. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.Style">
  7021. @return the style of the paragraph
  7022. </member>
  7023. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.ElementType">
  7024. returns the type of the BodyElement Paragraph
  7025. @see NPOI.XWPF.UserModel.IBodyElement#getElementType()
  7026. </member>
  7027. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.PartType">
  7028. returns the partType of the bodyPart which owns the bodyElement
  7029. @see NPOI.XWPF.UserModel.IBody#getPartType()
  7030. </member>
  7031. <member name="T:NPOI.XWPF.UserModel.XWPFPicture">
  7032. @author Philipp Epp
  7033. </member>
  7034. <member name="M:NPOI.XWPF.UserModel.XWPFPicture.SetPictureReference(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  7035. Link Picture with PictureData
  7036. @param rel
  7037. </member>
  7038. <member name="M:NPOI.XWPF.UserModel.XWPFPicture.GetCTPicture">
  7039. Return the underlying CTPicture bean that holds all properties for this picture
  7040. @return the underlying CTPicture bean
  7041. </member>
  7042. <member name="M:NPOI.XWPF.UserModel.XWPFPicture.GetPictureData">
  7043. Get the PictureData of the Picture, if present.
  7044. Note - not all kinds of picture have data
  7045. </member>
  7046. <member name="T:NPOI.XWPF.UserModel.XWPFPictureData">
  7047. <summary>
  7048. Raw picture data, normally attached to a WordProcessingML Drawing. As a rule, pictures are stored in the /word/media/ part of a WordProcessingML package.
  7049. </summary>
  7050. <remarks>
  7051. @author Philipp Epp
  7052. </remarks>
  7053. </member>
  7054. <member name="F:NPOI.XWPF.UserModel.XWPFPictureData.RELATIONS">
  7055. Relationships for each known picture type
  7056. </member>
  7057. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.#ctor">
  7058. Create a new XWPFGraphicData node
  7059. </member>
  7060. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  7061. Construct XWPFPictureData from a package part
  7062. @param part the package part holding the Drawing data,
  7063. @param rel the package relationship holding this Drawing,
  7064. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/image
  7065. </member>
  7066. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.SuggestFileExtension">
  7067. Suggests a file extension for this image.
  7068. @return the file extension.
  7069. </member>
  7070. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.GetPictureType">
  7071. Return an integer constant that specifies type of this picture
  7072. @return an integer constant that specifies type of this picture
  7073. @see NPOI.XWPF.UserModel.PictureTypeEMF
  7074. @see NPOI.XWPF.UserModel.PictureTypeWMF
  7075. @see NPOI.XWPF.UserModel.PictureTypePICT
  7076. @see NPOI.XWPF.UserModel.PictureTypeJPEG
  7077. @see NPOI.XWPF.UserModel.PictureTypePNG
  7078. @see NPOI.XWPF.UserModel.PictureTypeDIB
  7079. </member>
  7080. <member name="P:NPOI.XWPF.UserModel.XWPFPictureData.Data">
  7081. Gets the picture data as a byte array.
  7082. <p>
  7083. Note, that this call might be expensive since all the picture data is copied into a temporary byte array.
  7084. You can grab the picture data directly from the underlying package part as follows:
  7085. <br/>
  7086. <code>
  7087. InputStream is1 = GetPackagePart().InputStream;
  7088. </code>
  7089. </p>
  7090. @return the Picture data.
  7091. </member>
  7092. <member name="P:NPOI.XWPF.UserModel.XWPFPictureData.FileName">
  7093. Returns the file name of the image, eg image7.jpg . The original filename
  7094. isn't always available, but if it can be found it's likely to be in the
  7095. CTDrawing
  7096. </member>
  7097. <member name="T:NPOI.XWPF.UserModel.XWPFRelation">
  7098. @author Yegor Kozlov
  7099. </member>
  7100. <member name="F:NPOI.XWPF.UserModel.XWPFRelation._table">
  7101. A map to lookup POIXMLRelation by its relation type
  7102. </member>
  7103. <member name="F:NPOI.XWPF.UserModel.XWPFRelation.IMAGE_EMF">
  7104. Supported image formats
  7105. </member>
  7106. <member name="M:NPOI.XWPF.UserModel.XWPFRelation.GetInstance(System.String)">
  7107. Get POIXMLRelation by relation type
  7108. @param rel relation type, for example,
  7109. <code>http://schemas.openxmlformats.org/officeDocument/2006/relationships/image</code>
  7110. @return registered POIXMLRelation or null if not found
  7111. </member>
  7112. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.GetZoomPercent">
  7113. In the zoom tag inside Settings.xml file <br/>
  7114. it Sets the value of zoom
  7115. @return percentage as an integer of zoom level
  7116. </member>
  7117. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.SetZoomPercent(System.Int64)">
  7118. <summary>
  7119. Set zoom. In the zoom tag inside settings.xml file it sets the value of zoom
  7120. </summary>
  7121. <param name="zoomPercent"></param>
  7122. <example>
  7123. sample snippet from Settings.xml
  7124. &lt;w:zoom w:percent="50" /&gt;
  7125. </example>
  7126. </member>
  7127. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.IsEnforcedWith(NPOI.OpenXmlFormats.Wordprocessing.ST_DocProtect)">
  7128. Verifies the documentProtection tag inside Settings.xml file <br/>
  7129. if the protection is enforced (w:enforcement="1") <br/>
  7130. and if the kind of protection Equals to passed (STDocProtect.Enum editValue) <br/>
  7131. <br/>
  7132. sample snippet from Settings.xml
  7133. <pre>
  7134. &lt;w:settings ... &gt;
  7135. &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
  7136. </pre>
  7137. @return true if documentProtection is enforced with option ReadOnly
  7138. </member>
  7139. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.SetEnforcementEditValue(NPOI.OpenXmlFormats.Wordprocessing.ST_DocProtect)">
  7140. Enforces the protection with the option specified by passed editValue.<br/>
  7141. <br/>
  7142. In the documentProtection tag inside Settings.xml file <br/>
  7143. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  7144. and the value of edit to the passed editValue (w:edit="[passed editValue]")<br/>
  7145. <br/>
  7146. sample snippet from Settings.xml
  7147. <pre>
  7148. &lt;w:settings ... &gt;
  7149. &lt;w:documentProtection w:edit=&quot;[passed editValue]&quot; w:enforcement=&quot;1&quot;/&gt;
  7150. </pre>
  7151. </member>
  7152. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.RemoveEnforcement">
  7153. Removes protection enforcement.<br/>
  7154. In the documentProtection tag inside Settings.xml file <br/>
  7155. it Sets the value of enforcement to "0" (w:enforcement="0") <br/>
  7156. </member>
  7157. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.SetUpdateFields">
  7158. Enforces fields update on document open (in Word).
  7159. In the settings.xml file <br/>
  7160. sets the updateSettings value to true (w:updateSettings w:val="true")
  7161. NOTICES:
  7162. <ul>
  7163. <li>Causing Word to ask on open: "This document contains fields that may refer to other files. Do you want to update the fields in this document?"
  7164. (if "Update automatic links at open" is enabled)</li>
  7165. <li>Flag is removed after saving with changes in Word </li>
  7166. </ul>
  7167. </member>
  7168. <member name="T:NPOI.XWPF.UserModel.XWPFStyle">
  7169. @author Philipp Epp
  7170. </member>
  7171. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_Style)">
  7172. constructor
  7173. @param style
  7174. </member>
  7175. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_Style,NPOI.XWPF.UserModel.XWPFStyles)">
  7176. constructor
  7177. @param style
  7178. @param styles
  7179. </member>
  7180. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.SetStyle(NPOI.OpenXmlFormats.Wordprocessing.CT_Style)">
  7181. Set style
  7182. @param style
  7183. </member>
  7184. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.GetCTStyle">
  7185. Get ctStyle
  7186. @return ctStyle
  7187. </member>
  7188. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.GetStyles">
  7189. Get styles
  7190. @return styles the styles to which this style belongs
  7191. </member>
  7192. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.HasSameName(NPOI.XWPF.UserModel.XWPFStyle)">
  7193. Compares the names of the Styles
  7194. @param compStyle
  7195. </member>
  7196. <member name="P:NPOI.XWPF.UserModel.XWPFStyle.StyleId">
  7197. Get StyleID of the style
  7198. @return styleID StyleID of the style
  7199. </member>
  7200. <member name="P:NPOI.XWPF.UserModel.XWPFStyle.StyleType">
  7201. Get Type of the Style
  7202. @return ctType
  7203. </member>
  7204. <member name="P:NPOI.XWPF.UserModel.XWPFStyle.LinkStyleID">
  7205. Get StyleID of the linked Style
  7206. </member>
  7207. <member name="P:NPOI.XWPF.UserModel.XWPFStyle.NextStyleID">
  7208. Get StyleID of the next style
  7209. </member>
  7210. <member name="T:NPOI.XWPF.UserModel.XWPFStyles">
  7211. @author Philipp Epp
  7212. </member>
  7213. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  7214. Construct XWPFStyles from a package part
  7215. @param part the package part holding the data of the styles,
  7216. @param rel the package relationship of type "http://schemas.Openxmlformats.org/officeDocument/2006/relationships/styles"
  7217. </member>
  7218. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.#ctor">
  7219. Construct XWPFStyles from scratch for a new document.
  7220. </member>
  7221. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.OnDocumentRead">
  7222. Read document
  7223. </member>
  7224. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.SetStyles(NPOI.OpenXmlFormats.Wordprocessing.CT_Styles)">
  7225. Sets the ctStyles
  7226. @param styles
  7227. </member>
  7228. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.StyleExist(System.String)">
  7229. Checks whether style with styleID exist
  7230. @param styleID styleID of the Style in the style-Document
  7231. @return true if style exist, false if style not exist
  7232. </member>
  7233. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.AddStyle(NPOI.XWPF.UserModel.XWPFStyle)">
  7234. add a style to the document
  7235. @param style
  7236. @throws IOException
  7237. </member>
  7238. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetStyle(System.String)">
  7239. get style by a styleID
  7240. @param styleID styleID of the searched style
  7241. @return style
  7242. </member>
  7243. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetUsedStyleList(NPOI.XWPF.UserModel.XWPFStyle)">
  7244. Get the styles which are related to the parameter style and their relatives
  7245. this method can be used to copy all styles from one document to another document
  7246. @param style
  7247. @return a list of all styles which were used by this method
  7248. </member>
  7249. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetUsedStyleList(NPOI.XWPF.UserModel.XWPFStyle,System.Collections.Generic.List{NPOI.XWPF.UserModel.XWPFStyle})">
  7250. Get the styles which are related to parameter style
  7251. @param style
  7252. @return all Styles of the parameterList
  7253. </member>
  7254. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.SetSpellingLanguage(System.String)">
  7255. Sets the default spelling language on ctStyles DocDefaults parameter
  7256. @param strSpellingLanguage
  7257. </member>
  7258. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.SetEastAsia(System.String)">
  7259. Sets the default East Asia spelling language on ctStyles DocDefaults parameter
  7260. @param strEastAsia
  7261. </member>
  7262. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.SetDefaultFonts(NPOI.OpenXmlFormats.Wordprocessing.CT_Fonts)">
  7263. Sets the default font on ctStyles DocDefaults parameter
  7264. @param fonts
  7265. </member>
  7266. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetLatentStyles">
  7267. Get latentstyles
  7268. </member>
  7269. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetStyleWithSameName(NPOI.XWPF.UserModel.XWPFStyle)">
  7270. Get the style with the same name
  7271. if this style is not existing, return null
  7272. </member>
  7273. <member name="T:NPOI.XWPF.UserModel.XWPFTable">
  7274. Sketch of XWPFTable class. Only table's text is being hold.
  7275. <p/>
  7276. Specifies the contents of a table present in the document. A table is a Set
  7277. of paragraphs (and other block-level content) arranged in rows and columns.
  7278. @author Yury Batrakov (batrakov at gmail.com)
  7279. @author Gregg Morris (gregg dot morris at gmail dot com) - added
  7280. setStyleID()
  7281. getRowBandSize(), setRowBandSize()
  7282. getColBandSize(), setColBandSize()
  7283. getInsideHBorderType(), getInsideHBorderSize(), getInsideHBorderSpace(), getInsideHBorderColor()
  7284. getInsideVBorderType(), getInsideVBorderSize(), getInsideVBorderSpace(), getInsideVBorderColor()
  7285. setInsideHBorder(), setInsideVBorder()
  7286. getCellMarginTop(), getCellMarginLeft(), getCellMarginBottom(), getCellMarginRight()
  7287. setCellMargins()
  7288. </member>
  7289. <member name="M:NPOI.XWPF.UserModel.XWPFTable.GetCTTbl">
  7290. @return ctTbl object
  7291. </member>
  7292. <member name="M:NPOI.XWPF.UserModel.XWPFTable.AddNewCol">
  7293. add a new column for each row in this table
  7294. </member>
  7295. <member name="M:NPOI.XWPF.UserModel.XWPFTable.CreateRow">
  7296. create a new XWPFTableRow object with as many cells as the number of columns defined in that moment
  7297. @return tableRow
  7298. </member>
  7299. <member name="M:NPOI.XWPF.UserModel.XWPFTable.GetRow(System.Int32)">
  7300. @param pos - index of the row
  7301. @return the row at the position specified or null if no rows is defined or if the position is greather than the max size of rows array
  7302. </member>
  7303. <member name="M:NPOI.XWPF.UserModel.XWPFTable.AddRow(NPOI.XWPF.UserModel.XWPFTableRow)">
  7304. add a new Row to the table
  7305. @param row the row which should be Added
  7306. </member>
  7307. <member name="M:NPOI.XWPF.UserModel.XWPFTable.AddRow(NPOI.XWPF.UserModel.XWPFTableRow,System.Int32)">
  7308. add a new Row to the table
  7309. at position pos
  7310. @param row the row which should be Added
  7311. </member>
  7312. <member name="M:NPOI.XWPF.UserModel.XWPFTable.InsertNewTableRow(System.Int32)">
  7313. inserts a new tablerow
  7314. @param pos
  7315. @return the inserted row
  7316. </member>
  7317. <member name="M:NPOI.XWPF.UserModel.XWPFTable.RemoveRow(System.Int32)">
  7318. Remove a row at position pos from the table
  7319. @param pos position the Row in the Table
  7320. </member>
  7321. <member name="M:NPOI.XWPF.UserModel.XWPFTable.GetPart">
  7322. returns the part of the bodyElement
  7323. @see NPOI.XWPF.UserModel.IBody#getPart()
  7324. </member>
  7325. <member name="M:NPOI.XWPF.UserModel.XWPFTable.GetRow(NPOI.OpenXmlFormats.Wordprocessing.CT_Row)">
  7326. returns the XWPFRow which belongs to the CTRow row
  7327. if this row is not existing in the table null will be returned
  7328. </member>
  7329. <member name="P:NPOI.XWPF.UserModel.XWPFTable.Text">
  7330. @return text
  7331. </member>
  7332. <member name="P:NPOI.XWPF.UserModel.XWPFTable.Width">
  7333. @return width value
  7334. </member>
  7335. <member name="P:NPOI.XWPF.UserModel.XWPFTable.NumberOfRows">
  7336. @return number of rows in table
  7337. </member>
  7338. <member name="P:NPOI.XWPF.UserModel.XWPFTable.StyleID">
  7339. Get the StyleID of the table
  7340. @return style-ID of the table
  7341. </member>
  7342. <member name="P:NPOI.XWPF.UserModel.XWPFTable.ElementType">
  7343. returns the type of the BodyElement Table
  7344. @see NPOI.XWPF.UserModel.IBodyElement#getElementType()
  7345. </member>
  7346. <member name="P:NPOI.XWPF.UserModel.XWPFTable.PartType">
  7347. returns the partType of the bodyPart which owns the bodyElement
  7348. @see NPOI.XWPF.UserModel.IBody#getPartType()
  7349. </member>
  7350. <member name="T:NPOI.XWPF.UserModel.XWPFTableCell">
  7351. XWPFTableCell class.
  7352. @author Gregg Morris (gregg dot morris at gmail dot com) - added XWPFVertAlign enum,
  7353. setColor(),
  7354. setVerticalAlignment()
  7355. </member>
  7356. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc,NPOI.XWPF.UserModel.XWPFTableRow,NPOI.XWPF.UserModel.IBody)">
  7357. If a table cell does not include at least one block-level element, then this document shall be considered corrupt
  7358. </member>
  7359. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.AddParagraph">
  7360. Add a Paragraph to this Table Cell
  7361. @return The paragraph which was Added
  7362. </member>
  7363. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.AddParagraph(NPOI.XWPF.UserModel.XWPFParagraph)">
  7364. add a Paragraph to this TableCell
  7365. @param p the paragaph which has to be Added
  7366. </member>
  7367. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.RemoveParagraph(System.Int32)">
  7368. Removes a paragraph of this tablecell
  7369. @param pos
  7370. </member>
  7371. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  7372. if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this table
  7373. the method will return this paragraph
  7374. if there is no corresponding {@link XWPFParagraph} the method will return null
  7375. @param p is instance of CTP and is searching for an XWPFParagraph
  7376. @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this table
  7377. XWPFParagraph with the correspondig CTP p
  7378. </member>
  7379. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.SetColor(System.String)">
  7380. Set cell color. This sets some associated values; for finer control
  7381. you may want to access these elements individually.
  7382. @param rgbStr - the desired cell color, in the hex form "RRGGBB".
  7383. </member>
  7384. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetColor">
  7385. Get cell color. Note that this method only returns the "fill" value.
  7386. @return RGB string of cell color
  7387. </member>
  7388. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.SetVerticalAlignment(NPOI.XWPF.UserModel.XWPFTableCell.XWPFVertAlign)">
  7389. Set the vertical alignment of the cell.
  7390. @param vAlign - the desired alignment enum value
  7391. </member>
  7392. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetVerticalAlignment">
  7393. Get the vertical alignment of the cell.
  7394. @return the cell alignment enum value
  7395. </member>
  7396. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.InsertNewParagraph(System.Xml.XmlDocument)">
  7397. add a new paragraph at position of the cursor
  7398. @param cursor
  7399. @return the inserted paragraph
  7400. </member>
  7401. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.IsCursorInTableCell(System.Xml.XmlDocument)">
  7402. verifies that cursor is on the right position
  7403. </member>
  7404. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetParagraphArray(System.Int32)">
  7405. @see NPOI.XWPF.UserModel.IBody#getParagraphArray(int)
  7406. </member>
  7407. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetPart">
  7408. Get the to which the TableCell belongs
  7409. @see NPOI.XWPF.UserModel.IBody#getPart()
  7410. </member>
  7411. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  7412. Get a table by its CTTbl-Object
  7413. @see NPOI.XWPF.UserModel.IBody#getTable(org.Openxmlformats.schemas.wordProcessingml.x2006.main.CTTbl)
  7414. </member>
  7415. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetTableArray(System.Int32)">
  7416. @see NPOI.XWPF.UserModel.IBody#getTableArray(int)
  7417. </member>
  7418. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  7419. inserts an existing XWPFTable to the arrays bodyElements and tables
  7420. @see NPOI.XWPF.UserModel.IBody#insertTable(int, NPOI.XWPF.UserModel.XWPFTable)
  7421. </member>
  7422. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  7423. Get the TableCell which belongs to the TableCell
  7424. </member>
  7425. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.BodyElements">
  7426. returns an Iterator with paragraphs and tables
  7427. @see NPOI.XWPF.UserModel.IBody#getBodyElements()
  7428. </member>
  7429. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.Paragraphs">
  7430. returns a list of paragraphs
  7431. </member>
  7432. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.PartType">
  7433. @see NPOI.XWPF.UserModel.IBody#getPartType()
  7434. </member>
  7435. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.Tables">
  7436. @see NPOI.XWPF.UserModel.IBody#getTables()
  7437. </member>
  7438. <member name="T:NPOI.XWPF.UserModel.XWPFTableRow">
  7439. @author gisellabronzetti
  7440. @author gregg morris - added removeCell(), setCantSplitRow(), setRepeatHeader()
  7441. </member>
  7442. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.CreateCell">
  7443. create a new XWPFTableCell and add it to the tableCell-list of this tableRow
  7444. @return the newly Created XWPFTableCell
  7445. </member>
  7446. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.AddNewTableCell">
  7447. Adds a new TableCell at the end of this tableRow
  7448. </member>
  7449. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.GetTableCells">
  7450. create and return a list of all XWPFTableCell
  7451. who belongs to this row
  7452. @return a list of {@link XWPFTableCell}
  7453. </member>
  7454. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  7455. returns the XWPFTableCell which belongs to the CTTC cell
  7456. if there is no XWPFTableCell which belongs to the parameter CTTc cell null will be returned
  7457. </member>
  7458. <member name="P:NPOI.XWPF.UserModel.XWPFTableRow.Height">
  7459. This element specifies the height of the current table row within the
  7460. current table. This height shall be used to determine the resulting
  7461. height of the table row, which may be absolute or relative (depending on
  7462. its attribute values). If omitted, then the table row shall automatically
  7463. resize its height to the height required by its contents (the equivalent
  7464. of an hRule value of auto).
  7465. @return height
  7466. </member>
  7467. <member name="P:NPOI.XWPF.UserModel.XWPFTableRow.IsCantSplitRow">
  7468. Return true if the "can't split row" value is true. The logic for this
  7469. attribute is a little unusual: a TRUE value means DON'T allow rows to
  7470. split, FALSE means allow rows to split.
  7471. @return true if rows can't be split, false otherwise.
  7472. </member>
  7473. <member name="P:NPOI.XWPF.UserModel.XWPFTableRow.IsRepeatHeader">
  7474. Return true if a table's header row should be repeated at the top of a
  7475. table split across pages.
  7476. @return true if table's header row should be repeated at the top of each
  7477. page of table, false otherwise.
  7478. </member>
  7479. </members>
  7480. </doc>