IAdmScheduledReportData

The IAdmScheduledReportData interface is used to specify parameters for report generation and delivery on schedule.

Inheritance: IUnknown

To create an instance of a report data object, use the IAdmReportScheduledTask::CreateReportData method.

Methods

Properties

  • Property

  • Description

  • ID

  • Gets or sets a unique identifier of the data object.

  • Report

  • Gets or sets the report to generate and deliver on schedule.

  • CustomTitle

  • Gets or sets an optional title for the scheduled report document.

  • ReportArguments

  • Gets or sets arguments for report generation on schedule.

  • Document

  • Gets or sets the IAdmReportDocument interface used to configure the report document.

  • Delivery

  • Gets or sets the IAdmReportDelivery interface used to configure delivery of the report.

  • SelfScheduled

  • Gets or sets a value indicating whether the report is scheduled by a user for themselves.

Details

CreateDocument()

Creates a report document of the given type.

IAdmReportDocument CreateDocument(ADM_REPORTDOCUMENTTYPE_ENUM type)

ID

Gets or sets a unique identifier of the data object. A unique identifier is automatically assigned to a data object after creation.

  • Type:
  • string
  • Access:
  • Read/Write

Report

Gets or sets the report to generate and deliver on schedule.

CustomTitle

Gets or sets an optional title for the scheduled report document.

  • Type:
  • string
  • Access:
  • Read/Write

Remarks

If this property is not set, the name of the report specified in the Report property is used.

ReportArguments

Gets or sets arguments for report generation on schedule.

Document

Gets or sets the IAdmReportDocument interface used to configure the report document.

Remarks

To create a report document, use the CreateDocument method.

Delivery

Gets or sets the IAdmReportDelivery interface used to configure delivery of the report.

Remarks

  • This property is never null.
  • By default, report delivery is disabled.

SelfScheduled

Gets or sets a value indicating whether the report is scheduled by a user for themselves.

  • Type:
  • bool
  • Access:
  • Read/Write

Requirements

Minimum required version: 2018.1

See also

© Softerra 2022. All rights reserved.
Send feedback