Text report functions

When you have created a variable that is based on the TextReport external type (the report engine) you can call any of the following functions from that variable for either COBOL generation or Java™ generation:

Table 1. Functions from the TextReport variable for COBOL generation or Java generation
Function Description
column(colNo ) Processes the next element in the specified column of the report.
finishReport() Passes control to the report engine to finalize the report.
result = getLineNumber() Returns the current line number for the current page of the report.
result = getPageNumber() Returns the current report page number.
result = isNativeOutput() Returns a BOOLEAN value that indicates whether the report is currently set to be output in UNICODE or in a native character set.
needLines (numLines) Ensures that you have enough space to print a specified number of consecutive lines.
outputToReport() Initiates the output of a prepared row of report data.
println() Starts a new line of the report.
printText(textString, [fieldLength]) Adds a text string to the report output.
printTextFixedWidth()(textString, fieldLength) Adds a text string to the report output, padding or truncating to match the specified length.
setFirstHeaderLines(numLines) Specifies the number of lines that the report engine accepts for the first page header.
setHeaderLines(numLines) Specifies the number of lines that the report engine accepts for the header on any page except the first.
setNativeOutput(nativeOutput) Specifies whether the report should be output in UNICODE or in a native character set.
setTrailerLines(numLines) Specifies the number of lines that the report engine accepts for the footer.
skipLines(numLines) Inserts a specified number of blank lines into the report.
skipToTop() Advances to the top of the next page of the report.
spaces(numSpaces ) Advances the column setting by the specified number of spaces.
startReport(fileName, topMargin, bottomMargin, leftMargin, rightMargin, pageLength, [topOfForm]) Passes control from the text report handler to the Java report engine and sets default page values.
terminateReport() Passes control to the report engine to stop the report generation process.
wordWrapPrint(tempRightMargin) Processes the next print statement with a temporary right margin and temporary word wrap.

You can call any of the following functions for Java generation only:

Table 2. Functions from the TextReport variable for Java generation only
Function Description
clearErrorMessages() Clears error messages from the message stack.
errorMsg = popErrorMessage() Returns the most recent saved error message.
printFile(fileName) Adds the contents of a text file to the report.
pushErrorMessage(errorMsg) Places the specified error message on a stack.
setReportDriver(reportDriver) Assigns a report driver to your report engine variable.

Feedback