ReportViewer Class

Article
2014-04-11

The ReportViewer class lets the user preview a report.

Syntax

class ReportViewer extends ReportOutput

Run On

Client

Methods

	Method	Description
	abort	(Inherited from ReportOutput.)
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	close
	description	(Inherited from ReportOutput.)
	dialogAndPrint	(Inherited from ReportOutput.)
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	firstPage
	getCopyNo	(Inherited from ReportOutput.)
	getDeclineOverwrite	(Inherited from ReportOutput.)
	getLastCopyNo	(Inherited from ReportOutput.)
	getLastPageNo	(Inherited from ReportOutput.)
	getPageNo	(Inherited from ReportOutput.)
	getTempFileName	(Inherited from ReportOutput.)
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	gotoPage
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	jobStatus	(Inherited from ReportOutput.)
	lastPage
	new	Initializes a new instance of the Object class. (Overrides the new Method.)
	nextPage
	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.)
	pause
	prevPage
	print	(Inherited from ReportOutput.)
	printAscii	(Inherited from ReportOutput.)
	printHTML	(Inherited from ReportOutput.)
	printJobSettings	(Inherited from ReportOutput.)
	printPDF	(Inherited from ReportOutput.)
	printRTF	(Inherited from ReportOutput.)
	printTextUTF8	Prints a report to a UTF-8 format. (Inherited from ReportOutput.)
	printToTarget	(Inherited from ReportOutput.)
	setAborted
	setCompleted
	setNumberOfPages	(Overrides the setNumberOfPages Method.)
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	showPage
	toString	Returns a string that represents the current object. (Inherited from Object.)
	type	(Inherited from ReportOutput.)
	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

ReportViewer objects can exist only on the client, because a report preview can occur only on a client.

Examples

The following code will print the job descriptions and the page numbers of jobs that are inserted in the printArchive on the current date, and it will show page 1 in the report viewer.

static void aaaReportOutputExample(args a) 
{ 
    PrintJobHeader printJobHeader; 
    PrintJobPages printJobPages; 
    int myrecId; 
    reportViewer reportViewer; 
     
    while select printJobHeader where printJobHeader.CreatedDate >= 
            str2datetime("01/01/2011 12:00:00 am",123)
    { 
        myrecId = printJobHeader.recId; 
        print printJobHeader.jobDescription; 
         
        while select printJobPages  
            where printJobPages.pagesHeaderRecId == myRecId 
                print printJobPages.PageNo; 
        reportViewer = new reportViewer(printJobHeader); 
        reportViewer.showPage(1); 
    } 
}

Inheritance Hierarchy

Object Class
ReportOutput Class
ReportViewer Class

Share via