Runtime Class Methods

Class methods are static methods that do not require an object. The method name is prefixed by the class name.

Table 1. Class Methods (Static Member Methods)
Name Description
getOutputDeviceName()

Returns a STRING indicating the output device name selected in the API call fgl_report_selectDevice; can be one of "PDF", "XLS", "XLSX", "HTML", "Image", "Printer" or "SVG.

For more information on fgl_report_selectDevice, refer to the Genero Report Writer User Guide.

producingPDFOutput()
BOOLEAN; returns TRUE if the device name selected in the API call fgl_report_selectDevice was "PDF"; otherwise FALSE.
producingXLSOutput()
BOOLEAN; returns TRUE if the device name selected in the API call fgl_report_selectDevice was "XLS"; otherwise FALSE.
producingXLSXOutput()
BOOLEAN; returns TRUE if the device name selected in the API call fgl_report_selectDevice was "XLSX"; otherwise FALSE.
producingExcelOutput()
BOOLEAN; returns TRUE if the device name selected in the API call fgl_report_selectDevice was "XLS" or "XLSX"; otherwise FALSE.
producingSVGOutput()
BOOLEAN; returns TRUE if the device name selected in the API call fgl_report_selectDevice was "SVG"; otherwise FALSE.
producingHTMLOutput()
BOOLEAN; returns TRUE if the device name selected in the API call fgl_report_selectDevice was "HTML"; otherwise FALSE.
producingImageOutput()
BOOLEAN; returns TRUE if the device name selected in the API call fgl_report_selectDevice was "Image"; otherwise FALSE.
producingPrinterOutput()
BOOLEAN; returns TRUE if the device name selected in the API call fgl_report_selectDevice was "Printer"; otherwise FALSE.
producingForPreview()
BOOLEAN; returns TRUE if preview was selected in the API call fgl_report_selectPreview; otherwise FALSE.
getSVGPrinterName()
Returns a STRING indicating the printer name specified in the API call fgl_report_setSVGPrinterName.
getSVGPaperSource()

Returns a STRING indicating the paper source specified in the API call fgl_report_setSVGPaperSource; can be:

"Auto", "Cassette", "Envelope", "EnvelopeManual", "FormSource", "LargeCapacity", "LargeFormat", "Lower", "Middle", "Manual", "OnlyOne", "Tractor" or "SmallFormat"

xlsPagesAreMerged()
BOOLEAN, returns TRUE if page merging was selected in the API call fgl_report_configureXLSDevice; otherwise FALSE.
getPrinterName()
Returns a STRING indicating the printer name specified in the API call fgl_report_setPrinterName.
getPrinterMediaSizeName()
Returns a STRING indicating the media size name specified in the API call fgl_report_setPrinterMediaSizeName.
getPrinterMediaTray()
Returns a STRING indicating the media tray name specified in the API call fgl_report_setPrinterMediaTray.
getPrinterMediaName()
Returns a STRING indicating the media name specified in the API call fgl_report_setPrinterMediaName.
getDebugLevel()
Numeric, returns the current debug level specified in the environment variable GREDEBUG, or 0 if no debug level was set.
getEnvironmentVariable(String variableName)
Returns a String containing the value of the specified environment variable