Skip to main content

Banded Header Properties

  • Updated

BackPrevious Topic  Next TopicNext

Banded Header Properties

This topic describes the properties of a Banded Header object.

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 NameAvailable ForDescription
General
Class TypeQuery Page ReportShows the class type of the object. This property is read only.
Data InheritQuery Page ReportShows whether the object inherits dataset from another object. This property is read only.
DatasetQuery Page ReportShows the dataset the object applies. This property is read only.
Instance Name Query Page ReportShows the instance name of the object. This property is read only.
Geometry
HeightPage Report, Web ReportSpecifies the height of the object. Type a numeric value to change the height.

Data type: Float

WidthPage Report, Web ReportSpecifies the width of the object. Type a numeric value to change the width.

Data type: Float

Color
BackgroundPage Report, Web ReportSpecifies the background color or fill effect of the object. Choose a color from the drop-down list or select Custom to customize a color in the color palette. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

CSS
ClassPage Report, Web ReportSpecifies 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

StylePage Report, Web ReportSpecifies 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 preceding 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
Cross PagePage Report, Web ReportSpecifies whether the panel can be split across a page break.
  • true
    Select to split the panel across a page break when it exceeds the page height.
  • false
    Select to display the panel on the next page when it spans a large space vertically and cannot completely show on a page.

This property cannot take effect if you disable Page Layout for the report, meaning, the report is in continuous page mode.

Data type: Boolean

Export to CSVPage Report, Web ReportSpecifies whether to include the object in the CSV output.

Data type: Boolean

Export to ExcelPage Report, Web ReportSpecifies whether to include the object in the Excel output.

Data type: Boolean

Export to HTMLPage Report, Web ReportSpecifies whether to include the object in the HTML output.

Data type: Boolean

Export to PDFPage Report, Web ReportSpecifies whether to include the object in the PDF output.

Data type: Boolean

Export to PostScriptPage Report, Web ReportSpecifies whether to include the object in the PostScript output.

Data type: Boolean

Export to Report ResultPage Report, Web ReportSpecifies whether to include the object when you preview the report in the Page Report Result format for a page report or Web Report Result for a web report in Designer, and when users run the report in the same format at runtime.

Data type: Boolean

Export to RTFPage Report, Web ReportSpecifies whether to include the object in the RTF output.

Data type: Boolean

Export to TextPage Report, Web ReportSpecifies whether to include the object in the Text output.

Data type: Boolean

Export to XMLPage Report, Web ReportSpecifies whether to include the object in the XML output.

Data type: Boolean

Fill Whole PagePage Report, Web ReportSpecifies whether to extend the panel to the page bottom in the report, so that the next panel starts on a new page.

Data type: Boolean

InvisiblePage Report, Web ReportSpecifies whether to hide the object in the design area and in the report. Logi Report Engine performs all calculations that involve the object regardless of whether the object is visible or not.

Data type: Boolean

LabelPage Report, Web ReportSpecifies the tool tip you want to display for the panel when you hover over the left edge of the panel in the design area. Type a string to change the label.

Data type: String

Merge to Next PanelPage Report, Web ReportSpecifies whether to merge the panel into the next panel in the Excel output.

Data type: Boolean

On New PagePage Report, Web ReportSpecifies whether to start the panel on a new page in the report. Default (the property being "false") is starting the panel on a new page only when the previous page is filled. This property cannot take effect if you disable Page Layout for the report, meaning, the report is in continuous page mode.

Data type: Boolean

Record LocationPage Report, Web ReportSpecifies 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 values of the properties in the default location where the object is placed.
  • page header
    Select to calculate values of the properties in the banded page header panel.
  • page footer
    Select to calculate 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

Show Bottom LineQuery Page ReportSpecifies whether to add a horizontal line at the bottom of the panel in the report.

Data type: Boolean

SuppressPage Report, Web ReportSpecifies whether to suppress the object in the design area and in the report. If you suppress an object, Logi Report Engine skips all formulas and calculations that involve the object. This property has higher priority over Invisible.

Data type: Boolean

Suppress Blank PanelPage Report, Web ReportSpecifies whether to suppress the panel in the report when it contains no data.

Data type: Boolean

Suppress When No RecordsPage Report, Web ReportSpecifies whether to suppress the object in the report when no record is returned to its parent data component.

Data type: Boolean

UnderlayPage Report, Web ReportSpecifies whether to layer the panel beneath the next panel of the banded object in the report. You can use a panel layered beneath a subsequent panel to contain a background image or watermark.

Data type: Boolean

Border
Border ColorPage Report, Web ReportSpecifies 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. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Border JointPage Report, Web ReportSpecifies 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 ThicknessPage Report, Web ReportSpecifies the width for the border of the object. Type a numeric value to change the thickness.

Data type: Float

Bottom LinePage Report, Web ReportSpecifies the line style for the bottom border of the object. Choose an option from the drop-down list.

Data type: Enumeration

Left LinePage Report, Web ReportSpecifies the line style for the left border of the object. Choose an option from the drop-down list.

Data type: Enumeration

RadiusPage Report, Web ReportSpecifies the radius for the joint of the border lines. This property takes effect when you set Border Joint of the object to "round". Type a numeric value to change the radius.

Data type: Integer

Right LinePage Report, Web ReportSpecifies the line style for the right border of the object. Choose an option from the drop-down list.

Data type: Enumeration

Top LinePage Report, Web ReportSpecifies the line style for the top border of the object. Choose an option from the drop-down list.

Data type: Enumeration

Accessibility
External CSS Class SelectorQuery Page ReportSpecifies the name of the Class Selector for the object in the HTML output.

Data type: String

External IDQuery Page ReportThis property is mapped to the HTML attribute id, as specified by w3.org.

Data type: String

LanguageQuery Page ReportThis property is mapped to the HTML attribute lang, as specified by w3.org.

Data type: String

BackPrevious Topic  Next TopicNext