Skip to content

IAdmReportOverviewItemBuilder

The IAdmReportOverviewItemBuilder interface is used to build report overview items.

Inheritance: The IAdmReportOverviewItemBuilder interface inherits from the IUnknown interface.

Methods

  • Method

  • Description

  • GetChartData()

  • Builds a chart for the report overview item.

  • Build()

  • Initiates asynchronous building of the report overview item.

  • Cancel()

  • Cancels building the report overview item.

Properties

  • Property

  • Description

  • Title

  • Gets the title of the report overview item.

  • State

  • Gets the current state of building the report overview item.

  • Chart

  • Gets the chart displayed in the report overview item.

  • ReportGenerationLog

  • Gets the log of errors, warnings, and informational messages associated with generating the report specified in the IAdmReportOverviewItem::Report property.

  • DataRetrievalLog

  • Gets the log of errors, warnings, and informational messages associated with retrieving data necessary to build a chart for the report overview item.

  • ChartLog

  • Gets the log of errors, warnings, and informational messages associated with building the chart.

  • ReportItemCount

  • Gets the total number of items in the report represented by the report overview item.

Details

GetChartData()

Builds a chart for the report overview item.

Object GetChartData()

Return value

  • For Bar and Pie charts, the method returns an Int32[] array. Each element in the array represents a value of a chart item.
  • For the Top Records chart, the method returns an array of IAdmSearchResult interfaces that contain column values for chart records.
  • For the Total Count chart, the method returns the total number of items in the report.

Exceptions

If an error occurs while building a chart, the method throws the exception that caused the failure.


Build()

Initiates asynchronous building of the report overview item.

void Build()

Cancel()

Cancels building the report overview item.

void Cancel()

Title

Gets the title of the report overview item.

  • Type:
  • String
  • Access:
  • Read-only

Remarks

If the IAdmReportOverviewItem::CustomTitle property is not set, this property gets the name of the report represented by the report overview item.


State

Gets the current state of building the report overview item.


Chart

Gets the chart displayed in the report overview item.


ReportGenerationLog

Gets the log of errors, warnings, and informational messages associated with generating the report specified in the IAdmReportOverviewItem::Report property.


DataRetrievalLog

Gets the log of errors, warnings, and informational messages associated with retrieving data necessary to build a chart for the report overview item.


ChartLog

Gets the log of errors, warnings, and informational messages associated with building the chart.


ReportItemCount

Gets the total number of items in the report represented by the report overview item.

  • Type:
  • Int32
  • Access:
  • Read-only

Requirements

Minimum required version: 2018.1

See also