Subreport

The Subreport object is supported only in page reports that are created using query resources. It contains the following properties:

Property Name	Description
General
Class Type	Indicates the class type of the object. This property is read only.
Data Inherit	Indicates whether the dataset for this object is inherited from another object. This property is read only.
Dataset	Indicates the dataset used by the object. This property is read only.
Instance Name	Shows the instance name of the object. This property is read only.
Geometry
Height	Specifies the height of the object. Enter a numeric value to change the height. Data type: Float
Width	Specifies the width of the object. Enter a numeric value to change the width. Data type: Float
X	Specifies the horizontal coordinate of the top left corner of the object, relative to its parent container. This property is ignored if the Position property is set to static. Enter a numeric value to change the position. Data type: Float
Y	Specifies the vertical coordinate of the top left corner of the object, relative to its parent container. This property is ignored if the Position property is set to static. Enter a numeric value to change the position. Data type: Float
Color
Background	Specifies the background color 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 enter a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String
CSS
Class	Specifies a CSS class to be applied to the object which is a valid class in the CSS file. Data type: String
Style	The 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. Enter a valid class name from the CSS file. Data type: String
Others
Cache	Specifies 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
Embedded	If false, the page header and footer of the subreport will not be shown. Data type: Boolean
Export to CSV	Specifies whether to include the object in the CSV result of the report. Data type: Boolean
Export to Excel	Specifies whether to include the object in the Excel result of the report. Data type: Boolean
Export to HTML	Specifies whether to include the object in the HTML result of the report. Data type: Boolean
Export to PDF	Specifies whether to include the object in the PDF result of the report. Data type: Boolean
Export to PostScript	Specifies whether to include the object in the PostScript result of the report. Data type: Boolean
Export to Report Result	Specifies whether to include the object when previewing the report in Page Report Result and running the report in Page Report Studio. Data type: Boolean
Export to RTF	Specifies whether to include the object in the RTF result of the report. Data type: Boolean
Export to Text	Specifies whether to include the object in the Text result of the report. Data type: Boolean
Export to XML	Specifies whether to include the object in the XML result of the report. Data type: Boolean
Invisible	Specifies whether to show the object in the design area and in the report results. All formulas and calculations will still be performed if the property is set to true. Data type: Boolean
Maximum Page Number	Specifies the maximum number of pages in the data buffer. Data type: Integer
Position	Specifies the position of the object. Choose an option from the drop-down list. Data type: Enumeration
Record Location	Specifies the calculation point for the properties which use 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
Records per Page	Specifies the number of records in each page in the data buffer. Data type: Integer
Subreport Data Source Name	Displays the name of the data source used by the subreport. If nothing is displayed, the default data source will be used. This property is read only.
Subreport Query Name	Displays the name of the query used by the subreport. This property is read only.
Subreport Security Name	Displays the security name (record-level security) used by the subreport. This property is read only.
Suppress	Specifies whether to show the object in the design area and in the report results. 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 When Empty	Specifies whether to display the object in the report results when no record is returned to it. Data type: Boolean
Suppress When No Records	Specifies whether to display the object in the report results when no record is returned to its parent data component. Data type: Boolean
Excel
Column Index	Specifies the X coordinate of the object relative to its parent container when exported to Excel or CSV, measured in cells. The Columned property at the report tab level must be set to true for this property to take effect. Data type: Integer
On New Sheet	Specifies whether to put the subreport in a new sheet in the Excel result of the report. Data type: Boolean
Row Index	Specifies the Y coordinate of the object relative to its parent container in the Excel/CSV result of the report, measured in cells. The Columned property at the report tab level must be set to true for this property to take effect. Data type: Integer
Sheet Name	Specifies the name of the new sheet in which the subreport will be put in the exported Excel file. Make sure the name specified here isn't used by any other sheets. It is meaningful to specify the property value when On New Sheet is set to true. Data type: String Note: The characters "\|", ":", "/", "?", "\", "*", "]", "[" cannot be displayed in the sheet name in Excel and the last character in the sheet name cannot be single quotation mark ('). If any one of them is used when you specify the property, it will be replaced by "_" in Excel.
Sheet Name Postfix	Specifies how to add postfix number to the sheets in which the subreport will be put in the exported Excel file. Choose an option from the drop-down list. Add postfix number to every page - Specifies to add the postfix number to every sheet for the subreport (Subreport1, Subreport2, Subreport3, Subreport4...). Add postfix number only to additional pages - Specifies to add the postfix number to the subreport sheets starting from the second one (Subreport, Subreport1, Subreport2, Subreport3...). It is meaningful to specify the property value when On New Sheet is set to true. Data type: Enumeration
Border
Border Color	Specifies 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 enter a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String
Border Thickness	Specifies the width of the border. Enter a numeric value to change the thickness. Data type: Float
Bottom Line	Specifies the line style of the bottom border of the object. Choose a style from the drop-down list. Data type: Enumeration
Left Line	Specifies the line style of the left border of the object. Choose a style from the drop-down list. Data type: Enumeration
Right Line	Specifies the line style of the right border of the object. Choose a style from the drop-down list. Data type: Enumeration
Top Line	Specifies the line style of the top border of the object. Choose a style from the drop-down list. Data type: Enumeration
TOC
Anchor Display Value	Specifies a string or formula to display for the TOC entry for this object in the TOC Browser. By default it is the value of the specified object. The TOC Anchor property must be set to true for this property to take effect. Data type: String
TOC Anchor	Specifies whether to include the object in the TOC Browser for the report. Data type: Boolean
Accessibility
External CSS Class Selector	Specifies a class selector to be applied to the object when exported as HTML. Enter a valid class name from the CSS file. Data type: String
External ID	It 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 Style	It is mapped to the HTML attribute style. This attribute specifies style information for the object. Data type: String
Language	It 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

Property Name

Description

General

Class Type

Indicates the class type of the object. This property is read only.

Data Inherit

Indicates whether the dataset for this object is inherited from another object. This property is read only.

Dataset

Indicates the dataset used by the object. This property is read only.

Instance Name

Shows the instance name of the object. This property is read only.

Geometry

Height

Specifies the height of the object. Enter a numeric value to change the height.

Data type: Float

Width

Specifies the width of the object. Enter a numeric value to change the width.

Data type: Float

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

Data type: Float

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

Data type: Float

Color

Background

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

Data type: String

CSS

Class

Specifies a CSS class to be applied to the object which is a valid class in the CSS file.

Data type: String

Style

The 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. Enter a valid class name from the CSS file.

Data type: String

Others

Cache

Specifies 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

Embedded

If false, the page header and footer of the subreport will not be shown.

Data type: Boolean

Export to CSV

Specifies whether to include the object in the CSV result of the report.

Data type: Boolean

Export to Excel

Specifies whether to include the object in the Excel result of the report.

Data type: Boolean

Export to HTML

Specifies whether to include the object in the HTML result of the report.

Data type: Boolean

Export to PDF

Specifies whether to include the object in the PDF result of the report.

Data type: Boolean

Export to PostScript

Specifies whether to include the object in the PostScript result of the report.

Data type: Boolean

Export to Report Result

Specifies whether to include the object when previewing the report in Page Report Result and running the report in Page Report Studio.

Data type: Boolean

Export to RTF

Specifies whether to include the object in the RTF result of the report.

Data type: Boolean

Export to Text

Specifies whether to include the object in the Text result of the report.

Data type: Boolean

Export to XML

Specifies whether to include the object in the XML result of the report.

Data type: Boolean

Invisible

Specifies whether to show the object in the design area and in the report results. All formulas and calculations will still be performed if the property is set to true.

Data type: Boolean

Maximum Page Number

Specifies the maximum number of pages in the data buffer.

Data type: Integer

Position

Specifies the position of the object. Choose an option from the drop-down list.

Data type: Enumeration

Record Location

Specifies the calculation point for the properties which use 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

Records per Page

Specifies the number of records in each page in the data buffer.

Data type: Integer

Subreport Data Source Name

Displays the name of the data source used by the subreport. If nothing is displayed, the default data source will be used. This property is read only.

Subreport Query Name

Displays the name of the query used by the subreport. This property is read only.

Subreport Security Name

Displays the security name (record-level security) used by the subreport. This property is read only.

Suppress

Specifies whether to show the object in the design area and in the report results. 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 When Empty

Specifies whether to display the object in the report results when no record is returned to it.

Data type: Boolean

Suppress When No Records

Specifies whether to display the object in the report results when no record is returned to its parent data component.

Data type: Boolean

Excel

Column Index

Specifies the X coordinate of the object relative to its parent container when exported to Excel or CSV, measured in cells. The Columned property at the report tab level must be set to true for this property to take effect.

Data type: Integer

On New Sheet

Specifies whether to put the subreport in a new sheet in the Excel result of the report.

Data type: Boolean

Row Index

Specifies the Y coordinate of the object relative to its parent container in the Excel/CSV result of the report, measured in cells. The Columned property at the report tab level must be set to true for this property to take effect.

Data type: Integer

Sheet Name

Specifies the name of the new sheet in which the subreport will be put in the exported Excel file. Make sure the name specified here isn't used by any other sheets.

It is meaningful to specify the property value when On New Sheet is set to true.

Data type: String

Note: The characters "|", ":", "/", "?", "\", "*", "]", "[" cannot be displayed in the sheet name in Excel and the last character in the sheet name cannot be single quotation mark ('). If any one of them is used when you specify the property, it will be replaced by "_" in Excel.

Sheet Name Postfix

Specifies how to add postfix number to the sheets in which the subreport will be put in the exported Excel file. Choose an option from the drop-down list.

Add postfix number to every page - Specifies to add the postfix number to every sheet for the subreport (Subreport1, Subreport2, Subreport3, Subreport4...).
Add postfix number only to additional pages - Specifies to add the postfix number to the subreport sheets starting from the second one (Subreport, Subreport1, Subreport2, Subreport3...).

It is meaningful to specify the property value when On New Sheet is set to true.

Data type: Enumeration

Border

Border Color

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

Data type: String

Border Thickness

Specifies the width of the border. Enter a numeric value to change the thickness.

Data type: Float

Bottom Line

Specifies the line style of the bottom border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Left Line

Specifies the line style of the left border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Right Line

Specifies the line style of the right border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Top Line

Specifies the line style of the top border of the object. Choose a style from the drop-down list.

Data type: Enumeration

TOC

Anchor Display Value

Specifies a string or formula to display for the TOC entry for this object in the TOC Browser. By default it is the value of the specified object. The TOC Anchor property must be set to true for this property to take effect.

Data type: String

TOC Anchor

Specifies whether to include the object in the TOC Browser for the report.

Data type: Boolean

Accessibility

External CSS Class Selector

Specifies a class selector to be applied to the object when exported as HTML. Enter a valid class name from the CSS file.

Data type: String

External ID

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

It is mapped to the HTML attribute style. This attribute specifies style information for the object.

Data type: String

Language

It 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

Cache

In a report, when the subreport needs to be run more than once, set the property Cache to true. The data of the subreport will be cached in the data buffer. When the subreport is run the next time, the sub-engine will retrieve the data from the data buffer instead of DBMS, and if sublink exists, it will also be calculated in the data buffer, thus improving the engine performance.

When a data buffer is defined in the sub-engine, the data buffer is divided into many pages and records are allocated in the pages. You can use the properties Records per Page and Maximum Page Number to set the number of the records in one page and the maximum number of pages in the data buffer. If enough physical memory is available and you know the total number of records in the subreport, to achieve better performance, you can set Records per Page approximate to the total number of records.

Note: The Cache property will not work in the following cases:

When the parameter is displayed in the Parameters in subreport tab which is contained in the query of the subreport.
When HDS is used by the subreport.
When dynamic query is used by the subreport.

On New Sheet

This property is used to specify where the subreport will be put in the Excel result of the report.

If you want to put the subreport in the same worksheet together with the primary report, set the value to false.

If you want to put the subreport in a new worksheet in the Excel result, set the property value to true, then enter a name for the new worksheet in the Sheet Name property's value cell.

When On New Sheet is true, in the Excel result file you will find that the primary report is exported into the first worksheet, and there are some links on it. You can click the links to go to the subreport in the second worksheet of the Excel file.

Note: If the subreport are cut into several pages, that is to say you have defined some page settings on the subreport, the links in the primary report will be subreport1_0, subreport1_1, subreport1_2 and so on. You can click the link to see the corresponding part you want.