Skip to main content

Properties of Banded Object in Page Report

  • Updated

Previous Topic  Next Topic

Properties of Banded Object in Page Report

A banded object can have the following child objects: Banded Header Panel, Banded Page Panel, Banded Footer Panel and Banded Column Group.

The properties of a banded object in a page report are as follows:

Property NameDescription
General
Class TypeIndicates the class type of the object. This property is read only.
Data InheritIndicates whether the dataset for this object is inherited from another object. This property is read only.
DatasetIndicates 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
HeightSpecifies the height of the object. Enter a numeric value to change the height. Enabled when it is a horizontal banded object.

Data type: Float

WidthSpecifies the width of the object. Enter a numeric value to change the width. Enabled when it is a vertical banded object.

Data type: Float

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

Data type: Float

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

Data type: Float

Color
BackgroundSpecifies the background color 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 enter a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

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

Data type: String

StyleThe 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
CacheSpecifies 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

Default for FilterSpecifies whether to show the data component as the default component in the Apply to drop-down list of the Filter dialog in Page Report Studio.

Data type: Boolean

Note: In a page report tab, only one data component’s Default for Filter property can be set to true.

Export to AppletSpecifies whether to include the object when exporting the report to Applet.

Data type: Boolean

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

Data type: Boolean

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

Data type: Boolean

Export to HTMLSpecifies whether to include the object when exporting the report to HTML.

Data type: Boolean

Export to PDFSpecifies whether to include the object when exporting the report to PDF.

Data type: Boolean

Export to PostScriptSpecifies whether to include the object when exporting the report to PostScript.

Data type: Boolean

Export to Report ResultSpecifies whether to include the object when exporting the report to Report Result.

Data type: Boolean

Export to RTFSpecifies whether to include the object when exporting the report to RTF.

Data type: Boolean

Export to TextSpecifies whether to include the object when exporting the report to Text.

Data type: Boolean

Export to XMLSpecifies whether to include the object when exporting the report to XML.

Data type: Boolean

InvisibleSpecifies 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

Invisible for Filter DialogsSpecifies whether to show the data component in the Apply to drop-down list of the Filter dialog in Page Report Studio. This property cannot be edited when Default for Filter is set to true.

Data type: Boolean

PositionSpecifies 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

Record LocationSpecifies 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

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

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

Data type: Boolean

Suppress When No RecordsSpecifies whether to display the object in the report results when no record is returned to its parent data component.

Data type: Boolean

Excel
Column IndexSpecifies the X coordinate of the object relative to its parent container when exported to Excel or CSV, measured in cells. The Columned property at the report tab level must be set to true for this property to take effect.

Data type: Integer

Row IndexSpecifies the Y coordinate of the object relative to its parent container when exported to Excel or CSV, measured in cells. The Columned property at the report tab level must be set to true for this property to take effect.

Data type: Integer

Border
Border ColorSpecifies 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 enter a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Border Joint

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 ThicknessSpecifies the width of the border. Enter a numeric value to change the thickness.

Data type: Float

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

Data type: Enumeration

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

Data type: Enumeration

RadiusSpecifies 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 LineSpecifies the line style of the right border of the object. Choose a style from the drop-down list.

Data type: Enumeration

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

Data type: Enumeration

TOC
Anchor Display ValueSpecifies 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 AnchorSpecifies whether to include the object in the TOC Browser for the report.

Data type: Boolean

Accessibility
External CSS Class SelectorSpecifies 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 IDIt 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

LanguageIt 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

Column Index & Row Index

The two properties together provide a way for you to control the position of an object in the exported CSV or Excel file by specifying values to them.

However, Logi JReport has default values for them which is calculated based on the position of each object in the report. You can find the default values of the two properties right after you set the Columned property at the report tab level to true.

To make the specified values take effect when exporting the report to CSV or Excel, the following is necessary for both exporting formats:

  • First set the Columned property in report tab level to true, and then specify values to the two properties of the component.

More requirements for preview as Excel:

  • Make sure that the Export to Excel property of the component is set to true.

More requirements for Excel exporting:

  • Make sure that the Export to Excel property of the component is set to true.
  • When exporting the report to Excel, make sure Column Format is selected in the Export to Excel dialog.

More requirements for CSV exporting:

  • Make sure that the Export to CSV property of the component is set to true.
  • When exporting the report to Text via dialog, do check the Delimited Format option.

Note: Preview as Text cannot support the specified values for the default setting of Delimited Format is unchecked and it is unconfigurable.

Previous Topic  Next Topic

Related articles