fgl_report_setSVGSheetCollate

Control the collation of multiple copies.

Syntax

fgl_report_setSVGSheetCollate (
   sheetCollate STRING )
  1. sheetCollate - one of collated|uncollated.
    If sheetCollate is:
    • collated, each copy of the document is printed with the pages in sequence.
    • uncollated, each page is printed a number of times equal to the value of the fgl_report_setSVGCopies attribute in succession. This is the default.

Usage

Function to control the collation of multiple copies.

Specifies whether the pages of the document are to be in sequence, when multiple copies of the document are specified by the fgl_report_setSVGCopies function.

For example, if a document produces two pages as output, fgl_report_setSVGCopies is 6, and sheetCollate is "uncollated", then six copies of the first page are printed followed by six copies of the second page.

Note: We discourage setting sheetCollate to "collated" since it requires caching the entire document, which is undesirable for large documents. If necessary, produce the document the required number of times.

This function applies only if the option PrintOnNamedPrinter is chosen in a call to fgl_report_configureSVGPreview.

This function fails if the argument is not one of the specified values.

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.