ReportOutput Class
The ReportOutput class handles the output of a report to a printer or file.
Syntax
class ReportOutput extends Object
Run On
Called
Methods
| Method | Description | |
|---|---|---|
.gif "Public method") |
abort | |
|
cancelTimeOut | Cancels a previous method call to the setTimeOut method. (Inherited from Object.) |
|
description | |
|
dialogAndPrint | |
|
equal | Determines whether the specified object is equal to the current one. (Inherited from Object.) |
|
getCopyNo | |
|
getDeclineOverwrite | |
|
getLastCopyNo | |
|
getLastPageNo | |
|
getPageNo | |
|
getTempFileName | |
|
getTimeOutTimerHandle | Returns the timer handle for the object. (Inherited from Object.) |
|
handle | Retrieves the handle of the class of the object. (Inherited from Object.) |
|
jobStatus | |
|
new | Initializes a new instance of the Object class. (Overrides the new Method.) |
|
notify | Releases the hold on an object that has called the wait method on this object. (Inherited from Object.) |
|
notifyAll | Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.) |
|
objectOnServer | Determines whether the object is on a server. (Inherited from Object.) |
|
owner | Returns the instance that owns the object. (Inherited from Object.) |
|
||
|
printAscii | |
|
printHTML | |
|
printJobSettings | |
|
printPDF | |
|
printRTF | |
|
printTextUTF8 | Prints a report to a UTF-8 format. |
|
printToTarget | |
|
setNumberOfPages | |
|
setTimeOut | Sets up the scheduled execution of a specified method. (Inherited from Object.) |
|
toString | Returns a string that represents the current object. (Inherited from Object.) |
|
type | |
|
usageCount | Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.) |
|
wait | Pauses a process. (Inherited from Object.) |
|
xml | Returns an XML string that represents the current object. (Inherited from Object.) |
Top
Remarks
This class serves as the base class for the ReportViewer class, which handles preview of reports, and for the ReportOutputUser class, which handles output of reports to a user-defined target in a user-defined format.
In general, if a report is printed to the printer, the print method creates a ReportOutput object and calls its print method. If the call printJobSettings::outputToClient(TRUE) has been made, a ReportViewer object is created instead.
The call to the print method prints the report on a printer that is set up on the client, because a ReportViewer object can only exist on the client, not on the server.
Examples
The following example prints the job descriptions and page numbers of jobs that have been inserted into the printArchive table on the current date, and prints page 1 on the default printer.
static void aaaReportOutputExample(args a)
{
printJobHeader printJobHeader;
printJobPages printJobPages;
int myrecId;
reportViewer reportViewer;
while select printJobHeader where printJobHeader.createdDateTime >=
str2datetime("01/01/2011 12:00:00", 123)
{
myrecId = printJobHeader.recId;
print printJobHeader.jobDescription;
while select printJobPages
where printJobPages.pagesHeaderRecId == myRecId
print printJobPages.PageNo;
reportViewer = new reportOutput(printJobHeader);
reportViewer.print();
}
}
Inheritance Hierarchy
Object Class
ReportOutput Class
ReportOutputUser Class
ReportPrinter Class
ReportViewer Class