fgl_report_configureXLSXDevice

Configure Excel™ output in XLSX format.

Syntax

fgl_report_configureXLSXDevice (
   fromPage INTEGER,
   toPage INTEGER,
   removeWhitespace BOOLEAN,
   ignoreRowAlignment BOOLEAN,
   ignoreColumnAlignment BOOLEAN,
   removeBackgroundImages BOOLEAN,
   mergePages BOOLEAN)
  1. fromPage - Selects the lower bound of the range of pages to include in the XLS document. The default value is 1.
  2. toPage - Selects the upper bound of the range of pages to include in the XLS document. By default all pages are included.
  3. removeWhitespace - Controls whether or not cells should be created for empty strings. The default is TRUE (whitespace is stripped from the document).
    Note:

    To specify a BOOLEAN value, enter TRUE or FALSE without quotation marks.

  4. ignoreRowAlignment - When set, only those objects that are entirely above or entirely below each other will go in separate rows. When set, the option reduces the amount of rows thereby losing the horizontal alignment. The placement is not changed so that stacked items remain stacked. The default is TRUE (row alignment is ignored).
  5. ignoreColumnAlignment - When set, only those objects that are entirely to the left or entirely to the right of each other will go in separate columns. When set, the option reduces the amount of columns thereby losing the vertical alignment. The placement is not changed so that adjacent items remain adjacent. The default is TRUE (column alignment is ignored).
  6. removeBackgroundImages - Controls the behavior in case an IMAGEBOX is partially obscured by another element. When set, the image is removed from the resulting document otherwise the handling is as with any other case of overlapping items. The default is TRUE (background images are removed).
  7. mergePages - Controls the behavior when the report has more than one page. The default is FALSE (a separate sheet is created per page). See also Output a single-sheet document to Excel.

Usage

Function to configure Excel output in XLSX format. The functionality is identical to the existing "XLS" output except for:

  • The format can be opened only by newer versions of Microsoft™ Excel (beginning with 2007). It is possible to download a backward compatibility pack from Microsoft that will allow opening of these files with older versions. Beware that in this case worksheets containing more then 65536 rows will be truncated at this limit.
  • The new format overcomes the 65536 row limit of the "XLS" format. This is the main motivation for introducing this format.
  • The new format is generated with constant memory consumption so that very large documents can be produced without exhausting heap space.

This function is applicable when "XLSX" output has been selected by a call to the function fgl_report_selectDevice. All arguments to this function are optional; pass a value of NULL if you don't want to set a value. If the XLSX document should be written to a file, the general functions fgl_report_setOutputFileName and fgl_report_selectPreview are available for this purpose.

For an example of Genero code using a reporting function, see Using report output functions. This example may not use the specific function discussed in this topic, however it provides details on where you would place this (and other) report output functions.