Skip to content

IAdmReportOverview

The IAdmReportOverview interface is used to configure and generate report overviews.

Inheritance: The IAdmReportOverview interface inherits from the IAdmTop interface.

Methods

Properties

  • Property

  • Description

  • OverviewName

  • Gets or sets a name of the report overview.

  • OverviewId

  • Gets the unique immutable identifier of the report overview.

  • MainReports

  • Gets or sets an array of items displayed in the Main section of the report overview.

  • SidebarReports

  • Gets or sets an array of items displayed in the Sidebar section of the report overview.

  • RelatedReports

  • Gets or sets an array of items displayed in the Related reports section of the report overview.

  • Disabled

  • Gets or sets a value indicating whether the report overview is disabled.

  • Categories

  • Gets or sets an array of categories the report overview is assigned to.

  • CategoryIDs

  • Gets unique identifiers of categories the report overview is assigned to.

  • CategoryGuids

  • Gets GUIDs of categories the report overview is assigned to.

Details

CreateBuilder()

Returns the IAdmReportOverviewBuilder interface used to build report overviews.

IAdmReportOverviewBuilder CreateBuilder()

Return value

If the user has no permission to view the report overview, the method throws the COMException exception with the E_ACCESSDENIED error code.


OverviewName

Gets or sets a name of the report overview.

  • Type:
  • String
  • Access:
  • Read/Write

OverviewId

Gets the unique immutable identifier of the report overview. The identifier does not change if you backup and restore Adaxes service configuration.

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

MainReports

Gets or sets an array of items displayed in the Main section of the report overview.


SidebarReports

Gets or sets an array of items displayed in the Sidebar section of the report overview.


RelatedReports

Gets or sets an array of items displayed in the Related reports section of the report overview.


Disabled

Gets or sets a value indicating whether the report overview is disabled.

  • Type:
  • Boolean
  • Access:
  • Read/Write

Categories

Gets or sets an array of categories the report overview is assigned to.


CategoryIDs

Gets unique identifiers of categories the report overview is assigned to.

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

CategoryGuids

Gets GUIDs of categories the report overview is assigned to.

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

Requirements

Minimum required version: 2018.1

See also