ReportRun Class

The ReportRun class generates and prints a report or previews a report on the screen.

Syntax

class ReportRun extends ObjectRun

Run On

Called

Methods

	Method	Description
	addPendingSums	Prints the relevant footers of the report.
	addRangeDescription
	allPages
	args	Returns the arguments that the object was constructed with. (Inherited from ObjectRun.)
	arrangeLevelControl
	arrangeLevelGlobal
	arrangeLevelNone
	arrangeLevelSection
	attach	(Overrides the attach Method.)
	callMenuFunction
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	caption	Creates a caption when previewing a report, or a document name when printing a report.
	clearAllRangeDescriptions
	collate
	columnHeadings	Provides control of column headings in a report.
	control	Retrieves the control that is being executed.
	copies
	copiesTotal	Enables marking copies of reports.
	copy	Returns the number of the copy of a report.
	copyDescription
	createProgressForm	Creates the form that contains progress information.
	currentYmm100
	design	Gets or sets the name of the design.
	detach	(Overrides the detach Method.)
	deviceName
	dialog
	disableBody
	disableColumnHeadings
	disablePageFooter
	disableSection
	driverName	Returns the printer driver name.
	enableAllBodies
	enableBody
	enablePageFooter
	enableSection
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	execute	Prints the programmable sections of a report.
	executeBodyColumnHeadings	Prints the column headings of a body section in a report.
	executeColumnHeadings
	executeControlColumnHeadings	Executes the column headings of a programmable section.
	executeFooter	Execute a footer section.
	executeHeader	Executes a header section.
	executeSection	Prints the specified section in the report.
	fetch	Executes the report query and calls the send method for the record that is found by the query.
	finalize
	footer	Controls the footer.
	from
	generateDesign
	getDeclineOverwrite
	getNumberOfPrinters
	getPrinter
	getRangeDescription
	getReportViewer
	getTarget
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	gotoYmm100
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	hasGeneratedDesign
	header	Controls the header.
	headerDescription
	heightOfPageFooters
	indent
	init
	isBodyEnabled
	isDetached	Communicates whether an ObjectRun.detach method call has been made on this object. (Inherited from ObjectRun.)
	jobId
	last
	mm100Left
	mm100PageHeight
	name	Gets or sets the name that is used in code to identify a form, report, table, query, or another MSDAX application object.
	new	Initializes an instance of the ReportRun class. (Overrides the new Method.)
	newPage
	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.)
	pack	Serializes the current instance of the ReportRun class.
	packDesign
	packPageSettings
	packPrinterSettings
	packPrintJobSettings
	packSubtotalSettings
	page
	pageFormatting	Displays the printer properties of the printer.
	pagesTotal
	passThrough
	pixelsLeft
	print	Sends the generated report to a print medium, such as a printer or the screen.
	printerAttributes
	printerAveragePPM
	printerComment
	printerDatatype
	printerDefaultPriority
	printerDriverName
	printerFontInfo	Indicates which font is used to print the report.
	printerLocation
	printerPageHeight
	printerPageWidth
	printerPaper
	printerParameters
	printerPortName
	printerPrinterName
	printerPrintProcessor
	printerPriority
	printerQueuedJobs
	printerSepFile
	printerServerName
	printerSettings	Enables the user to select printer settings.
	printerShareName
	printerStartTime
	printerStatus
	printerUntilTime
	printJobSettings
	printSum
	progressForm
	progressInfo	Creates a string that describes how much of the report has been generated during the execution of a report every time that a section is executed.
	prompt	Prompts the user a report is run.
	query
	queryRun
	report
	reportUser
	reset	Enables a single instance of the ReportRun class to create multiple reports.
	rulerCM
	rulerINCH
	run	Runs the report.
	screenFontInfo
	section
	sectionsLeft
	send	Triggers the body sections that belong to a section group.
	setEscapeSequence
	setTarget
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	showMenuFunction
	showMenuReference
	sortInfo
	startDate
	startDateTime
	startMachineDate
	startTime
	sum
	sumControl
	sumControlNeg
	sumControlPos
	sumDescription
	sumNeg
	sumPos
	suppressReportIsEmptyMessage
	title	Gets or sets the print job description.
	to
	toString	Returns a textual description of the class. (Overrides the toString Method.)
	unpackDesign
	unpackPageSettings
	unpackPrinterSettings
	unpackPrintJobSettings
	unpackSubtotalSettings
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	userSelectedOrientation
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)

Top

Remarks

As opposed to the , which defines the structure of a report, a ReportRun object contains the runtime characteristics of the report.A ReportRun object can be created by using one of the following arguments:

• An Args object where the name and optionally designName parameters are specified.

• A created container, by using the for example.

• The report name and an optional design name.

The section template node type allows the sections to be defined once and reuse them many times in different reports. A typical example of this would be a check or a giro.

Examples

The following example runs the Customer design of the existing Cust report:

static void testReportRun(args a) 
{  
    reportRun rr; 
    args aa = new args("Cust"); 
  
    aa.designName("Customer"); 
    rr = new reportRun(aa); 
    rr.run(); 
}

Inheritance Hierarchy

Object Class
  ObjectRun Class
    ReportRun Class
      SysReportRun Class

See Also

ReportRun.report Method

ReportRun.run Method

ReportRun.new Method