SrsReportDataContractUIBuilder Class [AX 2012]

Article
04/11/2014

The SrsReportDataContractUIBuilder class provides the functionality to build the parameter user interface (UI) based on metadata.

Syntax

class SrsReportDataContractUIBuilder extends SysOperationAutomaticUIBuilder

Run On

Called

Methods

	Method	Description
	addCollectionDialogField	Adds a dialog box for the SysOperationDataMemberInfo object that is of the collection type. (Inherited from SysOperationAutomaticUIBuilder.)
	addDateEffectiveRangeControls
	addDateEffectiveTabControls
	addDateTimeDialogField
	addDialogField	Add fields to the dialog box that is being built. (Overrides the addDialogField Method.)
	addEventHandlerForControlChange	Overrides the default event handlers of the formControl object to refresh the parameter values.
	addValidValuesToComboBox
	bindInfo	(Inherited from SysOperationUIBuilder.)
	build	(Inherited from SysOperationAutomaticUIBuilder.)
	buildGroup	(Inherited from SysOperationAutomaticUIBuilder.)
	buildValidTimeRangesGroups
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	checkBoxClicked
	comboBoxSelectionChange
	controller	(Inherited from SysOperationUIBuilder.)
	dataContractInfo	(Inherited from SysOperationUIBuilder.)
	dataContractObject	(Inherited from SysOperationUIBuilder.)
	dateControlModified
	dateTimeControlModified
	dialog	(Inherited from SysOperationUIBuilder.)
	dialogSelectCtrl	(Inherited from SysOperationUIBuilder.)
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	getFromDialog	Transfers data from the dialog into the data contract object. (Overrides the getFromDialog Method.)
	getFromDialogDateEffective
	getMultiSelectFromDialogField	Gets the values that are selected in the multi-select control after the user clicks the OK button in the dialog box. (Overrides the getMultiSelectFromDialogField Method.)
	getMultiSelectTableForType	Gets the SyOperationMultiSelectTmp table that contains the list of values that must be displayed in the drop down list. (Overrides the getMultiSelectTableForType Method.)
	getParameterValuesFromUIRecursively	Gets the report parameters recursively from the members of a nested data contract object.
	getRdlContractInfo	Gets the RDL contract information for the underlying RDL contract class.
	getRdlParser
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	int64ControlModified
	intControlModified
	modifyCollectionDialogField	Changes the field for a collection in the dialog box to use the multi-select control. (Inherited from SysOperationAutomaticUIBuilder.)
	modifySavedCollectionDialogFieldValues	Converts the values in a multi-select dialog box field from the valid values to labels.
	new	(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.)
	postBuild	(Inherited from SysOperationUIBuilder.)
	postRun	Performs post run actions (Overrides the postRun Method.)
	preBuild	(Inherited from SysOperationUIBuilder.)
	putToDialog	Transfers data from the data contract object to the dialog box by recursively moving through the nested controls. (Inherited from SysOperationAutomaticUIBuilder.)
	radioControlSelectionChange
	realControlModified
	refreshComboBoxControl
	refreshParameterControlsRecursively	Refreshes UI properties recursively of report parameter controls that are bound to a data contract based on the parameter runtime default value and dependency state.
	refreshParameters	Refreshes UI properties of report parameter controls based on their runtime default, valid values, and dependency state.
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	setupDependenciesRecursively	Sets up the event handlers on report parameter controls that are bound to a data contract based on design time parameter dependencies.
	stringControlModified
	toString	Returns a string that represents the current object. (Inherited from Object.)
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::addDateControl
	::addDateEffectiveAsOfControl
	::addDateTimeControl
	::addRadioButtonGroup
	::getReportParameterFromMemberInfo	Gets the SrsReportParameter object that is bound to a report RDP or RDL contract data member.

Top

Remarks

The framework has a default UI builder. Extend the framework UI builder to add events, create a custom lookup, create custom controls, or change the layout of the parameter form.

You can create grouping; vertical or horizontal alignment; change the number of columns; or add look ups. The following methods can be overridden to add necessary functionality:

SrsReportDataContractUIBuilder.addDialogField
SrsReportDataContractUIBuilder.getFromDialog
SrsReportDataContractUIBuilder.build
SrsReportDataContractUIBuilder.buildGroup

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

Inheritance Hierarchy