fgl_report_configureHTMLDevice

Configure the HTML output.

Syntax

fgl_report_configureHTMLDevice(
   fromPage INTEGER,
   toPage INTEGER,
   embedImages INTEGER,  
   imageGenerationDirectory STRING,
   imageURLPrefix STRING,
   removeWhitespace BOOLEAN,  
   ignoreRowAlignment BOOLEAN,
   ignoreColumnAlignment BOOLEAN,
   removeBackgroundImages BOOLEAN )
  1. fromPage - Selects the lower bound of the range of pages to include in the HTML document. The default value is 1.
  2. toPage - Selects the upper bound of the range of pages to include in the HTML document. By default all pages are included.
  3. embedImages - Specifies whether to embed images in the resulting HTML output. By default this is not the case.
  4. imageGenerationDirectory - If images are not embedded, this property specifies the directory into which generated images are written. The directory needs to exist, it is not created. Note that the urls that are created will not take this value into account. By default, the urls that are created contain the image name only, so that the images are expected to reside in the same directory as the document. If needed, the url prefix for the generated urls can be changed with the property imageURLPrefix.
  5. imageURLPrefix - If images are not embedded, this property specifies the prefix of the urls of the generated images. As an example consider that an image of the name "12345.png" is created, and that this property is set to the value "./images/"; then the "src" attribute of the generated "img" element would be set to "./images/12345.png".
  6. removeWhitespace - Controls whether 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.
  7. 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 FALSE (row alignment is not ignored).
  8. 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 FALSE (column alignment is not ignored).
  9. removeBackgroundImages - Controls the behavior when an IMAGE BOX is partially obscured by another element. When set, the image is removed from the resulting document; otherwise, the handling is as in any other case of overlapping items. The default is TRUE (background images are removed).

Usage

Function to configure the HTML output.

This function is applicable when HTML 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 HTML 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.