XMLExcelReport_RU Class [AX 2012]

Article
04/11/2014

The XMLExcelReport_RU class is a base class for reports that use the Open XML SDK as their engine.

Syntax

class XMLExcelReport_RU extends RunBaseBatch

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.
	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.
	calcSectionHeight	Calculates the height of a section of fixed height.
	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.)
	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.
	dialog	Returns a class that contains the methods that are described by the RunBaseDialogable interface. (Inherited from RunBase.)
	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.
	fileName	Is overridden to return the name of the working copy of the Microsoft Excel file.
	fileNamePostfix	Is overridden to reflect the distinct document parameters in the file name (invoice number, date, and so on).
	fillData	Is overridden to implement data that is used to fill a specified section.
	getFromDialog	Assigns the dialog values to the internal variables. (Inherited from RunBaseBatch.)
	getLast	Gets the last choice stored in the last value table. (Inherited from RunBaseBatch.)
	getRangeHeight	Gets the height of a section that wraps strings and is resizable.
	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.)
	initSectionMap	Initializes a map that holds section data.Use the addSection method to add a section to the map.
	insertValueToSection	Inserts a value into the document.
	insertValueToSectionNoOverflow	Inserts a value into the document, preventing height overflow.
	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.
	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.
	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 RunBase class. (Inherited from RunBase.)
	pageWidthInColumns	Sets the value of the spans attribute for the first worksheet of the Excel document.
	parmArgs	Gets or sets the Args parameter.
	parmCurrentBatch	Gets or sets the CurrentBatch parameter. (Inherited from RunBaseBatch.)
	parmInBatch	Gets or sets the InBatch parameter. (Inherited from RunBaseBatch.)
	parmPrintJobSettings	Passes the printJobSettings instance to the class.
	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.
	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.)
	run	Creates a working copy of the template file and opens it in COM Excel, if this is required. (Overrides the run Method.)
	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.
	setPrintArea	Sets the print area for the Excel document.
	setRangeHeight	Sets height for cells range.
	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	Returns the name of the template for the report.
	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.
	unpack	Deserializes the packedClass parameter value to an instance of the RunBase class. (Inherited from RunBase.)
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	validate	(Inherited from RunBaseBatch.)
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::splitStrByLines	Splits a given string into several strings of lengths that are less than the lengths in the _lineLen container.

Top

Remarks

This class implements logic for report rendering.

Inheritance Hierarchy

XMLExcelReport_RU Class [AX 2012]

Syntax

Run On

Methods

Remarks

Inheritance Hierarchy

Additional resources