Skip to main content

Subreport Properties

  • Updated

BackPrevious Topic  Next TopicNext

Subreport Properties

This topic describes the properties of a Subreport object that you can use in page reports only.

Property NameDescription
General (available when the object is in a query-based page report)
Class TypeShows the class type of the object. This property is read only.
Data InheritShows whether the object inherits dataset from another object. This property is read only.
DatasetShows the dataset the object applies. 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. Type a numeric value to change the height.

Data type: Float

WidthSpecifies the width of the object. Type a numeric value to change the width.

Data type: Float

XSpecifies the horizontal coordinate of the object's top left corner, relative to its parent container, which Logi Report Engine applies when the object is not in static position in the container. Type a numeric value to change the coordinate.

Data type: Float

YSpecifies the vertical coordinate of the object's top left corner, relative to its parent container, which Logi Report Engine applies when the object is not in static position in the container. Type a numeric value to change the coordinate.

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

CSS
ClassSpecifies 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

StyleSpecifies 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 page report tab, and there are styles in the style group that are applicable to the object.

Data type: String

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

When you need to run the subreport in a report more than once, you can set the Cache property to "true". The data of the subreport is then cached in the data buffer, so the next time when you run the subreport, Logi Report Engine retrieves data from the data buffer instead of DBMS, and if the subreport contains sublinks, Logi Report also calculates them in the data buffer.

Note icon This property does not take effect when the subreport contains parameters, uses HDS, or applies dynamic query.

EmbeddedWhen this property is "false" (the default behavior), the page header and footer of the subreport do not display in the report.

Data type: Boolean

Export to CSVSpecifies whether to include the object in the CSV output.

Data type: Boolean

Export to ExcelSpecifies whether to include the object in the Excel output.

Data type: Boolean

Export to HTMLSpecifies whether to include the object in the HTML output.

Data type: Boolean

Export to PDFSpecifies whether to include the object in the PDF output.

Data type: Boolean

Export to PostScriptSpecifies whether to include the object in the PostScript output.

Data type: Boolean

Export to Report ResultSpecifies whether to include the object when you preview the report in the Page Report Result format in Designer, and when users run the report in the same format at runtime.

Data type: Boolean

Export to RTFSpecifies whether to include the object in the RTF output.

Data type: Boolean

Export to TextSpecifies whether to include the object in the Text output.

Data type: Boolean

Export to XMLSpecifies whether to include the object in the XML output.

Data type: Boolean

InvisibleSpecifies 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

Maximum Page NumberSpecifies the maximum number of pages for the subreport in the data buffer.

Data type: Integer

PositionDesigner enables this property when the object is in a flow layout container, such as the report body or a tabular cell, text box, or KPI. You can use it to specify the position of the object in the container. Choose an option from the drop-down list.

Data type: Enumeration

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

Records per PageSpecifies the number of records in each page for the subreport in the data buffer.

Data type: Integer

Subreport Data Source NameShows the name of the data source the subreport applies. The property value is blank when the subreport applies the default data source. This property is read only.
Subreport Query NameShows the name of the query the subreport uses. This property is read only.
Subreport Security NameShows the name of the data source security entry the subreport applies. This property is read only.
SuppressSpecifies 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 When EmptySpecifies whether to suppress the object in the report when no record is returned to it.

Data type: Boolean

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

Data type: Boolean

Excel
Column IndexDesigner displays this property when the object is in a query-based page report. You can use it to specify the X coordinate of the object relative to its parent container in the Excel and CSV outputs, measured in cells.

Data type: Integer

Note icon This property takes effect when you set Columned of the page report tab to "true" and Position of the object is not "static".

This image notes any new content for version 18.3 of the product. For more information please see the Release Notes or Enhancements topics.Customize Subreport Index FormatDesigner enables this property when you set On New Sheet to "true". You can use it to specify whether to enable customizing text format of the subreport links inside the primary report in the Excel output.

Data type: Boolean

On New SheetSpecifies whether to put the subreport in separate sheet in the Excel output. This property takes effect when you export the primary report to Excel using Report Format.
  • false
    Select to put the subreport in the same sheet together with the primary report.
  • true
    Select to put the subreport in separate sheet. You can specify the name of the sheet using the Sheet Name property.

When you set On New Sheet to "true", in the Excel output, the primary report is in the first sheet and there are links in it. You can select any link to go to the corresponding subreport in separate sheet and customize the text format of the links. When the subreport is divided into several pages, that is, you have defined page settings in the subreport, the links in the primary report are subreport1_0, subreport1_1, subreport1_2, and so on. You can select the links to view the corresponding part too.

Data type: Boolean

Row IndexDesigner displays this property when the object is in a query-based page report. You can use it to specify the X coordinate of the object relative to its parent container in the Excel and CSV outputs, measured in cells.

Data type: Integer

Note icon This property takes effect when you set Columned of the page report tab to "true" and Position of the object is not "static".

Sheet NameSpecifies the name of the new sheet in which to put the subreport in the Excel output. It is meaningful to specify the name when you set On New Sheet to "true", and you should make sure no other sheets apply this name.

Data type: String

Note icon Excel does not support using the following characters in the sheet name: "|", ":", "/", "?", "\", "*", "]", "[", and the single quotation mark (') as the last character in the sheet name. If you use any one of them in the value of the property, Excel replaces it by "_".

Sheet Name PostfixSpecifies how to add postfix number to the sheets containing the subreport in the Excel output. It is meaningful to specify this property when you set On New Sheet to "true". Choose an option from the drop-down list.
  • Add postfix number to every page
    Select to add the postfix number to every sheet for the subreport (Subreport1, Subreport2, Subreport3, Subreport4...).
  • Add postfix number only to additional pages
    Select to add the postfix number to the subreport sheets starting from the second one (Subreport, Subreport1, Subreport2, Subreport3...).

Data type: Enumeration

Designer enables the following index properties when you set Customize Subreport Index Format to "true".
This image notes any new content for version 18.3 of the product. For more information please see the Release Notes or Enhancements topics.Subreport Index Background Specifies the background color of the subreport links in the Excel output. 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

This image notes any new content for version 18.3 of the product. For more information please see the Release Notes or Enhancements topics.Subreport Index BoldSpecifies whether to apply bold formatting to the subreport links in the Excel output.

Data type: Boolean

This image notes any new content for version 18.3 of the product. For more information please see the Release Notes or Enhancements topics.Subreport Index Font FaceSpecifies the font face of the subreport index in the Excel output. Choose an option from the drop-down list.

Data type: Enumeration

This image notes any new content for version 18.3 of the product. For more information please see the Release Notes or Enhancements topics.Subreport Index Font SizeSpecifies the font size of the subreport links in the Excel output. Type an integer value to change the size.

Data type: Integer

This image notes any new content for version 18.3 of the product. For more information please see the Release Notes or Enhancements topics.Subreport Index ForegroundSpecifies the foreground color of the subreport links in the Excel output. 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

This image notes any new content for version 18.3 of the product. For more information please see the Release Notes or Enhancements topics.Subreport Index ItalicSpecifies whether to italicize the subreport index in the Excel links.

Data type: Boolean

This image notes any new content for version 18.3 of the product. For more information please see the Release Notes or Enhancements topics.Subreport Index UnderlineSpecifies whether to add a horizontal line under the subreport links in the Excel output.

Data type: Boolean

Border
Border ColorSpecifies 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 ThicknessSpecifies the width for the border of the object. Type a numeric value to change the thickness.

Data type: Float

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

Data type: Enumeration

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

Data type: Enumeration

Right LineSpecifies the line style for the right border of the object. Choose an option from the drop-down list.

Data type: Enumeration

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

Data type: Enumeration

TOC
Anchor Display ValueSpecifies the text you want to display as the object's TOC entry label. This property takes effect when you set TOC Anchor of the object to "true".

Data type: String

TOC AnchorSpecifies whether to include the object in the TOC of the report.

Data type: Boolean

Accessibility(available when the object is in a query-based page report)
External CSS Class SelectorSpecifies the name of the Class Selector for the object in the HTML output.

Data type: String

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

Data type: String

External StyleThis property is mapped to the HTML attribute style, as specified by w3.org.

Data type: String

LanguageThis property is mapped to the HTML attribute lang, as specified by w3.org.

Data type: String

BackPrevious Topic  Next TopicNext

Related articles