IAdmReportConfiguration
The IAdmReportConfiguration interface is used to configure a report.
Inheritance: IUnknown
To get the IAdmReportConfiguration interface, use the IAdmReport::GetConfiguration method.
Methods
-
Method
-
Description
-
CreateScope()
-
Creates a report scope of the given type.
-
CreateParameter()
-
Creates a report parameter of the given type.
-
CreateChart()
-
Creates a report chart of the given type.
-
CreateGenerator()
-
Creates a report generator of the given type.
-
CreateReportArguments()
-
Creates an instance of the IAdmReportArguments interface that represents arguments for report generation.
Properties
-
Property
-
Description
-
Scopes
-
Gets or sets an array of scopes for which a report can be generated.
-
Parameters
-
Gets or sets an array of report parameters.
-
Columns
-
Gets settings of report columns.
-
Chart
-
Gets or sets a chart of a report.
-
RelatedReports
-
Gets or sets an array of related reports.
-
GenerateOnOpen
-
Gets or sets a value indicating whether a report must be generated immediately after the user selects it.
-
Generator
-
Gets or sets the generator of a report.
Details
CreateScope()
Creates a report scope of the given type.
IAdmReportScope CreateScope(ADM_REPORTSCOPETYPE_ENUM type)
CreateParameter()
Creates a report parameter of the given type.
IAdmReportParameter CreateParameter(ADM_PARAMETERTYPE_ENUM type)
CreateChart()
Creates a report chart of the given type.
IAdmReportChart CreateChart(ADM_REPORTCHARTTYPE_ENUM type)
CreateGenerator()
Creates a report generator of the given type.
IAdmReportGenerator CreateGenerator(ADM_REPORTGENERATORTYPE_ENUM type)
CreateReportArguments()
Creates an instance of the IAdmReportArguments interface that represents arguments for report generation.
IAdmReportArguments CreateReportArguments()
Scopes
Gets or sets an array of scopes for which a report can be generated.
- Type:
- IAdmReportScope[]
- Access:
- Read/Write
Remarks
The property is null if no scopes are specified for the report.
Parameters
Gets or sets an array of report parameters.
- Type:
- IAdmReportParameter[]
- Access:
- Read/Write
Columns
Gets settings of report columns.
- Type:
- IAdmReportColumns
- Access:
- Read-only
Chart
Gets or sets a chart of a report.
- Type:
- IAdmReportChart
- Access:
- Read/Write
Remarks
The property is null if no chart is set for the report.
RelatedReports
Gets or sets an array of related reports.
- Type:
- IAdmReport[]
- Access:
- Read/Write
GenerateOnOpen
Gets or sets a value indicating whether a report must be generated immediately after the user selects it.
- Type:
- bool
- Access:
- Read/Write
Generator
Gets or sets the generator of a report.
- Type:
- IAdmReportGenerator
- Access:
- Read/Write
Requirements
Minimum required version: 2018.1