Previous Topic
Banded Header Properties
This topic lists the properties of a Banded Header object. The availabilities of the properties vary for the supported report types: Page Report and Web Report.
| Property Name | Available For | Description |
|---|---|---|
| General | ||
| Class Type | Query Page Report | Indicates the class type of the object. This property is read only. |
| Data Inherit | Query Page Report | Indicates whether the dataset for this object is inherited from another object. This property is read only. |
| Dataset | Query Page Report | Indicates the dataset used by the object. This property is read only. |
| Instance Name | Query Page Report | Shows the instance name of the object. This property is read only. |
| Geometry | ||
| Height | Page Report, Web Report | Specifies the height of the object. Type a numeric value to change the height.
Data type: Float |
| Width | Page Report, Web Report | Specifies the width of the object. Type a numeric value to change the width.
Data type: Float |
| Color | ||
| Background | Page Report, Web Report | Specifies the background color and fill effect of the object. Choose a color from the drop-down list or select Custom to customize a color. You can also use a formula or edit an expression that returns a color, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color.
Data type: String |
| CSS | ||
| Class | Page Report, Web Report | Specifies a CSS class to be applied to the object which is a valid class in the CSS file.
Data type: String |
| Style | Page Report, Web Report | The property can be used in two ways.
Data type: String |
| Others | ||
| Cross Page | Page Report, Web Report | Specifies whether the panel can be split across a page break.
This property is applied only when the report has page layout enabled. Data type: Boolean |
| Export to CSV | Page Report, Web Report | Specifies whether to include the object in the CSV output of the report.
Data type: Boolean |
| Export to Excel | Page Report, Web Report | Specifies whether to include the object in the Excel output of the report.
Data type: Boolean |
| Export to HTML | Page Report, Web Report | Specifies whether to include the object in the HTML output of the report.
Data type: Boolean |
| Export to PDF | Page Report, Web Report | Specifies whether to include the object in the PDF output of the report.
Data type: Boolean |
| Export to PostScript | Page Report, Web Report | Specifies whether to include the object in the PostScript output of the report.
Data type: Boolean |
| Export to Report Result | Page Report, Web Report | Specifies 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 RTF | Page Report, Web Report | Specifies whether to include the object in the RTF output of the report.
Data type: Boolean |
| Export to Text | Page Report, Web Report | Specifies whether to include the object in the Text output of the report.
Data type: Boolean |
| Export to XML | Page Report, Web Report | Specifies whether to include the object in the XML output of the report.
Data type: Boolean |
| Fill Whole Page | Page Report, Web Report | Specifies whether to make the panel extended to the bottom of the page, so that the next panel starts on a new page.
Data type: Boolean |
| Invisible | Page Report, Web Report | Specifies 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 |
| Label | Page Report, Web Report | Specifies the popup text displayed when the mouse pointer hovers over the left edge of the panel.
Data type: String |
| Merge to Next Panel | Page Report, Web Report | Specifies whether to merge the panel into the next panel in the Excel output.
Data type: Boolean |
| On New Page | Page Report, Web Report | Specifies whether the panel starts on a new page. This property is applied only when the report has page layout enabled. The default is false which means the panel starts on a new page only if the Previous Topic is filled.
Data type: Boolean |
| Record Location | Page Report, Web Report | Specifies the calculation point for the properties of the object which are controlled by formulas. Choose an option from the drop-down list.
Data type: Enumeration |
| Show Bottom Line | Query Page Report | Specifies 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 |
| Suppress | Page Report, Web Report | Specifies 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.
Data type: Boolean
|
| Suppress Blank Panel | Page Report, Web Report | Specifies 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 Records | Page Report, Web Report | Specifies whether to display the object in the report result when no record is returned to its parent data component.
Data type: Boolean |
| Underlay | Page Report, Web Report | Specifies 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 Color | Page Report, Web Report | Specifies the color of the border of the object. Choose a color from the drop-down list or select Custom to customize a color. You can also use a formula or edit an expression that returns a color, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color.
Data type: String |
| Border Joint | Page Report, Web Report | Specifies the joint style for the border lines of the object. Choose an option from the drop-down list.
Data type: Enumeration |
| Border Thickness | Page Report, Web Report | Specifies the width of the border. Type a numeric value to change the border thickness.
Data type: Float |
| Bottom Line | Page Report, Web Report | Specifies the line style of the bottom border of the object. Choose a style from the drop-down list.
Data type: Enumeration |
| Left Line | Page Report, Web Report | Specifies the line style of the left border of the object. Choose a style from the drop-down list.
Data type: Enumeration |
| Radius | Page Report, Web Report | Specifies 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 Line | Page Report, Web Report | Specifies the line style of the right border of the object. Choose a style from the drop-down list.
Data type: Enumeration |
| Top Line | Page Report, Web Report | Specifies 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 Selector | Query Page Report | Specifies a class selector to be applied to the object when exported as HTML. Type a valid class name from the CSS file.
Data type: String |
| External ID | Query Page Report | It 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 |
| Language | Query Page Report | It 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 |
When you set both the Invisible and Suppress properties of an object to true, Suppress has the higher priority.