SrsPrintMgmtFormLetterController Class [AX 2012]

Article
2014-04-11

The SrsPrintMgmtFormLetterController class is the base controller class that should be extended by reports that must use the form letter style of print management.

Syntax

class SrsPrintMgmtFormLetterController extends SrsPrintMgmtController

Run On

Called

Methods

	Method	Description
	addSysOperationDataContractInfo	(Inherited from SrsReportRunController.)
	batchAsyncCallback	Microsoft internal use only. (Inherited from SysOperationController.)
	batchInfo	Microsoft internal use only. (Inherited from SysOperationController.)
	callContractInterfaceMethod	Microsoft internal use only. (Inherited from SysOperationController.)
	cancelRun	Causes the current run of reports to cancel before the next report. (Inherited from SrsPrintMgmtController.)
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	canGoBatch	Microsoft internal use only. (Inherited from SrsReportRunController.)
	caption	Microsoft internal use only. (Inherited from SysOperationController.)
	checkAccess	Microsoft internal use only. (Inherited from SrsReportRunController.)
	checkCloseDialog	Microsoft internal use only. (Inherited from SysOperationController.)
	checkIfAnyContractImplementsInterface	Microsoft internal use only. (Inherited from SysOperationController.)
	defaultCaption	Microsoft internal use only. (Inherited from SrsReportRunController.)
	dialog	Microsoft internal use only. (Inherited from SysOperationController.)
	dialogClose	Closes the dialog if the report viewer form is not being shown for print management. (Inherited from SrsPrintMgmtController.)
	dialogInit	Microsoft internal use only. (Inherited from SysOperationController.)
	dialogMake	Microsoft internal use only. (Inherited from SysOperationController.)
	dialogPostBuild	Microsoft internal use only. (Inherited from SysOperationController.)
	dialogPostRun	Microsoft internal use only. (Inherited from SysOperationController.)
	dialogRun	Microsoft internal use only. (Inherited from SysOperationController.)
	dialogSelectCtrl	Microsoft internal use only. (Inherited from SysOperationController.)
	dialogShow	Displays the dialog box. (Inherited from SrsPrintMgmtController.)
	dialogTask	Microsoft internal use only. (Inherited from SysOperationController.)
	doBatch	Microsoft internal use only. (Inherited from SysOperationController.)
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	getBaseDataContract	(Inherited from SysOperationController.)
	getCachedUIBuilderForDataContractInfo	Microsoft internal use only. (Inherited from SysOperationController.)
	getDataContractInfoObject	Gets the metadata that is associated with a particular data contract parameter. (Inherited from SysOperationController.)
	getDataContractInfoObjects	Microsoft internal use only. (Inherited from SysOperationController.)
	getDataContractInfoObjectsInternal	Microsoft internal use only. (Inherited from SrsReportRunController.)
	getDataContractInfoObjectsRecursively	Microsoft internal use only. (Inherited from SysOperationController.)
	getDataContractObject	Gets a data contract instance for reading or writing. (Inherited from SysOperationController.)
	getFirstQuery	Gets the first query in the report. (Inherited from SrsReportRunController.)
	getFirstQueryContractKey	Gets the first query contract parameter name. (Inherited from SrsReportRunController.)
	getFrameworkService	Microsoft internal use only. (Inherited from SysOperationController.)
	getFromDialog	Microsoft internal use only. (Inherited from SrsReportRunController.)
	getOriginalQuery	Gets the original query that can be used in the SysQuery form. (Inherited from SysOperationController.)
	getReportContract	Gets the report contract used for this report. (Inherited from SrsReportRunController.)
	getReportRunAdapter	Gets the instance of SrsReportRunAdapter that is used to run the report to screen. (Inherited from SrsReportRunController.)
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	getUIBuilderForContractObject	Microsoft internal use only. (Inherited from SysOperationController.)
	getUIBuilderForDataContractInfo	Microsoft internal use only. (Inherited from SysOperationController.)
	getUIBuilderForParameterPath	Microsoft internal use only. (Inherited from SysOperationController.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	init	Initializes the form letter controller. (Overrides the init Method.)
	initFormLetterReport	Initializes an instance of a form letter object.
	initializeDataContractInfoMaps	Microsoft internal use only. (Inherited from SysOperationController.)
	initializeParameters	Initializes the data contracts by calling the framework service. (Inherited from SrsReportRunController.)
	initParmDefault	Microsoft internal use only. (Inherited from SysOperationController.)
	initPrintMgmtReportRun	Initializes instance of print management report run object. (Inherited from SrsPrintMgmtController.)
	initQueryFromContract	Initializes the query object. (Inherited from SrsPrintMgmtController.)
	isInBatch	Microsoft internal use only. (Inherited from SysOperationController.)
	lastValueDataAreaId	Microsoft internal use only. (Inherited from SysOperationController.)
	lastValueDesignName	Microsoft internal use only. (Inherited from SrsReportRunController.)
	lastValueUserId	Microsoft internal use only. (Inherited from SysOperationController.)
	loadFromSysLastValue	Microsoft internal use only. (Inherited from SrsReportRunController.)
	loadingOrSavingFromLastValue	Checks whether the current execution loads from or saves to the syslastvalue table. (Inherited from SysOperationController.)
	new	Initializes a new instance of the SrsPrintMgmtController class. (Inherited from SrsPrintMgmtController.)
	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.)
	onRenderingComplete	Implements the necessary logic when report rendering is completed. (Inherited from SrsReportRunController.)
	outputReport	Executes the report for the print management setting that is currently loaded. (Overrides the outputReport Method.)
	outputReports	Loads and iterates through print settings for the specified record. (Inherited from SrsPrintMgmtController.)
	owner	Returns the instance that owns the object. (Inherited from Object.)
	pack	Serializes the current instance of the SrsReportRunController class. (Inherited from SrsReportRunController.)
	packDataContractInfoObjects	Microsoft internal use only. (Inherited from SysOperationController.)
	parmAlwaysInitializeAndValidateOnServer	Microsoft internal use only. (Inherited from SysOperationController.)
	parmArgs	Microsoft internal use only. (Inherited from SysOperationController.)
	parmCurrentBatch	Microsoft internal use only. (Inherited from SysOperationController.)
	parmDialogCaption	Gets or sets the DialogCaption parameter. (Inherited from SrsReportRunController.)
	parmExecutionMode	Microsoft internal use only. (Inherited from SysOperationController.)
	parmFrameworkService	Microsoft internal use only. (Inherited from SysOperationController.)
	parmHelpKeyword	Gets or sets the HelpKeyword parameter. (Inherited from SrsReportRunController.)
	parmLoadFromSysLastValue	Microsoft internal use only. (Inherited from SysOperationController.)
	parmPreRunState	Gets or sets the PreRunState parameter. (Inherited from SrsReportRunController.)
	parmPrintDestinationTokens	Gets or sets the PrintDestinationTokens parameter. (Inherited from SrsReportRunController.)
	parmRegisterCallbackForReliableAsyncCall	Microsoft internal use only. (Inherited from SysOperationController.)
	parmReliableAsyncBatchGroupId	Gets or sets the ReliableAsyncBatchGroupId parameter. (Inherited from SysOperationController.)
	parmReportContract	Gets or sets the ReportContract parameter. (Inherited from SrsReportRunController.)
	parmReportName	Gets or sets the ReportName parameter. (Inherited from SrsReportRunController.)
	parmReportRun	Gets or sets the ReportRun parameter. (Inherited from SrsReportRunController.)
	parmShowDialog	Microsoft internal use only. (Inherited from SrsReportRunController.)
	parmShowReportViewerParameters	Gets or sets the ShowReportViewerParameters parameter. (Inherited from SrsPrintMgmtController.)
	postReportRun	Performs post rendering cleanup and raises a completed rendering event. (Inherited from SrsPrintMgmtController.)
	postReportRunPackedExecutionInfo	Calls postReportRun method based on the packed execution information. (Inherited from SrsReportRunController.)
	prePromptModifyContract	Modifies the contract before the dialog is shown to the user. (Inherited from SrsReportRunController.)
	preRunModifyContract	Modifies the contract before the report is run. (Inherited from SrsReportRunController.)
	preRunValidate	Validates prior to running the report. (Inherited from SrsReportRunController.)
	processPreRunValidate	Validates that a report should be run. (Inherited from SrsReportRunController.)
	prompt	Microsoft internal use only. (Inherited from SysOperationController.)
	putToDialog	Moves data from the data contract into dialog box controls. (Inherited from SysOperationController.)
	queryChanged	Microsoft internal use only. (Inherited from SysOperationController.)
	queryHelper	Microsoft internal use only. (Inherited from SysOperationController.)
	querySelectButtonClicked	Microsoft internal use only. (Inherited from SysOperationController.)
	renderingCompleted	Occurs when report rendering is completed. (Inherited from SrsReportRunController.)
	reportViewerPreRefresh	Executes before the report viewer is about to refresh its data and rendering the report. (Inherited from SrsReportRunController.)
	reportViewerRefreshComplete	Executes when the report viewer has completed refreshing its data and rendering the report. (Inherited from SrsReportRunController.)
	reportViewerRun	Runs the report when called from the SrsReportRunViewer form. (Inherited from SrsPrintMgmtController.)
	run	Runs the report by calling a print management specific method. (Inherited from SrsPrintMgmtController.)
	runOutputReports	Iterates through each record in print management for the document and prints the report. (Overrides the runOutputReports Method.)
	runPrintMgmt	Implements print management functionality. (Inherited from SrsPrintMgmtController.)
	runReport	Runs a report to printer destination set by print management. (Inherited from SrsPrintMgmtController.)
	runsImpersonated	Microsoft internal use only. (Inherited from SysOperationController.)
	runToScreen	Runs the report to screen. (Inherited from SrsReportRunController.)
	runToScreenPrintArchive	Prints a report archive after rendering to screen is completed. (Inherited from SrsReportRunController.)
	saveLast	Microsoft internal use only. (Inherited from SysOperationController.)
	setRdlParameter	Wraps the setting of RDL contract parameter. (Inherited from SrsPrintMgmtController.)
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	showBatchTab	Microsoft internal use only. (Inherited from SysOperationController.)
	showPrintSettings	Indicates whether print settings should be added to the dialog. (Inherited from SrsReportRunController.)
	showQuerySelectButton	Determines whether a Select button will be added to the dialog box. (Inherited from SysOperationController.)
	showQueryValues	Determines whether the query values will be added to the dialog box. (Inherited from SysOperationController.)
	startOperation	Starts a controller operation. (Overrides the startOperation Method.)
	templateForm	Microsoft internal use only. (Inherited from SrsReportRunController.)
	toString	Returns a string that represents the current object. (Inherited from Object.)
	unpack	Deserializes the packedState parameter value to an instance of the SrsReportRunController class. (Inherited from SrsReportRunController.)
	unpackDataContractInfoObjects	Microsoft internal use only. (Inherited from SysOperationController.)
	updateExecutionInfoFromReportAdapter	Executes from the SrsReportRunController.reportViewerRefreshComplete method when the report viewer has completed refreshing its data and rendering the report. (Inherited from SrsReportRunController.)
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	validate	Validates the data contract values. (Inherited from SrsReportRunController.)
	validateParameters	Microsoft internal use only. (Inherited from SysOperationController.)
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)

Top

Remarks

Print management can be implemented by directly using the PrintMgmtReportRun class or using the FormLetter approach. Use this base class for the FormLetter scenario.

This is a framework class. Customizing this class may cause problems with future upgrades to the software.

Inheritance Hierarchy

Share via