Skip to content

IAdmReportChart

The IAdmReportChart is the base interface for all interfaces that represent report charts.

Inheritance: The IAdmReportChart interface inherits from the IUnknown interface.

Note

To create an instance of a report chart, use the IAdmReportConfiguration::CreateChart method.

Methods

Properties

  • Property

  • Description

  • Enabled

  • Gets or sets a value indicating whether chart is enabled for a report.

  • Type

  • Gets the type of the report chart.

  • Color

  • Gets or sets the default color of report chart items.

  • DisplayTotalCount

  • Gets or sets a value indicating whether to display the total number of values in the report chart.

  • Log

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

Details

GetInvolvedAdObjectProperties()

Returns an array of Active Directory properties used to build the report chart.

String[] GetInvolvedAdObjectProperties()

Enabled

Gets or sets a value indicating whether chart is enabled for a report.

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

Type

Gets the type of the report chart.


Color

Gets or sets the default color of report chart items. To specify a custom color for a report chart item, use the IAdmReportChartItem::Color property.

  • Type:
  • Int32
  • Access:
  • Read/Write

Remarks

The color is specified as an Int32 value with AARRGGBB byte-ordering, where each byte represents a color component. The most significant byte, represented by AA, is the alpha component value. This byte must be always 0. The bytes represented by RR, GG, and BB are the red, green, and blue color components respectively.

Examples

  • Red - 255
  • Yellow - 65535
  • Magenta - 16711935
  • Set the property value to -1 to use the default color.

DisplayTotalCount

Gets or sets a value indicating whether to display the total number of values in the report chart.

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

Log

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


Requirements

Minimum required version: 2018.1

See also