XMLExcelReport_SalesBook_RU Class [AX 2012]

The XMLExcelReport_SalesBook_RU class is used to print purchase books or purchase book additional lists to Microsoft Excel.

Syntax

class XMLExcelReport_SalesBook_RU extends XMLExcelReport_RU

Run On

Called

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	Calculates the totals that will be printed at the end of the report.
	allowSaveLast	(Inherited from RunBaseBatch.)
	batchInfo	Returns the BatchInfo class. This class is the API for the batch table. (Inherited from RunBaseBatch.)
	calcRangeHeight	Calculates the height of a section that contains cells that 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. (Overrides the canGoBatch Method.)
	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.)
	changeQueryRun	Changes a query run, depending on the parameters of the purchase book and its printout.
	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.)
	createReport	Is used as the main method for creating the report. (Overrides the createReport Method.)
	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	Is used to enable methods to be overridden on dialog box controls. (Overrides the dialogPostRun Method.)
	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.)
	fileName	Is overridden to return the name of the working copy of the Excel file. (Overrides the fileName Method.)
	fileNamePostfix	Is overridden to reflect the distinct document parameters in the file name (invoice number, date, and so on). (Overrides the fileNamePostfix Method.)
	fillBody	Fills a report line with data,
	fillData	Is overridden to implement data that is used to fill a specified section. (Overrides the fillData Method.)
	fillPageHeader	Fills the page header with data, but there's nothing to fill yet.
	fillReportFooter	Fills the report footer with data.
	fillReportHeader	Fills the report header with data.
	fld900_1_modified	Fills the start date field and end date field with data, if the period was modified.
	getFactureStr	Returns the description string for a facture.
	getFactureStrCorr	Gets the value that should be printed to the Corrected facture number and date field.
	getFactureStrCorrRevision	Gets the value that should be printed to the Revision facture number and date field, if there's a revision of a corrected facture.
	getFactureStrRevision	Gets the value that should be printed to the Revision facture number and date field.
	getFactureStrRevisionCorr	Gets the value that should be printed to the Revision date and number field, if there’s a correction of a revision facture.
	getFromDialog	Gets the values that are entered in the dialog box. (Overrides the getFromDialog Method.)
	getLast	Gets the last choice stored in the last value table. (Inherited from RunBaseBatch.)
	getNumOfLines	Calculates the number of lines on the report.
	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	Initializes a class instance. (Overrides the init Method.)
	initBatch	(Inherited from RunBaseBatch.)
	initBookDateNumDelimiter
	initParmDefault	Initializes the internal variables. (Overrides the initParmDefault Method.)
	initSectionMap	Initializes a map that holds section data.Use the addSection method to add a section to the map. (Overrides the initSectionMap 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	Determines whether a new page should be created before the next line is printed.
	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.)
	mustPrintIncomingTotals	Determines whether a section that contains incoming totals should be printed.
	mustPrintSection	Determines whether a section should be printed on the current report. (Inherited from XMLExcelReport_RU.)
	name	Returns the name of the RunBase class. (Inherited from RunBase.)
	new	Initializes a new instance of the RunBaseBatch class. (Inherited from RunBaseBatch.)
	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 XMLExcelReport_SalesBook_RU class. (Overrides the pack Method.)
	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.)
	parmBookRecId	Gets or sets the BookRecId parameter.
	parmCurrentBatch	Gets or sets the CurrentBatch parameter. (Inherited from RunBaseBatch.)
	parmFromDate	Gets or sets the FromDate parameter.
	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.)
	parmToDate	Gets or sets the ToDate parameter.
	prepareForRun	Allows subclasses to process the dialog box immediately before the execution of the dialog box.Run method. (Inherited from RunBaseBatch.)
	printIncomingTotals	Prints incoming totals.
	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. (Overrides the queryRun Method.)
	reset	Resets the class to its default state. (Inherited from RunBase.)
	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 who created the job. (Inherited from RunBaseBatch.)
	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 added to the dialog box. (Overrides the showDefaultButton Method.)
	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 added to the dialog box. (Overrides the showQueryValues Method.)
	templateName	Returns the name of the template for the report. (Overrides the templateName Method.)
	toString	Returns a string that represents the current object. (Inherited from Object.)
	totalCells	Returns the approximate total number of cells that will be filled during report creation. (Overrides the totalCells Method.)
	unpack	Deserializes the _packedClass parameter value to an instance of the XMLExcelReport_SalesBook_RU 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 values that are entered in the dialog box. (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 XMLExcelReport_SalesBook_RU class.
	::description	Gets the description of the class.
	::getFactureSeparateDivisionId	Returns the value that should be printed in the Separate division field.
	::main	Provides an entry point for the XMLExcelReport_SalesBook_RU class when it is called from a menu item.

Top

Inheritance Hierarchy

Object Class
  RunBase Class
    RunBaseBatch Class
      XMLExcelReport_RU Class
        XMLExcelReport_SalesBook_RU Class
          XMLExcelReport_SalesBook_AddList_RU Class