Skip to main content

Banded Object

  • Updated

BackPrevious Topic  Next TopicNext

Banded Object

The properties of a banded object are as follows. A banded object can have the following child objects: Banded Footer, Banded Header, Banded Page Footer, Banded Page Header, Banded Page Panel, Detail Panel, Group Footer Panel, Group Header Panel, and Group Panel.

Property NameDescription
General
Data InheritIndicates whether the dataset for this object is inherited from another object. This property is read only.
Display NameSpecifies the display name of the object.

Data type: String

Instance NameShows the instance name of the object. This property is read only.
Geometry
HeightShows the height of the object, in inches. This property is read only.

Data type: Float

WidthSpecifies the width of the object, in inches. Enter a numeric value to change the width.

Data type: Float

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

Data type: Float

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

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

Data type: String

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

Data type: String

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

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

Others
Auto Scale in NumberSpecifies whether to automatically scale the values that are of the Number data type in the object when the values fall into the two ranges:
  • When 1000 <= value < 10^15, the following quantity unit symbols of the International System of Units are used to scale the values: K (10^3), M (10^6), G (10^9), and T (10^12).
  • When 0 < value < 0.001 or value >= 10^15, scientific notation is used to scale the values.

Data type: Boolean

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

Enable NavigationSpecifies whether to enable page navigation on the banded object. If it is set to true, if the banded object contains more than one page, a page navigation bar specific for the banded object 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 banded object to display multiple pages, by setting the two properties Navigation Height and Navigation Width. If you later resize the banded object, the two properties will be reset to the resized values.

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 in Web Report Studio or when the report is opened in Web 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 or hide the object. All formulas and calculations will still be performed if the property is set to true. You can also use a formula to control whether or not to show the object.

Data type: Boolean

Navigation HeightSpecifies the height of the page for the banded object to display multiple pages. Enter a numeric value to specify the height. If no value is given here, Logi JReport will calculate the banded object page height. This property takes effect when Enable Navigation is set to true.

Data type: Float

Navigation WidthSpecifies the width of the page for the banded object to display multiple pages. Enter a numeric value to specify the width. If no value is given here, Logi JReport will calculate the banded object page width. This property takes effect when Enable Navigation is set to true.

Data type: Float

PositionSpecifies the position of the object. Available when the object is directly contained in the report body or a tabular cell.
  • absolute - The object's position will be decided by its X and Y property values.
  • static - The object will be positioned at the default location in its container. If selected, the X, Y and other position-related properties will be hidden or disabled.

Data type: Enumeration

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

SuppressSpecifies whether to show the object in the report. All formulas and calculations will be skipped if the property is set to true. You can also use a formula to dynamically control whether or not to show the object.

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 result when no record is returned to it.

Data type: Boolean

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

Data type: Boolean

 

BackPrevious Topic  Next TopicNext

Related articles