19.3. Workbooks

Workbooks are the top-level parents of worksheets and stylesheet links.
<e:workbook>
Attributes
  • type — Defines the export model. The value is a string and can be either jxl or csv. The default is jxl.
  • templateURI — A template that forms the basis of the workbook. The value is a string (URI).
  • arrayGrowSize — The amount of memory (in bytes) by which the workbook data storage space should be increased. If your process reads many small workbooks inside a web application server, you may need to reduce the default size. The default value is 1 MB.
  • autoFilterDisabled — A Boolean value determining whether autofiltering is disabled.
  • cellValidationDisabled — A Boolean value determining whether cell validation is ignored.
  • characterSet — The character set used to read the spreadsheet. Has no effect on the spreadsheet being written. The value is a string (character set encoding).
  • drawingsDisabled — A Boolean value determining whether drawings are disabled.
  • excelDisplayLanguage — The language that the generated file will display in. The value is a string (two character ISO 3166 country code).
  • excelRegionalSettings — The regional settings for the generated file. The value is a string (two character ISO 3166 country code).
  • formulaAdjust — A Boolean determining whether formulas are adjusted.
  • gcDisabled — A Boolean determining whether garbage collection is disabled.
  • ignoreBlanks — A Boolean value determining whether blanks are ignored.
  • initialFileSize — The initial amount of memory (in bytes) allocated to workbook data storage when reading a worksheet. If your process reads many small workbooks inside a web application server, you may need to reduce the default size. The default value is 5 MB.
  • locale — The locale JExcelAPI uses to generate the spreadsheet. This value has no effect on the language or region of the generated file. The value is a string.
  • mergedCellCheckingDisabled — A Boolean determining whether merged cell checking is disabled.
  • namesDisabled — A Boolean determining whether name handling is disabled.
  • propertySets — A Boolean determining whether property sets (such as macros) are copied with the workbook. If this feature is enabled, the JXL process will use more memory.
  • rationalization — A Boolean determining whether cell formats are rationalized before the sheet is written. Defaults to true.
  • supressWarnings — A Boolean determining whether warnings are suppressed. Depending on the type of logger used, this sets the warning behavior across the JVM.
  • temporaryFileDuringWriteDirectory — A string value containing the target directory for temporary files. Used in conjunction with useTemporaryFileDuringWrite. If set to NULL, the default temporary directory is used instead.
  • useTemporaryFileDuringWrite — A Boolean determining whether a temporary file is used during workbook generation. If not set, the workbook will be generated entirely in memory. Setting this flag involves an assessment of the trade-offs between memory usage and performance.
  • workbookProtected — A Boolean determining whether the workbook is protected.
  • filename — A string value to be used as the download's filename. If you map the DocumentServlet to some pattern, its file extension must match.
  • exportKey — A key to store event-scoped data in a DocumentData object. If used, there is no redirection.
Child elements
Facets
  • none 
<e:workbook> 
  <e:worksheet> 
    <e:cell value="Hello World" row="0" column="0"/> 
  </e:worksheet> 
<e:workbook>
This defines a workbook with a worksheet and a greeting at cell A1.