BackPrevious Topic  Next TopicNext

Banded Object Properties

This topic describes the properties of a Banded Object that you can use in page reports and web reports.

Designer provides some properties only when you use the object in certain report types. You can get details from the Available For column in the property table.

Property Name Available For Description
General
Class Type Query Page Report Shows the class type of the object. This property is read only.
Data Inherit Query Page Report Shows whether the object inherits dataset from another object. This property is read only.
Dataset Query Page Report Shows the dataset the object applies. This property is read only.
Instance Name Query Page Report Shows the instance name of the object. This property is read only.
Geometry
Auto Fit Page Report, Web Report Specifies whether to automatically adjust the width of a vertical banded object or the height of a horizontal banded object according to its content.

Data type: Boolean
Height Page Report, Web Report Designer enables this property for a horizontal banded object. You can use it to specify the height of the object. Type a numeric value to change the height.

Data type: Float
Width Page Report, Web Report Designer enables this property for a vertical banded object. You can use it to specify the width of the object. Type a numeric value to change the width.

Data type: Float
X Page Report, Web Report Specifies the horizontal coordinate of the top left corner of the object, relative to its parent container. Designer ignores this property if the object's Position is "static". Type a numeric value to change the position.

Data type: Float
Y Page Report, Web Report Specifies the vertical coordinate of the top left corner of the object, relative to its parent container. Designer ignores this property if the object's Position is "static". Type a numeric value to change the position.

Data type: Float
Color
Background Page Report, Web Report Specifies the background color of the object. Choose a color from the drop-down list or select Custom to customize a color in the Pick a Color dialog box, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For a page report, you can also use a formula or edit an expression to return a color.Data type: String
CSS
Class Page Report, Web Report Specifies the name of the Class Selector to apply to the object, which you define in the CSS file of the style the report applies.

For example, if you define the CSS file as follows:

@charset "GBK";
TextField {Background: #ff0000}
/*Style=LabelX*/
TextField[Style="LabelX"]{Background: #0000FF}
/*ID=W*/
TextField#W{Background: #FFFF00}
/*class=C*/
TextField.C{Background: #00FFFF}

To apply the Class Selector in the file to the object, type C in the value cell.

Data type: String
Style Page Report, Web Report Specifies the style you want to apply to the object. You can specify the style in two ways:
  • Type the style which should be an Attribute Selector whose attribute is "style" in the CSS file of the style the report applies. For example, to apply the style in the above sample CSS file to the object, type LabelX in the value cell.
  • Choose a style from the drop-down list if you have specified the Style Group property for the report tab or web report, and there are styles in the style group that are applicable to the object.

Data type: String
Others
Auto Scale in Number Page Report, Web Report Specifies whether to automatically scale the Number values in the object that fall into the two ranges:
  • When 1000 <= value < 10^15, Designer applies the following quantity unit symbols of the International System of Units 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, Designer uses scientific notation to scale the values.

Data type: Boolean
Cache Page Report, Web Report Specifies whether to cache the dataset for this object in the data buffer, so that other objects using the same dataset can share the data rather than perform their own SQL query.

Data type: Boolean
Default for Filter Page Report, Web Report Specifies whether to display the object as the default data component in the Apply To drop-down list of the Filter dialog box at runtime.

Data type: Boolean

Note icon In the same report, you can only set one data component's Default for Filter property to "true".
Enable Navigation Web Report Specifies whether to display scroll bars on the banded object in Web Report Studio, if the parent container cannot fully display its data. When you set this property to "true", you can further specify the height and width of the frame for holding the banded object via Navigation Height and Navigation Width.

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 you preview the report in Page Report Result for a page report or Web Report Result for a web report in Designer, and when users run the report at runtime.

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
Invisible Page Report, Web Report Specifies whether to hide the object in the design area and in the report result. Logi Report Engine performs all the calculations that involve the object regardless of whether the object is visible or not.

Data type: Boolean
Invisible for Filter Dialogs Page Report, Web Report Specifies whether to display the object in the Apply To drop-down list of the Filter dialog box at runtime. Designer disables this property when you set Default for Filter to "true".

Data type: Boolean
Navigation Height Web Report Specifies the height of the frame for holding the banded object. Type a numeric value to change the height. If you do not specify a value, Logi Report Engine calculates the height at runtime. This property takes effect when Enable Navigation is "true".

Data type: Float
Navigation Width Web Report Specifies the width of the frame for holding the banded object. Type a numeric value to change the width. If you do not specify a value, Logi Report Engine calculates the width at runtime. This property takes effect when Enable Navigation is "true".

Data type: Float
Position Page Report, Web Report Specifies the position of the object. Choose an option from the drop-down list.

Data type: Enumeration
Record Location Page Report, Web Report Specifies the calculation point for the properties of the object that are controlled by formulas. This property takes effect only when the object is in a banded object. Choose an option from the drop-down list.
  • default - Select to calculate the values of the properties in the default location where the object is placed.
  • page header - Select to calculate the values of the properties in the banded page header panel.
  • page footer - Select to calculate the values of the properties in the banded page footer panel.

For more information, see Example 2: Showing a Label on Every Page Except the Last.

Data type: Enumeration

Suppress Page Report, Web Report Specifies whether to suppress the object in the design area and in the report result. If you suppress an object, Logi Report Engine skips all formulas and calculations that involve the object.

Data type: Boolean

Note icon When you set both the Invisible and Suppress properties of an object to "true", Suppress has the higher priority.
Suppress When Empty Page Report, Web Report Specifies whether to display the object in the report result if no record is returned to it.

Data type: Boolean
Suppress When No Records Page Report, Web Report Specifies whether to exclude the object in the report result when no record is returned to its parent data component.

Data type: Boolean
Excel
Column Index Page Report, Web Report Specifies the X coordinate of the object relative to its parent container in the Excel and CSV outputs of the report, measured in cells. This property takes effect only when the Columned property of the report tab or web report is "true" and Position of the object is not "static".

Data type: Integer
Row Index Page Report, Web Report Specifies the Y coordinate of the object relative to its parent container in the Excel and CSV outputs of the report, measured in cells. This property takes effect only when the Columned property of the report tab or web report is "true" and Position of the object is not "static".

Data type: Integer
Border
Border Color Page Report, Web Report Specifies the color for the border of the object. Choose a color from the drop-down list or select Custom to customize a color in the Pick a Color dialog box, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For a page report, you can also use a formula or edit an expression to return 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.
  • miter - Select to join path segments by extending their outside edges until they meet.
  • round - Select to join path segments by rounding off the corner at a radius of half the line width.

Data type: Enumeration
Border Thickness Page Report, Web Report Specifies the width for the border of the object. Type a numeric value to change the thickness.

Data type: Float
Bottom Line Page Report, Web Report Specifies the line style for the bottom border of the object. Choose an option from the drop-down list.

Data type: Enumeration
Left Line Page Report, Web Report Specifies the line style for the left border of the object. Choose an option from the drop-down list.

Data type: Enumeration
Radius Page Report, Web Report Specifies the radius for the joint of the border lines, which takes effect when Border Joint is "round". Type a numeric value to change the radius.

Data type: Integer
Right Line Page Report, Web Report Specifies the line style for the right border of the object. Choose an option from the drop-down list.

Data type: Enumeration
Top Line Page Report, Web Report Specifies the line style for the top border of the object. Choose an option from the drop-down list.

Data type: Enumeration
TOC
Anchor Display Value Page Report, Web Report Specifies the string you want to display as the object's entry in the TOC of the report, which takes effect when the object's TOC Anchor property is "true".

Data type: String
TOC Anchor Page Report, Web Report Specifies whether to include the object in the TOC of the report.

Data type: Boolean
Accessibility
External CSS Class Selector Query Page Report Specifies the name of the Class Selector for the object in the HTML output of the report.

Data type: String
External ID Query Page Report This property is mapped to the HTML attribute id, as specified by w3.org.

Data type: String
Language Query Page Report This property is mapped to the HTML attribute lang, as specified by w3.org.

Data type: String

Back to top

BackPrevious Topic  Next TopicNext