Skip to main content

Page Header Panel Properties

  • Updated

BackPrevious Topic Next TopicNext

Page Header Panel Properties

This topic lists the properties of a Page Header Panel object. The availabilities of the properties vary for the supported report types: Page Report and Web Report.

Property NameAvailable ForDescription
General
Class TypePage Report, Web ReportIndicates the class type of the object. This property is read only.
Data InheritQuery Page ReportIndicates whether the dataset for this object is inherited from another object. This property is read only.
DatasetQuery Page ReportIndicates the dataset used by the object. This property is read only.
Instance Name Query Page ReportShows the instance name of the object. This property is read only.
Geometry
HeightPage Report, Web ReportSpecifies the height of the object. Enter a numeric value to change the height.

Data type: Float

WidthPage Report, Web ReportDisplays the width of the object. This property is read only.
Color
BackgroundPage Report, Web ReportSpecifies the background color and fill effect of the object. Choose a color from the drop-down list or select Custom to customize a color, or enter a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.

Data type: String

CSS
ClassPage Report, Web ReportSpecifies a CSS class to be applied to the object which is a valid class in the CSS file.

Data type: String

StylePage Report, Web ReportThe property can be used in two ways.
  • Specifies a style to be applied to the object. Choose a style from the drop-down list which is available when a Style Group has been selected at the page report tab or web report level and when there are styles in the Style Group that can be applied to the object, or type in the style name.
  • Specifies a CSS selector to be applied to the object. Enter a valid class name from the CSS file.

Data type: String

Others
Export to CSVPage Report, Web ReportSpecifies whether to include the object in the CSV result of the report.

Data type: Boolean

Export to ExcelPage Report, Web ReportSpecifies whether to include the object in the Excel result of the report.

Data type: Boolean

Export to HTMLPage Report, Web ReportSpecifies whether to include the object in the HTML result of the report.

Data type: Boolean

Export to PDFPage Report, Web ReportSpecifies whether to include the object in the PDF result of the report.

Data type: Boolean

Export to PostScriptPage Report, Web ReportSpecifies whether to include the object in the PostScript result of the report.

Data type: Boolean

Export to Report ResultPage Report, Web ReportSpecifies whether to include the object when previewing the report in Page/Web Report Result and running the report in Page/Web Report Studio.

Data type: Boolean

Export to RTFPage Report, Web ReportSpecifies whether to include the object in the RTF result of the report.

Data type: Boolean

Export to TextPage Report, Web ReportSpecifies whether to include the object in the Text result of the report.

Data type: Boolean

Export to XMLPage Report, Web ReportSpecifies whether to include the object in the XML result of the report.

Data type: Boolean

InvisiblePage Report, Web ReportSpecifies whether to show the object in the design area and in the report result. All formulas and calculations will still be performed if the property is set to true.

Data type: Boolean

Record LocationPage Report, Web ReportSpecifies the calculation point for the properties of the object which are controlled by formulas. Choose an option from the drop-down list.
  • Default - The values of the properties are calculated in the default location where they are located.
  • Page Header - The values of the properties are calculated in the page header.
  • Page Footer - The values of the properties are calculated in the page footer.

Data type: Enumeration

Show Bottom LineQuery Page ReportSpecifies whether to include a horizontal line at the bottom of the panel. The default is false, which means that no horizontal line appears at the bottom of the panel.

Data type: Boolean

SuppressPage Report, Web ReportSpecifies whether to show the object in the design area and in the report result. All formulas and calculations will be skipped if the property is set to true. Not supported in Web Report Studio.

Data type: Boolean

Note: When both the Invisible and Suppress properties of an object are set to true, Suppress has the higher priority.

Suppress Blank PanelPage Report, Web ReportSpecifies whether a panel with no data is included in the report result. The default is false which means an empty panel is shown.

Data type: Boolean

Suppress When No RecordsPage Report, Web ReportSpecifies whether to display the object in the report result when no record is returned to its parent data component. Not supported in Web Report Studio.

Data type: Boolean

UnderlayPage Report, Web ReportSpecifies whether the panel will be layered beneath the next panel in the banded object. A panel layered beneath a subsequent panel can be used to contain a background picture or watermark. Banded page header, page footer, or group footer panels cannot be layered. The default is false which means that the panel is not layered beneath the next panel.

Data type: Boolean

Border
Border ColorPage Report, Web ReportSpecifies the color of the border of the object. Choose a color from the drop-down list or select Custom to customize a color, or enter a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.

Data type: String

Border JointPage Report, Web ReportSpecifies the joint style for the border lines of the object. Choose an option from the drop-down list.
  • miter - Joins path segments by extending their outside edges until they meet.
  • round - Joins path segments by rounding off the corner at a radius of half the line width.

Data type: Enumeration

Border ThicknessPage Report, Web ReportSpecifies the width of the border of the object. Enter a numeric value to change the thickness.

Data type: Float

Bottom LinePage Report, Web ReportSpecifies the line style of the bottom border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Left LinePage Report, Web ReportSpecifies the line style of the left border of the object. Choose a style from the drop-down list.

Data type: Enumeration

RadiusPage Report, Web ReportSpecifies the radius for the border line joint of the object. This property takes effect only when Border Joint is set to round.

Data type: Integer

Right LinePage Report, Web ReportSpecifies the line style of the right border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Top LinePage Report, Web ReportSpecifies the line style of the top border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Accessibility
External CSS Class SelectorQuery Page ReportSpecifies a class selector to be applied to the object when exported as HTML. Enter a valid class name from the CSS file.

Data type: String

External IDQuery Page ReportIt is mapped to the HTML attribute id. This attribute specifies a name to the object, which must be unique in the report.

Data type: String

External StyleQuery Page ReportIt is mapped to the HTML attribute style. This attribute specifies style information for the object.

Data type: String

LanguageQuery Page ReportIt is mapped to the HTML attribute lang. This attribute specifies the base language of the object's attribute values and text content.

Data type: String

BackPrevious Topic Next TopicNext