Skip to content

IAdmReportGenerator

IAdmReportGenerator is the base interface for all interfaces used to configure report generators. A generator specifies principles based on which a report is built. For instance, a generator of a report based on AD search contains an LDAP search filter and additional conditions for including or excluding objects.

This interface provides access only to properties common for all report generators. To configure settings specific for each type of report generators, use the IAdmReportGeneratorADSearch, IAdmReportGeneratorScript and IAdmReportGeneratorProxy interfaces.

This interface exposes a set of properties similar to the IAdmReportConfiguration interface. Unlike the IAdmReportConfiguration interface, this interface gets the components used for report generation. Thus, if a report is based on another report, the components that are not overridden by the report are obtained from the base report. For instance, if a report overrides only the chart of the base report, the Chart property gets the component of the current report, while all other properties (e.g. Columns) get the components of the base report.

Inheritance: The IAdmReportGenerator interface inherits from the IUnknown interface.

Note

To create an instance of a report generator, use the IAdmReportConfiguration::CreateGenerator method.

Properties

  • Property

  • Description

  • Type

  • Gets the type of report generator.

  • Scopes

  • Gets an array of scopes for which a report can be generated.

  • Parameters

  • Gets an array of report parameters.

  • Columns

  • Gets settings of report columns.

  • Chart

  • Gets the chart of a report.

  • RelatedReports

  • Gets an array of related reports.

  • GenerateOnOpen

  • Gets a value indicating whether a report must be generated immediately after the user selects it.

Details

Type

Gets the type of report generator.


Scopes

Gets an array of scopes for which a report can be generated.

Remarks

The property is NULL if no scopes are defined for the report.


Parameters

Gets an array of report parameters.


Columns

Gets settings of report columns.


Chart

Gets the chart of a report.

Remarks

The property is NULL if no chart is set for the report.


RelatedReports

Gets an array of related reports.


GenerateOnOpen

Gets a value indicating whether a report must be generated immediately after the user selects it.

  • Type:
  • Boolean
  • Access:
  • Read-only

Requirements

Minimum required version: 2018.1

See also