RPayReport_EmplMonthIncome Class [AX 2012]

The payroll employee month income report.

Syntax

class RPayReport_EmplMonthIncome extends XMLExcelReport_Standard_RU

Run On

Client

Methods

	Method	Description
	addSection	Adds a section to a report by indicating that a specified range should be treated as a section. (Inherited from XMLExcelReport_RU.)
	addTotals	Method should be used to add values to totals which will be printed at report footer (Overrides the addTotals Method.)
	addTotalsOnPage	Method should be used to add values to totals which will be printed at page footer (Overrides the addTotalsOnPage Method.)
	allowSaveLast	(Inherited from RunBaseBatch.)
	batchInfo	Returns the BatchInfo class. This class is the API for the batch table. (Inherited from RunBaseBatch.)
	calcRangeHeight	Calculates height of section which contains cells which wrap text (Overrides the calcRangeHeight Method.)
	calcSectionHeight	Calculates the height of a section of fixed height. (Inherited from XMLExcelReport_RU.)
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	canGoBatch	Returns false (Inherited from RunBaseBatch.)
	canGoBatchJournal	Determines whether the class is shown in the list of Journal types. (Inherited from RunBaseBatch.)
	canSwapBetweenCS	Controls whether a calledFrom class that is instantiated on the server should have its prompt executed on the client. (Inherited from RunBase.)
	caption	Retrieves the description from the current class by calling the static description method of the class if there is one. (Inherited from RunBaseBatch.)
	checkAndPrepareParameters
	checkCloseDialog	Must be called in the CloseOk method of a RunBase dialog box. (Inherited from RunBase.)
	cleanupDialog	Provides a way to clean up after a dialog box has been canceled. (Inherited from RunBase.)
	clearTotals	Method should be used to reset totals which will be printed at the footer of report (Overrides the clearTotals Method.)
	clearTotalsOnPage	Clears page totals (Overrides the clearTotalsOnPage Method.)
	createReport	Use this method as main method for creation of report (Overrides the createReport Method.)
	createStandardReport	Executes a general algorithm for printing a standard report. (Inherited from XMLExcelReport_Standard_RU.)
	dialog	Returns a class that contains the methods that are described by the RunBaseDialogable interface. (Overrides the dialog Method.)
	dialogClear	Clears the contents of the dialog box. (Inherited from RunBase.)
	dialogInit	Initializes the dialog box. (Inherited from RunBase.)
	dialogInternal	(Inherited from RunBase.)
	dialogMake	Obtains the dialog from a RunBase class. (Inherited from RunBase.)
	dialogPost	Executes after the dialog method has been called. (Inherited from RunBaseBatch.)
	dialogPostInit	Called right after the RunBase.dialogInit Method method. (Inherited from RunBase.)
	dialogPostRun	Called after the Dialog.run Method class. (Inherited from RunBase.)
	dialogReInit	Reinitializes the dialog box. (Inherited from RunBase.)
	dialogSelectCtrl	When using the dialog class for dialog, this method is called whenever a control is selected. (Inherited from RunBase.)
	dialogTask	When using the Dialog Class class for dialog, this method is called from the task method in the dialog form. (Inherited from RunBase.)
	dialogUpdate	Updates the dialog, for example after reinitializing the query. (Inherited from RunBase.)
	dialogUpdateQuery	Updates the query in the dialog box. (Inherited from RunBase.)
	doBatch	(Inherited from RunBaseBatch.)
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	execute	Executes a section of a report. (Inherited from XMLExcelReport_RU.)
	fetchHeader	Method fetches a new record from table which corresponds to a whole report (Overrides the fetchHeader Method.)
	fetchLines	Method fetches a new report line (Overrides the fetchLines Method.)
	fileName	Name of the new file (Overrides the fileName Method.)
	fileNamePostfix	Override this method to reflect distinct document parameters at file name(invoice no, date, etc.) (Overrides the fileNamePostfix Method.)
	fillBody	Method should be used to fill body section with data (Overrides the fillBody Method.)
	fillData	Determines which section should be filled and calls the corresponding method. (Inherited from XMLExcelReport_Standard_RU.)
	fillPageFooter	Method should be used to fill page footer section with data (Overrides the fillPageFooter Method.)
	fillPageHeader	Method should be used to fill page header section with data (Overrides the fillPageHeader Method.)
	fillReportFooter	Method should be used to fill report footer section with data (Overrides the fillReportFooter Method.)
	fillReportHeader	Method should be used to fill report header section (Overrides the fillReportHeader Method.)
	getFromDialog	Assigns the dialog values to the internal variables. (Overrides the getFromDialog Method.)
	getLast	Gets the last choice stored in the last value table. (Inherited from RunBaseBatch.)
	getNumOfLines	Gets the number of lines.
	getRangeHeight	Gets the height of a section that wraps strings and is resizable. (Inherited from XMLExcelReport_RU.)
	getRunBase	(Inherited from RunBase.)
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	inGetSaveLast	Returns true when the GetLast or SaveLast method is executed. (Inherited from RunBase.)
	init	Gives RunBase the same profile as, for example, a FormRun class. This method is not used in the standard application. (Inherited from RunBase.)
	initBatch	(Inherited from RunBaseBatch.)
	initParmDefault	Initializes the internal variables. (Inherited from RunBase.)
	initQueryRunHeader	Method initialized queryRun on header (Overrides the initQueryRunHeader Method.)
	initQueryRunLines	Method initializes queryRun which corresponds to lines of report (Overrides the initQueryRunLines Method.)
	initSectionMap	Initializes a map that holds section data. (Inherited from XMLExcelReport_Standard_RU.)
	initSectionNames	Initializes the section name variables with values. (Inherited from XMLExcelReport_Standard_RU.)
	initSkipSections	Method can be used to add section to a container, which hold data about section which should not be printed (Overrides the initSkipSections Method.)
	insertValueToSection	Inserts a value into the document. (Inherited from XMLExcelReport_RU.)
	insertValueToSectionNoOverflow	Inserts a value into the document, preventing height overflow. (Inherited from XMLExcelReport_RU.)
	isInBatch	Determines whether the RunBaseBatch is actually being run from a batch server. (Inherited from RunBaseBatch.)
	isSwappingPrompt	Checks if the program is currently swapping from server to client. (Inherited from RunBase.)
	lastValueDataAreaId	(Inherited from RunBase.)
	lastValueDesignName	(Inherited from RunBase.)
	lastValueElementName	(Inherited from RunBase.)
	lastValueType	(Inherited from RunBase.)
	lastValueUserId	(Inherited from RunBase.)
	makeDocument	Opens an XMLExcelDocument file, so that you can work with it. (Inherited from XMLExcelReport_RU.)
	mustCreateNewPage	Checks whether the report should create a new page. (Inherited from XMLExcelReport_Standard_RU.)
	mustGoBatch	(Inherited from RunBaseBatch.)
	mustLoadSaveQuery	Determines whether the last query must be loaded and saved when you leave the form. Called from the SysQueryForm. (Inherited from RunBase.)
	mustPrintSection	Determines whether a section should be printed on the current report. (Inherited from XMLExcelReport_Standard_RU.)
	name	Returns the name of the RunBase class. (Inherited from RunBase.)
	new	Initializes a new instance of the RPayReport_EmplMonthIncome 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.)
	pack	Serializes the current instance of the RPayReport_EmplMonthIncome class. (Overrides the pack Method.)
	pageNum	returns string which contains data about page number
	pageWidthInColumns	Sets the value of the spans attribute for the first worksheet of the Excel document. (Inherited from XMLExcelReport_RU.)
	parmArgs	Gets or sets the Args parameter. (Inherited from XMLExcelReport_RU.)
	parmCurrentBatch	Gets or sets the CurrentBatch parameter. (Inherited from RunBaseBatch.)
	parmData	Get the parameters for report that should be printed. (Inherited from XMLExcelReport_Standard_RU.)
	parmInBatch	Gets or sets the InBatch parameter. (Inherited from RunBaseBatch.)
	parmPrintJobSettings	Passes the printJobSettings instance to the class. (Inherited from XMLExcelReport_RU.)
	parmProgress	Gets or sets the Progress parameter. (Inherited from RunBase.)
	prepareForRun	Allows subclasses to process the dialog box immediately before the execution of the dialog box.Run method. (Inherited from RunBaseBatch.)
	processInExcel	Processes the specified file by using print management or the printJobSettings instance. (Inherited from XMLExcelReport_RU.)
	progressHide	Hides the Progress form. (Inherited from RunBase.)
	progressInit	Initializes the Progress object in RunBase. (Inherited from RunBase.)
	progressKill	Kills the Progress object in RunBase. (Inherited from RunBase.)
	prompt	Displays the dialog from the class dialog and waits for user input. (Inherited from RunBaseBatch.)
	promptPack	Wraps a call to the RunBase.pack Method when packing in the RunBase.promptPrim Method. (Inherited from RunBaseBatch.)
	promptUnpack	(Inherited from RunBaseBatch.)
	putToDialog	Enables setting the fields that were just added in the RunBase.dialog Method method. This method is called from the RunBase.promptPrim Method method directly following the RunBase.dialogMake Method method. (Inherited from RunBase.)
	queryRun	Returns the QueryRun object, which is used by the QueryPrompt class. (Inherited from RunBase.)
	reset	Resets the class to its default state. (Inherited from RunBase.)
	resetReport	Resets all report variables to the original values. (Inherited from XMLExcelReport_Standard_RU.)
	run	Creates a working copy of the template file and opens it in COM Excel, if this is required. (Inherited from XMLExcelReport_RU.)
	runBase	Returns the RunBase itself. (Inherited from RunBase.)
	runBaseDialogModifyType_RU	(Inherited from RunBase.)
	runsImpersonated	Indicates whether the batch job will be run with the account of the user that created the job. (Overrides the runsImpersonated Method.)
	saveLast	Saves the last choice by using the RunBase.pack Method. (Inherited from RunBaseBatch.)
	setCurrentWorksheetNum	Determines the current worksheet, gets the page height of the worksheet, and sets the value of the spans attribute for the worksheet. (Inherited from XMLExcelReport_RU.)
	setPrintArea	Sets the print area for the Excel document. (Inherited from XMLExcelReport_RU.)
	setRangeHeight	Sets height for cells range. (Inherited from XMLExcelReport_RU.)
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	showBatchTab	(Inherited from RunBaseBatch.)
	showClearButton	Determines whether to add a Clear button to the dialog box. If you change the return value to true it will add the button. (Inherited from RunBase.)
	showDefaultButton	Determines whether a Default button is to be added to the dialog box. If you change the return value to true, it will add the button. (Inherited from RunBase.)
	showDialog	(Inherited from RunBase.)
	showIndexFields	If this method returns true, it will look for the first enabled index when you are adding query range fields to the dialog and if a data source does not have any ranges specified. It will also show the visible fields from that index. (Inherited from RunBase.)
	showQuerySelectButton	(Inherited from RunBase.)
	showQueryValues	Determines whether a Select button is to be added to the dialog box. If you change the return value to true, the button will be added. (Inherited from RunBase.)
	templateName	Method should return name of template for report (Overrides the templateName Method.)
	toString	Returns a string that represents the current object. (Inherited from Object.)
	totalCells	Method returns total number of cells(approximate) to be filled during report creation (Overrides the totalCells Method.)
	unpack	Deserializes the packedClass parameter value to an instance of the RPayReport_EmplMonthIncome class. (Overrides the unpack Method.)
	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 report parameters. (Overrides the validate Method.)
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::construct	Initializes a new instance of the RPayReport_EmplMonthIncome class.
	::description	Gets the description of the class.
	::main	Provides an entry point for the RPayReport_EmplMonthIncome class when it is called from a menu item.

Top

Inheritance Hierarchy

Object Class
  RunBase Class
    RunBaseBatch Class
      XMLExcelReport_RU Class
        XMLExcelReport_Standard_RU Class
          RPayReport_EmplMonthIncome Class