Skip to main content

Group Header Panel Properties

  • Updated

BackPrevious Topic Next TopicNext

Group Header Panel Properties

This topic lists the properties of a Group Header Panel object in a banded object. The availabilities of the properties vary for the supported report types: Page Report and Web Report.

Property NameAvailable ForDescription
General
Class TypeQuery Page ReportIndicates the class type of the object. This property is read only.
Data InheritQuery Page ReportIndicates whether the dataset for this object is inherited from another object. This property is read only.
DatasetQuery Page ReportIndicates the dataset used by the object. 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 and fill effect 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 type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

CSS
ClassPage Report, Web ReportSpecifies a CSS class to be applied to the object which is a valid class in the CSS file.

Data type: String

StylePage Report, Web ReportThe 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. Type a valid class name from the CSS file.

Data type: String

Others
Cross PagePage Report, Web ReportSpecifies whether the panel can be split across a page break.
  • If false, the panel will be shown in the Next Topic when it spans a large space vertically and cannot be wholly shown in a page.
  • If true, the panel will be split across a page break when it exceeds the page height.

This property is applied only when the report has page layout enabled.

Data type: Boolean

Export to CSVPage Report, Web ReportSpecifies whether to include the object in the CSV result of the report.

Data type: Boolean

Export to ExcelPage Report, Web ReportSpecifies whether to include the object in the Excel result of the report.

Data type: Boolean

Export to HTMLPage Report, Web ReportSpecifies whether to include the object in the HTML result of the report.

Data type: Boolean

Export to PDFPage Report, Web ReportSpecifies whether to include the object in the PDF result of the report.

Data type: Boolean

Export to PostScriptPage Report, Web ReportSpecifies whether to include the object in the PostScript result of the report.

Data type: Boolean

Export to Report ResultPage Report, Web ReportSpecifies whether to include the object when previewing the report in Page/Web Report Result and running the report in Page/Web Report Studio.

Data type: Boolean

Export to RTFPage Report, Web ReportSpecifies whether to include the object in the RTF result of the report.

Data type: Boolean

Export to TextPage Report, Web ReportSpecifies whether to include the object in the Text result of the report.

Data type: Boolean

Export to XMLPage Report, Web ReportSpecifies whether to include the object in the XML result of the report.

Data type: Boolean

Fill Whole PagePage Report, Web ReportSpecifies whether to make the panel extended to the bottom of the page, so that the next panel starts on a new page.

Data type: Boolean

InvisiblePage Report, Web ReportSpecifies whether to show the object in the design area and in the report result. All formulas and calculations will still be performed if the property is set to true.

Data type: Boolean

LabelPage Report, Web ReportSpecifies the popup text displayed when the mouse pointer hovers over the left edge of the panel.

Data type: String

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

Data type: Boolean

On New PagePage Report, Web ReportSpecifies whether the panel starts on a new page. This property is only applied if the report has page layout enabled. The default is false which means the panel starts on a new page only if the Previous Topic is filled.

Data type: Boolean

Record LocationPage Report, Web ReportSpecifies 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

Remove Blank RowPage Report, Web ReportSpecifies whether to remove blank rows in the panel in the exported Excel file.

Data type: Boolean

RepeatPage Report, Web ReportSpecifies whether to make the group header appear in every page.

Data type: Boolean

Repeat in Detail PanelPage Report, Web ReportSpecifies whether to make the objects in the panel repeated in the detail panel in the exported Excel file.

Data type: Boolean

Show Bottom LineQuery Page ReportSpecifies whether to include a horizontal line at the bottom of the panel. The default is false, which means that no horizontal line appears at the bottom of the panel.

Data type: Boolean

SuppressPage Report, Web ReportSpecifies whether to show the object in the design area and in the report result. 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 Blank PanelPage Report, Web ReportSpecifies whether a panel with no data is included in the report result. The default is false which means an empty panel is shown.

Data type: Boolean

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

Data type: Boolean

UnderlayPage Report, Web ReportSpecifies whether the panel will be layered beneath the next panel in the banded object. A panel layered beneath a subsequent panel can be used to contain a background picture or watermark. Banded page header, page footer, or group footer panels cannot be layered. The default is false which means that the panel is not layered beneath the next panel.

Data type: Boolean

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

Data type: Float

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

Data type: Enumeration

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

Data type: Enumeration

RadiusPage Report, Web ReportSpecifies 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 LinePage Report, Web ReportSpecifies the line style of the right border of the object. Choose a style from the drop-down list.

Data type: Enumeration

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

Data type: Enumeration

Accessibility
External CSS Class SelectorQuery Page ReportSpecifies a class selector to be applied to the object when exported as HTML. Type a valid class name from the CSS file.

Data type: String

External IDQuery Page ReportIt 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 StyleQuery Page ReportIt is mapped to the HTML attribute style. This attribute specifies style information for the object.

Data type: String

LanguageQuery Page ReportIt 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

On New Page

If you want each group to start on a new page, you have two approaches. One is to configure with group header panel as follows, the other is to set the Fill Whole Page property for the group footer panel.

There is a problem when you only set On New Page to be true for the group header panel. You will find that the first page will have no details. Logi Report Engine starts the detail panel from the second page. To solve this issue, you can use a formula to control this property. The formula will judge the property as being false for the first group, and being true for subsequent groups for displaying on a new page. However, if you feel this is too complicated, go to the group footer panel for the second approach.

  1. Create three formulas as follows:

    global:
    global integer i=0;

    groupHD:
    i=i+1;0

    FormulaControl:
    @groupHD;
    if (i>1)
    return true
    else
    return false

  2. Insert the formula global into the banded page header panel and assign it an initial value 0.
  3. Insert the formula groupHD into the group header panel so that for each group i will be calculated as i+1.
  4. Select the group header panel and use the formula FormulaControl to control its On New Page property. This formula will only return true for the property if i>1.

Repeat

The default value for Repeat is false. For one detail panel which spans a large space vertically to be shown in several pages, Logi Report support the Repeat property if you want to see the group header information in each page. When the Repeat property is set true and group headers are visible, the group headers will duplicate on every page.

Notes:

  • When a page split occurs in the bottom blank part of the detail panel (or margins in the detail panel) and the Cross Page property in the detail panel is set true, the output will be: repeated group header + a slice of blank detail panel + group footer. It appears as though the repeated group headers are followed only by group footers without any detail panel. In order to solve this problem, you can resize the detail panel.
  • If the Repeat property is set true in both outer group header and inner group header, Logi Report will treat the two group headers as a completely repeated object.
  • If the outer and inner group headers are set to be one completely repeated object, then when the page can only hold the group headers or has no enough space for the group headers, both outer and inner group headers will not be duplicated.
  • The Repeat property does not work for subreport.

BackPrevious Topic Next TopicNext