The Runtime Class

The Runtime class provides methods that simplify the creation of dynamic designs that change behavior based on the runtime setup.

Syntax

Runtime

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
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.
getOutputDeviceName()	Returns a STRING indicating the output device name selected in the API call fgl_report_selectDevice. Can be one of the following: PDF XLS XLSX HTML Image Printer Postscript SVG Browser RTF OORTF
getPrinterMediaName()	Returns a STRING indicating the media name specified in the API call fgl_report_setPrinterMediaName.
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.
getPrinterName()	Returns a STRING indicating the printer name specified in the API call fgl_report_setPrinterName.
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"
getSVGPrinterName()	Returns a STRING indicating the printer name specified in the API call fgl_report_setSVGPrinterName.
producingBrowserOutput()	BOOLEAN; returns TRUE if the device name selected in the API call fgl_report_selectDevice was "Browser"; otherwise FALSE.
producingExcelOutput()	BOOLEAN; returns TRUE if the device name selected in the API call fgl_report_selectDevice was "XLS" or "XLSX"; 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.
producingOORTFOutput()	BOOLEAN; returns TRUE if the device name selected in the API call fgl_report_selectDevice was "OORTF"; otherwise FALSE.
producingPDFOutput()	BOOLEAN; returns TRUE if the device name selected in the API call fgl_report_selectDevice was "PDF"; otherwise FALSE.
producingPostscriptOutput()	BOOLEAN; returns TRUE if the device name selected in the API call fgl_report_selectDevice was "Postscript"; otherwise FALSE.
producingRTFOutput()	BOOLEAN; returns TRUE if the device name selected in the API call fgl_report_selectDevice was "RTF"; otherwise FALSE.
producingSVGOutput()	BOOLEAN; returns TRUE if the device name selected in the API call fgl_report_selectDevice was "SVG"; 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.
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.
xlsPagesAreMerged()	BOOLEAN, returns TRUE if page merging was selected in the API call fgl_report_configureXLSDevice; otherwise FALSE.

Usage

The class provides a number of methods that simplify the job of creating dynamic designs that change behavior based on the runtime setup.

With RTL classes, it is not possible to create and subclass objects. The new keyword is not supported.

The methods can be used from within RTL expressions. Some common uses might be:

To suppress headers and footers when Excel output is selected.
To conditionally Insert a logo based on the printer tray is selected.
To set a background color when debugging is enabled

These static methods do not require a Runtime object instance. When you invoke the method, it is prefixed with the Runtime class name and the '.' For example, you can suppress a header by setting its " visibilityCondition" property to this expression:

"!Runtime.producingExcelOutput()"