ReportOutputUser Class

The ReportOutputUser class implements a user-defined target for report formatting.

Syntax

class ReportOutputUser extends ReportOutput

Run On

Called

Methods

	Method	Description
	abort	(Inherited from ReportOutput.)
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	description	(Inherited from ReportOutput.)
	dialogAndPrint	(Inherited from ReportOutput.)
	endBodySection
	endColumnHeadingsSection
	endColumnSection
	endEpilogSection
	endFooterSection
	endHeaderSection
	endPage
	endPageFooterSection
	endPageHeaderSection
	endProgrammableSection
	endPrologSection
	endReport
	endSection
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	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.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	jobStatus	(Inherited from ReportOutput.)
	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.)
	pageCreated
	pagesTotal
	print	(Inherited from ReportOutput.)
	printAscii	(Inherited from ReportOutput.)
	printHTML	(Inherited from ReportOutput.)
	printJobSettings	(Inherited from ReportOutput.)
	printPageViaClass
	printPDF	(Inherited from ReportOutput.)
	printRTF	(Inherited from ReportOutput.)
	printTextUTF8	Prints a report to a UTF-8 format. (Inherited from ReportOutput.)
	printToTarget	(Inherited from ReportOutput.)
	printViaClass
	result
	setNumberOfPages	(Inherited from ReportOutput.)
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	startBodySection
	startColumnHeadingsSection
	startColumnSection
	startEpilogSection
	startFooterSection
	startHeaderSection
	startPage
	startPageFooterSection
	startPageHeaderSection
	startProgrammableSection
	startPrologSection
	startReport
	startSection
	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.)
	writeAutoLabel
	writeBitmap
	writeDate
	writeDateTime
	writeEnum
	writeField
	writeInt64
	writeInteger
	writeLabel
	writeReal
	writeShape
	writeStaticText
	writeString
	writeSum
	writeTime
	xml	Returns an XML string that represents the current object. (Inherited from Object.)

Top

Remarks

By default, Microsoft Dynamics AX prints reports to a screen, printer, file, or email address.

The following API items support a user-defined target:

• ReportOutputUserType system enumeration

• ViewerClass value for the PrintMedium system enumeration

• ClassFactory::createViewer method

When a report is run, the print method creates a reportOutputUser object if the target is PrintMedium::Viewer class. This object will be created by calling the createViewer method and giving reportOutputUserType as one of the arguments. The report will then be printed by calling methods on the object: startReport, startPage, startSection, writeField, and so on.

In general, if the target is, for example, a printer, the reportRun::print method will create a reportOutput object and call its print method to print the report to a printer. If the target is viewerClass, it will instead call the createViewer method to get a ReportOutputUser object. Then it will call methods on the object: startReport, startPage, startSection, startField, outputStringField, and so on.

When the report is run, the Text property of the text controls of the report will be written to the print window.

Inheritance Hierarchy

Object Class
  ReportOutput Class
    ReportOutputUser Class
      PDFViewer Class
      SysDummyPrintViewer Class
      WebReportBase Class

See Also

ClassFactory.createViewer Method