fgl_report_configureXLSDevice

Configure the XLS (Excel) output.

Syntax

fgl_report_configureXLSDevice(
   fromPage INTEGER,
   toPage INTEGER,
   removeWhitespace INTEGER,
   ignoreRowAlignment INTEGER,
   ignoreColumnAlignment INTEGER,
   removeBackgroundImages INTEGER,
   mergePages INTEGER )
  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. By default whitespace is stripped from the document.
  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. By default 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. By default 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. By default, background images are removed.
  7. mergePages - Controls the behavior when the report has more than one page. By default a separate sheet is created per page. Setting this parameter causes the pages to be merged, creating a single result sheet unless the sheet has more that 65536 rows; in that case, the exceeding rows spill over into extra sheets. Setting this parameter and using a standard page size is the recommended way to produce single-sheet output; using a huge custom page size instead can adversely affect memory reclamation and performance. See also Output a single-sheet document to Excel.

Usage

Function to configure the XLS (Excel) output.

This function is applicable when XLS output has been selected by a call to the function fgl_report_selectDevice. All arguments to this function are optional, indicated by passing a null value. If the XLS document should be written to a file, the general functions fgl_report_setOutputFileName and fgl_report_selectPreview are available for this purpose.

See also Sending Data to an Excel spreadsheet.

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.