SRSReportParameter Class [AX 2012]

The SRSReportParameter class contains the properties and methods that describe and validate a ReportLibraryReport parameter.

Syntax

class SRSReportParameter implements SysPackable

Run On

Called

Methods

	Method	Description
	addTimeToUtcDateTimeValue	Makes sure that the time portion occurs in a string that represents a UtcDateTime value.
	addValidValue	Add valid value
	allowBlank	Gets or sets the allowBlank property.
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	captionLabelId	Returns the label ID of the parameter.
	clone	Creates a new SRSReportParameter object that is based on the current instance.
	convertToUtcDateTimeFormat	Converts a string value that contains a date and time to a UtcDateTime string value.
	dataType	Gets or sets the Reporting Services data type property for the parameter.
	dateEffective	Gets or sets the date effectivity property for the parameter.
	defaultValue	Gets or sets the value of the defaultValue property.
	defaultValues	Gets or sets the value of the defaultValues property.
	dependencies	Gets or sets the dependencies list.
	dictField	Gets or sets the value of the dictField field.
	displayOrderKey	Gets or sets the display order for the parameter.
	enumId	Retrieves enumeration ID of the parameter.
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	extendedTypeId	Retrieves the extended type ID of the parameter.
	fieldAlias	Gets or sets the field alias that is used in Reporting Services for the parameter.
	getDefaultTypedValue	Gets the default value for the underlying primitive type based on the report parameter type.
	getSelectedValidValue	Gets the selected valid value from the valid values map or list for a given index.
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	getValueTyped	Gets the strongly typed value of the report parameter.
	groupName	Gets or sets the group name that the parameter belongs to.
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	hasOutstandingDependencies	Gets or sets a value that indicates whether the report parameter currently has unresolved dependencies.
	hasValidValuesDefinedInRDL	Indicates whether the report parameter has valid values defined in the report definition language.
	helpLabelId	Returns the label ID of the help for the parameter.
	hidden	Gets or sets the hidden property that is used in Reporting Services.
	isBoolean	Indicates whether the parameter is a Boolean type.
	isDependedOn	Indicates whether at least one other report parameter depends on this report parameter.
	isDependent	Indicating whether the report parameter depends on other report parameters.
	isInternal	Indicates whether the report parameter is an internal parameter.
	isNullValue	Specifies whether the value of the report parameter is null.
	isUtcDateTimeFormat	Determines whether a string value represents a UtcDateTime value.
	label	Gets the label to use when displaying a SRS Report parameter on a form.
	multiValue	Gets or sets the multi-value property from Reporting Services.
	name	Gets or sets the name of report parameter as specified in Reporting Services.
	new	Initializes a new instance of the SRSReportParameter class.
	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.)
	nullable	Gets or sets the nullable property in Reporting Services.
	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 SRSReportParameter class.
	prompt	Gets or sets the label that should be used when the parameter is shown on the UI.
	promptUser	Gets or sets the prompt user property.
	queryName	Gets or sets the AOT query name that is used in the report.
	rdlOrder	Gets or sets the order of the parameter as specified in RDL.
	rdpContract	Gets or sets the name of the RDP class that is used in the report.
	rdpContractMethod	Gets or sets the name of the contract method in the RDP class that maps to this parameter.
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	setValueToDefault	Sets the report parameter to have the default value for the underlying type.
	setValueTyped	Sets the report parameter value.
	state	Gets or sets the Reporting Services state parameter enumeration value.
	strToLocalDateTime	Converts the report value string to a utcDateTime value.
	toCultureSpecificString	Converts the report value into the current local format.
	toString	Returns a string that represents the current object. (Inherited from Object.)
	typeOfDataType	Gets or sets the AX type of the report parameter.
	unpack	Deserializes the packedClass parameter value to an instance of the SRSReportParameter class.
	updateFromServer	Gets or sets a value that indicates whether the update from the server property parameter should be updated with values from the server.
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	validate	This method is deprecated. Use the validateValue method instead.
	validateMissingValue
	validateMultiValues
	validateType
	validateValue	Validates the report parameter value.
	validValues	Gets or sets the value of the validValues property.
	validValuesList	Gets or sets the value of the validValuesList property.
	validValuesQueryBased	Gets or sets a value that indicates whether the valid values are based on a query.
	value	Gets or sets the value of the value property.
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::anyTypeToStringValue	Converts an Anytype value to a Types::String value, depending on the other properties in the specified SRSReportParameter object.
	::create	Creates a new instance of SrsReportParameter from a packed container.
	::getEnumDefaultValue	Gets the default value for the particular enum which is the value of the first element in the enum.

Top

Inheritance Hierarchy

Object Class
  SRSReportParameter Class