You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: designing-reports/report-designer-tools/web-report-designer/user-guide/report-structure.md
+24-46Lines changed: 24 additions & 46 deletions
Original file line number
Diff line number
Diff line change
@@ -1,66 +1,44 @@
1
1
---
2
2
title: Report Structure
3
-
page_title: Report Structure at a Glance
4
-
description: "Learn more about the report structure and the groups, sections, and items a Telerik Reporting report contains."
3
+
page_title: Report Structur
4
+
description: "Learn which elements build the structure of the reports created in the Telerik Web Report Designer and use these report elements to convey information effectively."
The design of a report is divided into sections that divide the report vertically. Each report section represents a specific area on the report page and defines what items can be placed in it and how they will look.
14
14
15
-
To view the report sections, open the report in [Visual Studio Report Designer]({%slug telerikreporting/designing-reports/report-designer-tools/desktop-designers/visual-studio-report-designer/overview%}) or [Standalone Report Designer]({%slug telerikreporting/designing-reports/report-designer-tools/desktop-designers/standalone-report-designer/overview%}).
15
+
By default, every new report you create has three sections:
16
16
17
-
Report sections divide the report vertically. Depending on their type, for example, Page and Group sections, they appear on specific places in the report and the report items they contain are processed and rendered differently. Each section works in a specific way, for example, the section in which you choose to place a data-bound item determines how Telerik Reporting calculates the results.
17
+
* Page header
18
+
* Page footer
19
+
* Detail section (the main content area of the report)
18
20
19
-
To create a data-bound report, assign a data source to the report or its nested [Data Item]({%slug telerikreporting/designing-reports/connecting-to-data/data-items/overview%}), and either specify [`Expressions`]({%slug telerikreporting/designing-reports/connecting-to-data/expressions/overview%}) for the items within the report, or a corresponding data item where to display the actual data. For more information on creating data-bound reports, refer to the [Connecting to Data]({%slug telerikreporting/designing-reports/connecting-to-data/overview%}) and [Using Expressions]({%slug telerikreporting/designing-reports/connecting-to-data/expressions/using-expressions/overview%}) articles.
21
+
In addition to the default sections above, you can also add:
20
22
21
-
You can reuse the styling of the report items in stylesheets. If a report uses stylesheets, they can be saved to an XML file and shared between multiple reports in your application. For more information, refer to the article on [exporting and reusing stylesheets]({%slug telerikreporting/designing-reports/styling-reports/exporting-and-reusing-style-sheets%}).
23
+
* Table of Contents (TOC)
24
+
* Report Header
25
+
* Group Header
26
+
* Group Footer
27
+
* Report Footer
22
28
23
-
## Report Sections
29
+
## Page Header
24
30
25
-
A Telerik report consists of different sections that may contain report items. Each report section represents a specific area on the report page and defines the rendering of its report items.
31
+
The Page Header section is printed at the top of every page. In reports that include multiple pages, you can use the Page Header to place the same content at the beginning of every page, for example, the report title.
26
32
27
-
Every section is an instance of the [`ReportSectionBase`](/reporting/api/Telerik.Reporting.ReportSectionBase) class. The `Height` property defines the space a section occupies on the page. Other specific properties, such as `PrintOnFirstPage` and `PrintOnLastPage`, define the behavior of the particular section.
33
+
>The Page Header can display only the content that fits within the boundaries of the section. Any content that doesn't fit within the section will be clipped.
28
34
29
-
When a new Telerik report is added to a project, it is initially divided into `PageHeader`, `Detail`, and `PageFooter` sections. The section type specifies rendering of the items inside, the order of their appearance, and the number of times they will be rendered when the report is data-bound.
30
-
31
-
The Telerik report contains the following report sections:
32
-
33
-
*[`Page Header`]
34
-
*[`Table of Contents (TOC)`]
35
-
*[`Report Header`]
36
-
*[`Group Header`]
37
-
*[`Detail`]
38
-
*[`Group Footer`]
39
-
*[`Report Footer`]
40
-
*[`Page Footer`]
41
-
42
-
### Page Header
43
-
44
-
The Page Header section is printed at the top of every page. For example, you can use the page header to repeat the report title on every page.
45
-
46
-
Since the paging of a report strongly depends on the format it is rendered to, this section and its items are processed by the corresponding rendering extension after the report data has been processed. This approach has the following implications:
47
-
48
-
* The built-in [`PageNumber` and `PageCount` objects]({%slug telerikreporting/designing-reports/connecting-to-data/expressions/expressions-reference/global-objects%}), which contain the current page number and the total report pages count, can be used in this section. All [Page Functions]({%slug telerikreporting/designing-reports/connecting-to-data/expressions/expressions-reference/functions/page-functions%}) can also be used in this section.
49
-
* It is possible to suppress the printing of the Page Header section on the first (set `PrintOnFirstPage`) and last (set `PrintOnLastPage`) page of a report, or hide it by using [Conditional Formatting]({%slug telerikreporting/designing-reports/connecting-to-data/expressions/using-expressions/conditional-formatting%}). In this case, the occupied space will be used from the rest of the report content. It is not possible to use the `= (PageNumber = PageCount)` expressions to hide the `PageHeader` or `PageFooter` on the last page. This is a known limitation due to the fact that the resulting page count depends on the visibility of the `PageHeader` and `PageFooter` sections as this modifies the available space for the rest of the report content. At the same time, the above expression sets the visibility of the page sections to depend on the page count. This leads to uncertainty and the page count cannot be properly estimated.
50
-
* The Height of the section may be changed at runtime through [`Bindings`]({%slug telerikreporting/designing-reports/connecting-to-data/expressions/using-expressions/bindings%}). It is recommended that you set the default height of the section to the maximal expected one. Then, you may reduce the height of each Page section with a proper Binding. The reason behind this approach is to assure that the available height of the page after rendering the Page Header and Footer will be positive, so that some detailed content can be placed on the page. If the combined height of the Page Header and Page Footer is bigger than the page height, the Page sections will be ignored and only the content will be rendered. The [behavior of the `KeepTogether` property]({%slug telerikreporting/designing-reports/report-structure/design-considerations-for-report-item-layout%}#Pagination1) may also change due to the extra expansion of Page sections. Setting the Page section height with a Binding to a larger value than the default one may result in other unpredictable behavior. The height of the Page section must not depend on the data rendered on the page. The logic behind is that the Page Section height is estimated prior to evaluating the corresponding page data as the Reporting engine needs to calculate the available space on each page before rendering the data on it.
51
-
52
-
>note If the contents of the Page Header or Footer grows beyond its boundaries, the contents are clipped. Any report item that doesn't fit entirely in the section is removed, i.e. not rendered at all.
53
-
54
-
* It is not possible to use [Data Items]({%slug telerikreporting/designing-reports/connecting-to-data/data-items/overview%}) in this section.
55
-
*[Expressions]({%slug telerikreporting/designing-reports/connecting-to-data/expressions/overview%}) in this section are evaluated against the report [Data Scope]({%slug telerikreporting/designing-reports/connecting-to-data/expressions/expression-scope-%}) defined by the data source of the report after the data has been filtered. To work with data from the current page, only you have to use the [`PageExec`]({%slug telerikreporting/designing-reports/connecting-to-data/expressions/expressions-reference/functions/page-functions%}) function or the other Page functions with a specified scope.
56
-
57
-
### Table of Contents
35
+
## Table of Contents
58
36
59
37
The Table of Contents (TOC) section provides a set of navigational links to report items and displays the page numbers where they can be found. The user can click the TOC entries to navigate to the report page which displays that item.
60
38
61
39
The TOC section can be displayed before or after the Report Header or Report Footer section based on the user preferences. For more information, see [Table of Contents]({%slug telerikreporting/designing-reports/adding-interactivity-to-reports/table-of-contents/overview%}) overview article.
62
40
63
-
###Report Header
41
+
## Report Header
64
42
65
43
The Report Header section is printed just once, at the beginning of the report.
66
44
@@ -69,21 +47,21 @@ The Report Header section is printed just once, at the beginning of the report.
69
47
70
48
Use the report header for information that might normally appear on a cover page, such as a logo, a title, or a date. In the Report Header section, all data fields must be aggregated, even if the data source returns only one row. Typically, you must use the `FIRST()` function for character and date data and the `SUM()` function for numeric data. When you place a data-bound report item that uses an aggregate function in the report header, it is calculated for the entire report data.
71
49
72
-
###Group Header
50
+
## Group Header
73
51
74
52
The Group Header section is printed at the beginning of each new group of records. Use the group header to print the group name. For example, in a report that is grouped by product, use the group header to print the product name.
75
53
76
54
In the Group Header section, all data fields must be aggregated, even if the data source returns only one row. Typically, you must use the `FIRST()` function for character and date data, and the `SUM()` function for numeric data. When you place a data-bound report item that uses an aggregate function in the Group Header, it is calculated for the entire group data.
77
55
78
-
###Detail
56
+
## Detail
79
57
80
58
The Detail section displays the detailed information and is printed once for every row in the data source. This is where you place the report items that constitute the main body of the report.
81
59
82
-
###Group Footer
60
+
## Group Footer
83
61
84
62
The Group Footer section is printed at the end of each group of records. Use a group footer to print a summary of group information. Similar to the Group Header section, you must always use aggregate functions for the data-bound items that are calculated for the group data.
85
63
86
-
###Report Footer
64
+
## Report Footer
87
65
88
66
The Report Footer section is printed just once, at the end of the report.
89
67
@@ -92,7 +70,7 @@ The Report Footer section is printed just once, at the end of the report.
92
70
93
71
Use the report footer to print report totals or other summary information for the entire report. Similar to the Report Header section, you must always use aggregate functions for the data-bound items that are calculated for the entire report data.
94
72
95
-
###Page Footer
73
+
## Page Footer
96
74
97
75
The Page Footer section is printed at the end of every page. Use a page footer to print page numbers or per-page information.
0 commit comments