Skip to content

IAdmReportDocumentGeneralSettings

The IAdmReportDocumentGeneralSettings interface is used to manage settings common for all report documents. For example, you can select an image (e.g. your company logo) to be displayed in the documents header and specify the documents footer.

Inheritance: The IAdmReportDocumentGeneralSettings interface inherits from the IAdmTop interface.

Note

To get the IAdmReportDocumentGeneralSettings interface, you need to bind to the Reports container using the “ReportsRoot”alias.

Properties

  • Property

  • Description

  • IsHeaderImageEnabled

  • Gets or sets a value indicating whether report documents contain an image in the header.

  • HeaderImage

  • Gets or sets an image to be displayed in the report document header.

  • DefaultHeaderImage

  • Gets the default header image for report documents.

  • HeaderImageAlignment

  • Gets or sets a value indicating how to align the header image in report documents.

  • FontName

  • Gets or sets the name of the font used in report documents.

  • TitleColor

  • Gets or sets a color of the report document title.

  • FooterText

  • Gets or sets a text of the report document footer.

Details

IsHeaderImageEnabled

Gets or sets a value indicating whether report documents contain an image in the header.

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

Remarks

To set an image, use the HeaderImage property.


HeaderImage

Gets or sets an image to be displayed in the report document header.

  • Type:
  • Byte[]
  • Access:
  • Read/Write

Remarks

  • If this property is not set, the image specified in the DefaultHeaderImage property is used.
  • This property is ignored if the IsHeaderImageEnabled property is set to FALSE.

DefaultHeaderImage

Gets the default header image for report documents.

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

HeaderImageAlignment

Gets or sets a value indicating how to align the header image in report documents.

Remarks

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


FontName

Gets or sets the name of the font used in report documents.

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

TitleColor

Gets or sets a color of the report document title.

  • 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.

FooterText

Gets or sets a text of the report document footer.

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

Requirements

Minimum required version: 2018.1

See also