BackPrevious Topic Next TopicNext

Table Header Properties

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

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, Library Component Specifies the height of the object. Type a numeric value to change the height.

Data type: Float

Width Page Report, Web Report, Library Component Displays the width of the object. This property is read only.
Color
Background Page Report, Web Report, Library Component 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, or type 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
Class Page Report, Web Report, Library Component 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, Library Component The 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 or library component 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. Type a valid class name from the CSS file.

Data type: String

Others
Export to CSV Page Report, Web Report, Library Component Specifies whether to include the object in the CSV result of the report.

Data type: Boolean

Export to Excel Page Report, Web Report, Library Component Specifies whether to include the object in the Excel result of the report.

Data type: Boolean

Export to HTML Page Report, Web Report, Library Component Specifies whether to include the object in the HTML result of the report.

Data type: Boolean

Export to PDF Page Report, Web Report, Library Component Specifies whether to include the object in the PDF result of the report.

Data type: Boolean

Export to PostScript Page Report, Web Report, Library Component Specifies whether to include the object in the PostScript result of the report.

Data type: Boolean

Export to Report Result Page Report, Web Report, Library Component Specifies whether to include the object when previewing the report in Page/Web Report Result and running the report in Page/Web Report Studio, or when the library component is used in JDashboard.

Data type: Boolean

Export to RTF Page Report, Web Report, Library Component Specifies whether to include the object in the RTF result of the report.

Data type: Boolean

Export to Text Page Report, Web Report, Library Component Specifies whether to include the object in the Text result of the report.

Data type: Boolean

Export to XML Page Report, Web Report, Library Component Specifies whether to include the object in the XML result of the report.

Data type: Boolean

Fill Whole Page Page Report, Web Report, Library Component Specifies whether to make the row extended to the bottom of the page, so that the next row starts on a new page.

Data type: Boolean

Invisible Page Report, Web Report, Library Component Specifies whether to show the object in the design area and in the results. All formulas and calculations will still be performed if the property is set to true.

Data type: Boolean

Label Page Report Specifies the popup text displayed when the mouse pointer hovers over the left edge of the row.

Data type: String

On New Page Page Report, Web Report, Library Component Specifies whether the row starts on a new page. This property is applied only when the report has page layout enabled. The default is false which means the row starts on a new page only if the Previous Topic is filled.

Data type: Boolean

Record Location Page Report, Web Report, Library Component Specifies 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

Repeat Header for Excel Page Report, Web Report, Library Component Specifies whether to make the object appear in every page of the report's Excel result.

Data type: Boolean

Repeat Header for TXT Page Report, Web Report, Library Component Specifies whether to make the object appear in every page of the report's Text result.

Data type: Boolean

Repeat Header for XML Page Report, Web Report, Library Component Specifies whether to make the object appear in every page of of the report's XML result.

Data type: Boolean

Repeat on Pages Page Report, Web Report, Library Component Specifies whether to make the object appear in every page of the report result.

Data type: Boolean

Suppress Page Report, Web Report, Library Component Specifies whether to show the object in the design area and in the result. All formulas and calculations will be skipped if the property is set to true.

Data type: Boolean

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

Suppress When No Records Page Report, Web Report, Library Component Specifies whether to display the object in theresults when no record is returned to its parent data component.

Data type: Boolean

Border
Border Color Page Report, Web Report, Library Component Specifies the color of the border of the object. Choose a color from the drop-down list or select Custom to customize a color, or type 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 Joint Page Report, Web Report, Library Component Specifies 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 Thickness Page Report, Web Report, Library Component Specifies the width of the border. Type a numeric value to change the thickness.

Data type: Float

Bottom Line Page Report, Web Report, Library Component 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, Library Component 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, Library Component 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, Library Component 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, Library Component 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

Note: For the Table Header object in web reports and library components, only the properties available in the Web Report Studio Inspector panel can be rendered in Web Report Studio and JDashboard.

Back to top

BackPrevious Topic Next TopicNext