SRSReportRun Class [AX 2012]

The SRSReportRun class is deprecated. Use the SrsReportRunController class to execute and print reports.

Syntax

class SRSReportRun extends RunBaseBatch

Run On

Called

Methods

	Method	Description
	addAOTQueriesFromDocument	Searches the report definition language (RDL) document and adds QueryMetadata queries to the Map object.
	allowSaveLast	(Inherited from RunBaseBatch.)
	batchInfo	Returns the BatchInfo class. This class is the API for the batch table. (Inherited from RunBaseBatch.)
	buildReportRdlParameterCtrls	Determines whether the dialog box will display the SQL ServerReporting Services (SSRS) Report Parameters.
	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.)
	copyQuery	Makes a copy of a query.
	currentQuery	Gets or sets the value of the currentQuery property.
	currentQueryKey	Gets or sets the value of the currentQueryKey property.
	currentQueryRun	Gets or sets the value of the currentQueryRun property.
	dialog	Gets or sets the dialog property. (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	Makes sure that the methods of the dialog form controls are overloaded and that the specified object is the object to which the messages of the controls are sent. (Overrides the dialogPostRun Method.)
	dialogReInit	Reinitializes the dialog box. (Inherited from RunBase.)
	dialogSelectCtrl	Provides the functionality that is needed when a dialog control is selected. (Overrides the dialogSelectCtrl Method.)
	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.)
	displayReportWarnings	Adds the warning messages that are created when a report is rendered to the infolog.
	doBatch	(Inherited from RunBaseBatch.)
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	executeReport	Executes the report using the current object properties.
	getDictFieldFromFieldAlias	Retrieves an instance of the DictField class by using a field alias.
	getFieldAliasFromParameterName	Attempts to retrieve an alias of a field of a table from a report parameter element in the report definition language (RDL) document by inspecting the parameter name.
	getFieldAliasFromParameterValidValues	Retrieves the alias of a field in a table from a report parameter element in the report definition language (RDL) document by inspecting the ValidValues XML element.
	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.)
	getParametersFromRdlDocument	Builds a map of the SRSReportParameter objects that the report uses where: The key is a string value that contains parameter names and the value is a SRSReportParameter object.
	getQueriesFromDocument	Builds a map of the Microsoft Dynamics AX queries that a VS Reporting Tools for AX report uses.
	getReportParameterDefaultValue	Gets the default value for a report parameter.
	getReportParameterDictField	Retrieves an instance of the DictField class from a report parameter element in the report definition language (RDL) document.
	getRunBase	(Inherited from RunBase.)
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	getXmlElementValue	Gets a String value that represents an XmlElement objec.
	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 the SRSReportRun object. (Overrides the init Method.)
	initBatch	(Inherited from RunBaseBatch.)
	initParmDefault	Initializes the internal variables. (Inherited from RunBase.)
	isInBatch	Determines whether the RunBaseBatch is actually being run from a batch server. (Inherited from RunBaseBatch.)
	isInitialized	Gets the value of the isInitialized member.
	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.)
	menuItemArguments	Gets and sets the menuItemArguments class property.
	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.)
	name	Returns the name of the RunBase class. (Inherited from RunBase.)
	new	Initializes a new instance of the SRSReportRun 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 SRSReportRun class. (Overrides the pack Method.)
	parmCurrentBatch	Gets or sets the CurrentBatch parameter. (Inherited from RunBaseBatch.)
	parmInBatch	Gets or sets the InBatch parameter. (Inherited from RunBaseBatch.)
	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.)
	printDestinationSettings	Gets or sets the value of the printDestinationSettings property.
	printReport	Executes the report and sends the results to the appropriate print medium.
	printReportToCustom	Renders the current report to a custom print medium.
	printReportToEmail	Renders the current report to a file and attaches that file to an e-mail message.
	printReportToFile	Renders the current report to a file.
	printReportToPrinter	Renders the current report to the current printer.
	printReportToScreen	Renders the current report to the screen.
	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	Prompts the user for report settings using the SRSReportRunForm form. (Overrides the prompt Method.)
	promptPack	Wraps a call to the RunBase.pack Method when packing in the RunBase.promptPrim Method. (Inherited from RunBaseBatch.)
	promptUnpack	(Inherited from RunBaseBatch.)
	proxy	Gets the value of the proxy property.
	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	Gets or sets the value of the queryRun property. (Overrides the queryRun Method.)
	readParameters	Reads saved parameters from the database used to make the report.
	readPrintDestinationSettings	Reads saved print destination settings that are used to display the report.
	readPrinterSettings	Gets or sets the value of the readPrinterSettings property.
	readQueries	Reads saved queries used to make the report.
	readReportParameters	Gets or sets the value of the readReportParameters property.
	readReportQueries	Gets or sets the value of the readReportQueries property.
	readSettings	Reads the settings saved for this report.
	reportCaption	Gets or sets the value of the reportCaption property.
	reportDefinitionDocument	Creates an XML document object that contains the report definition.
	reportDefinitionDocumentNamespaceManager	Creates an XMLNamespaceManager object that is used to perform XPath queries on the report definition document.
	reportName	Gets or sets the report name property.
	reportParameter	Gets or sets the value of a report parameter given the report parameter name and optionally the new value
	reportParameterFromElement	Creates an instance of the SRSReportParameter class based on the contents of a report parameter XML element.
	reportParameters	Gets a Map object that contains SRSReportParameter objects where the key is the string value that contains the parameter name value that equals the SRSReportParameter object.
	reportParametersUseDataSets	Gets and set the reportParametersUseDataSets property.
	reportParametersUseExpressions	Gets and sets the reportParametersUseExpressions property.
	reportParameterValidator	Gets or sets the reportParameterValidator property.
	reportPath	Gets or sets the path of the report including the report name and in Reporting Services.
	reportQueries	Gets a map that contains the key set to the ReportParameterName and the value set to the query.
	reportQuery	Gets or sets the query in the map of the reportQueries property that has a query from a map object that uses the supplied query name and optionally a new query value.
	reportRDL	Gets or sets the report Report Definition Language (RDL).
	reportRunHelper	Gets and sets the value of the reportRunHelper member.
	reportSettings	Gets or sets the reportSettings class property.
	reportUrl	Gets the full URL to the report.
	reset	Resets the class to its default state. (Inherited from RunBase.)
	resetQueries	Resets the queries used in the report to default values.
	run	Runs the report object. (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.)
	saveParameters	Saves parameters that are used to display the report.
	savePrintDestinationSettings	Saves print destination settings that are used to display the report.
	savePrinterSettings	Gets or sets the value of the savePrinterSettings property.
	saveQueries	Saves queries that are used to display the report.
	saveReportParameters	Gets or sets the value of the saveReportParameters property.
	saveReportQueries	Gets or sets the value of the saveReportQueries property.
	saveSettings	Saves the current values that are used to display the report
	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	Gets or sets the value of the showDialog property. (Overrides the showDialog Method.)
	showIndexFields	Determines whether the index fields of the table are used as query range fields. (Overrides the showIndexFields Method.)
	showParamGroup	Determines whether the parameters group should be visible.
	showPrintDestination	Gets or sets the value of the showPrintDestination property.
	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.)
	tempPrintDestinationSettings	Gets or sets the value of the tempPrintDestinationSettings property. This property is used by the SRSReportRunForm form.
	toString	Returns a string that represents the current object. (Inherited from Object.)
	trim	Trims the spaces from the start and end of a string.
	unpack	Deserializes the packedClass parameter value to an instance of the SRSReportRun class. (Overrides the unpack Method.)
	updateReportParameterFromElement	Updates a report parameter given an XML element whose root is a ReportParameter object.
	updateReportParameterQueryRecIDs	Ensures that the RecId values of the report query parameters are correct.
	updateReportParameters	Updates the report parameters that are given to an XMLDocument object by using a root element that is an ArrayOfReportParameter object.
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	useIndexFieldsAsQueryRanges	Gets or sets the useIndexFieldsAsQueryRanges property.
	validate	(Inherited from RunBaseBatch.)
	validateReportParameters	Validates the parameters for a report.
	validateReportRunHelper	Performs custom parameter validation by using the defined member from the reportRunHelper method.
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::buildFromEmailAddress	Builds the From e-mail address for sending emails.
	::constructReportSettings	Creates a Microsoft.Dynamics.ReportingServices.ReportSettings object.
	::convertFromUserTimeToUTC	Converts the given string from user time zone to UTC time zone.
	::convertFromUTCToUserTime	Converts the specified string from UTC to user time zone.
	::createMailer	Creates a SysMailerNet object that is used to create e-mail messages when printing from the server.
	::createRenderingCultureParameterValue	Creates a ParameterValue object that specifies the rendering culture framework parameter.
	::createSSRSReportParameterValue	Creates a ParameterValue object by using the specified name and value.
	::extractParameterNameFromCustomProperty	Extracts the report parameter name from the specified name element of the custom property for dynamic filters.
	::findQueryNode	Finds and returns a query TreeNode object given a query name.
	::getReportAndDesignName
	::getReportParametersFromWebService	Retrieves the report parameters from the Reporting Services Web service.
	::getReportPath	Gets the SSRS path of a report that has the specified name.
	::getReportRDL	Retrieves the Report Definition Language (RDL) contents, the XML, of the report at the specified path.
	::getReportUrl	Retrieves the URL of the named report.
	::itemExists	Indicates whether an item at the specified path is in SSRS.
	::parameterValueArray	Creates an ArrayList object and fills it with the report parameters.
	::queryNameFromCommandText	Gets the query name from a string that is used as the command text for the query.
	::renderReportToFile	Renders the report to a file.
	::renderReportToPrinter	Renders the report and sends it to the printer.
	::saveParametersOnServer	Saves parameters that are used to display the report.
	::savePrintDestinationSettingsOnServer	Saves print destination settings that are used to display the report.
	::saveQueriesOnServer	Saves queries that are used to display the report.

Top

Inheritance Hierarchy

Object Class
  RunBase Class
    RunBaseBatch Class
      SRSReportRun Class