IAdmReportArguments
The IAdmReportArguments interface is used to pass arguments for report generation.
Inheritance: IUnknown
To create an instance of report arguments, use the IAdmReportConfiguration::CreateReportArguments method.
Methods
-
Method
-
Description
-
SetParameterValue()
-
Sets a value for the given report parameter.
-
GetParameterValue()
-
Returns the value of the given report parameter.
-
GetParameterValueAsIs()
-
Returns the value of the given report parameter as it was set.
-
ResetAllParameterValues()
-
Clears values for all report parameters.
-
GetAllParameterNames()
-
Returns names of all parameters specified for the report.
-
GetParameter()
-
Returns a report parameter with the specified name.
-
ResolveValueReferences()
-
Returns a copy of report arguments with value references replaced with values of corresponding properties of the user, for which the report is generated.
-
ResolveValueReferencesInParameters()
-
Returns an array of all report parameters with value references replaced with values of corresponding properties of the user, for which the report is generated.
Properties
-
Property
-
Description
-
ReportId
-
Gets the unique immutable identifier of the report for which the arguments are meant.
-
Scope
-
Gets or sets the scope for report generation.
-
Columns
-
Gets or sets an array of columns that must be present in the report.
-
Recipient
-
Gets or sets a user account for which the report is generated.
-
PreloadDataForChart
-
Gets or sets a value indicating whether to preload data necessary to build the report chart.
Details
SetParameterValue()
Sets a value for the given report parameter. You can use value references in the value (e.g. %username%). Value references are replaced with values of corresponding properties of the user, for which the report is generated.
void SetParameterValue(string paramName, object value)
Parameters
- paramName - Specifies the name of the report parameter for which a value is set.
- value - Specifies the value of the report parameter.
GetParameterValue()
Returns the value of the given report parameter. If the value is not allowed for the report parameter, the method throws an exception.
string GetParameterValue(string paramName, ADM_VALUETARGET_ENUM valueTarget)
Parameters
- paramName - Specifies the name of the report parameter for which to return the value.
- valueTarget - Specifies how the report parameter value is used.
GetParameterValueAsIs()
Returns the value of the given report parameter as it was set.
object GetParameterValueAsIs(string paramName)
Parameters
The paramName parameter specifies the name of the report parameter for which to return the value.
ResetAllParameterValues()
Clears values for all report parameters.
void ResetAllParameterValues()
GetAllParameterNames()
Returns names of all parameters specified for the report.
void ConvertToRegularMailbox()
Parameters
If the visibleOnly parameter is set to true, the method does not return report parameters hidden from the user.
Remarks
Names of all report parameters returned by this method start with the param- prefix.
GetParameter()
Returns a report parameter with the specified name.
IAdmReportParameter GetParameter(string name)
Parameters
The name parameter specifies the name of the report parameter to return.
ResolveValueReferences()
Returns a copy of report arguments with value references replaced with values of corresponding properties of the user, for which the report is generated.
IAdmReportArguments ResolveValueReferences(out string[] warnings)
Parameters
warnings is an output (OUT) parameter that returns an array containing warnings issued while resolving value references.
ResolveValueReferencesInParameters()
Returns an array of all report parameters with value references replaced with values of corresponding properties of the user, for which the report is generated.
IAdmReportParameter[] ResolveValueReferencesInParameters(out string[] warnings)
Parameters
warnings is an output (OUT) parameter that returns an array containing warnings issued while resolving value references.
ReportId
Gets the unique immutable identifier of the report for which the arguments are meant.
- Type:
- string
- Access:
- Read-only
Scope
Gets or sets the scope for report generation.
- Type:
- IAdmReportScope
- Access:
- Read/Write
Columns
Gets or sets an array of columns that must be present in the report.
- Type:
- object[]
- Access:
- Read/Write
Remarks
In the array, the property name defined in your directory schema is used to identify a column that represents the property. Custom columns are represented by the IAdmReportCustomColumn interface.
Recipient
Gets or sets a user account for which the report is generated. By default, it is the user account whose credentials were used to bind to the report.
- Type:
- IAdmTop
- Access:
- Read/Write
Remarks
Only service administrators have the permission to set this property.
PreloadDataForChart
Gets or sets a value indicating whether to preload data necessary to build the report chart.
- Type:
- bool
- Access:
- Read/Write
Remarks
Set this property to true if you are planning to create a chart. The property is used for performance optimization purposes only.
Requirements
Minimum required version: 2018.1