IAdmReportGeneratorProxy
The IAdmReportGeneratorProxy interface represents a report generator used to generate a report based on another existing report with overridden components. Components that are not overridden by the report are obtained from the base report. For example, if the report overrides only the chart of the base report, all other components (i.e. columns, parameters, etc.) are obtained from the base report.
Inheritance: IAdmReportGenerator
Properties
-
Property
-
Description
-
Report
-
Gets or sets the base report.
-
ReportId
-
Gets or sets the unique immutable identifier of the base report.
-
Components
-
Gets or sets the components of the base report to be overridden.
-
ParameterOverrideOptions
-
Gets or sets an array of IAdmParameterOverrideOptions interfaces used to define rules for overriding parameters of the base report.
Details
Report
Gets or sets the base report.
- Type:
- IAdmReport
- Access:
- Read/Write
Remarks
If the property is set, the ReportID property is automatically updated with the unique identifier of the base report.
ReportId
Gets or sets the unique immutable identifier of the base report.
- Type:
- string
- Access:
- Read/Write
Remarks
If this property is set, the Report property is automatically updated with the corresponding report object.
Components
Gets or sets the components of the base report to be overridden. The property can be set to a combination of components.
- Type:
- ADM_REPORTGENERATORPROXYCOMPONENT_ENUM
- Access:
- Read/Write
ParameterOverrideOptions
Gets or sets an array of IAdmParameterOverrideOptions interfaces used to define rules for overriding parameters of the base report.
- Type:
- IAdmParameterOverrideOptions[]
- Access:
- Read/Write
Remarks
This property is ignored if the ADM_REPORTGENERATORPROXYCOMPONENT_PARAMETERS flag is not set in the Components property.
Requirements
Minimum required version: 2018.1