Table

The properties of a table are:

Property Name Description
General
Class Type Indicates the class type of the object. This property is read only.
Data Inherit Indicates whether the dataset for this object is inherited from another object. This property is read only.
Dataset Indicates the dataset used by the object. This property is read only.
Instance Name Shows the instance name of the object. This property is read only.
Geometry
Height Specifies the height of the object, in inches or centimeters. Enter a numeric value to change the height.

Data type: Float

Width Specifies the width of the object, in inches or centimeters. Enter a numeric value to change the width.

Data type: Float

X Specifies the horizontal coordinate of the top left corner of the object, relative to its parent container. This property is ignored if the Position property is set to static. Enter a numeric value to change the position in inches or centimeters.

Data type: Float

Y Specifies the vertical coordinate of the top left corner of the object, relative to its parent container. This property is ignored if the Position property is set to static. Enter a numeric value to change the position in inches or centimeters.

Data type: Float

Color
Background Specifies the background color of the object. Choose a color from the drop-down list, enter a hexadecimal RGB value (e.g. 0xff0000), choose a formula that returns a color, or select Custom from the drop-down list to specify the color.

Data type: String

CSS
Class Specifies a CSS class to be applied to the object which is a valid class in the CSS file.

Data type: String

Style 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 report tab 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
Auto Expands Specifies whether the objects in cells of the table will expand to their empty neighbouring cells horizontally when the actual size of the objects is bigger than the cells due to no enough column or page width for auto fit. This property requires that the property Auto Fit for the objects in the table cells is set to true.

Data type: Boolean

Note: The property does not apply to horizontal tables.

Cache Specifies whether to cache the dataset for this object in the data buffer so other objects which use the same dataset can share the data rather than perform their own SQL query.

Data type: Boolean

Enable Navigation Specifies whether to enable page navigation on the table. This property takes effect for web report and library component only. If it is set to true, when the web report/library component is opened in JReport Studio/JDashboard, if the table contains more than one page, a page navigation bar specific for the table will be available right below it. You can use the bar to view the desired pages.

When this property is set to true, you can further specify the height and width of the page for the table to display multiple pages, by setting the two properties Navigation Height and Navigation Width. If later JReport Studio users resize the table, the two properties will be reset to the resized values.

Data type: Boolean

Export to CSV Specifies whether to include the object when exporting the report to CSV.

Data type: Boolean

Export to DHTML Specifies whether to include the object when exporting the report to DHTML.

Data type: Boolean

Export to Excel Specifies whether to include the object when exporting the report to Excel.

Data type: Boolean

Freeze Field Specifies whether to disable fields from being selected in the design area.

Data type: Boolean

Horizontal Specifies whether to show the table in horizontal style.

Data type: Boolean

Invisible Specifies whether to show the object in the design area and in the report results. All formulas and calculations will still be performed if the property is set to true.

Data type: Boolean

Navigation Height When Enable Navigation is set to true, you can use this property to specify the height of the page for the table to display multiple pages. Enter a numeric value to specify the height. If no value is given here, JReport will calculate the table page height at run time.

Data type: Float

Navigation Width When Enable Navigation is set to true, you can use this property to specify the width of the page for the table to display multiple pages. Enter a numeric value to specify the width. If no value is given here, JReport will calculate the table page width at run time.

Data type: Float

Position Specifies the position of the object. Choose an option from the drop-down list.
  • static - The object is positioned at the location in which it is inserted. If selected, the X, Y and other position-related properties will be hidden or disabled. The position of the object is affected by preceding objects in the same container.
  • absolute - The object will be located at the position specified by dragging and dropping or by setting its X and Y property values. The position of the object is not affected by preceding objects in the same container.

Data type: Enumeration

Note: This property only affects objects with a parent container that is the report body, a tabular cell, or a text box.

Record Location Specifies the calculation point for the properties which use 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

Suppress Specifies whether to show the object in the design area and in the report results. All formulas and calculations will be skipped if the property is set to true. Not supported in web reports or library components.

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 Empty Specifies whether to display the object in the report results when no record is returned to it.

Data type: Boolean

Suppress When No Records Specifies whether to display the object in the report results when no record is returned to its parent data container. Not supported in web reports or library components.

Data type: Boolean

Border
Border Color Specifies the color of the border of the object. Choose a color from the drop-down list, enter a hexadecimal RGB value (0xCCAA00), choose a formula that returns a color, or select Custom from the drop-down list to specify the color.

Data type: String

Border Thickness Specifies the width of the border in inches or centimeters. Enter a numeric value to change the thickness.

Data type: Float

Bottom Line Specifies the line style of the bottom border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Left Line Specifies the line style of the left border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Right Line Specifies the line style of the right border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Top Line Specifies the line style of the top border of the object. Choose a style from the drop-down list.

Data type: Enumeration

TOC
Anchor Display Value Specifies a string or formula to display for the TOC entry for this object in the TOC Browser. By default it is the value of the specified object. The TOC Anchor property must be set to true for this property to take effect.

Data type: String

TOC Anchor Specifies whether to include the object in the TOC Browser for the report.

Data type: Boolean

Accessibility
External CSS Class Selector Specifies 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 ID 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

External Style It is mapped to the HTML attribute style. This attribute specifies style information for the object.

Data type: String

Summary It is mapped to the HTML attribute summary. This attribute provides a summary of the object's purpose and structure.

Data type: String

The following topics list properties of the children of a table: