Skip to content

IAdmReportDocument

The IAdmReportDocument interface is used to generate and configure report documents.

Inheritance: The IAdmReportDocument interface inherits from the IUnknown interface.

Methods

Properties

  • Property

  • Description

  • Type

  • Gets the type of the report document.

  • UseCustomColumnSettings

  • Gets or sets a value indicating whether column settings specified in the Columns property must be used in the report document.

  • Columns

  • Gets settings of report document columns.

  • UseRawValues

  • Gets or sets a value indicating whether to display column values in the report document as raw data.

  • Log

  • Gets the log of errors, warnings, and informational messages associated with generating the report document.

Details

CreateDocument()

Creates a document based on the given report results.

Byte[] CreateDocument(IAdmReport report, 
                      IAdmReportArguments arguments,
                      IAdmListItems items, 
                      String customTitle)

Parameters

  • report - Specifies the report results of which are added to the document.
  • arguments - Specifies report arguments to be included into the document.
  • items - Specifies a list of report items to be included into the document.
  • customTitle - Specifies an optional title of the report document.

Type

Gets the type of the report document.


UseCustomColumnSettings

Gets or sets a value indicating whether column settings specified in the Columns property must be used in the report document.

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

Remarks

If this property is set to FALSE default column settings of the report are used.


Columns

Gets settings of report document columns.

Remarks

This property is ignored if the UseCustomColumnSettings property is set to FALSE.


UseRawValues

Gets or sets a value indicating whether to display column values in the report document as raw data.

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

Remarks

If this property is set to FALSE, column values in the report document are converted to human-readable form.


Log

Gets the log of errors, warnings, and informational messages associated with generating the report document.


Requirements

Minimum required version: 2018.1

See also