Update interactivity (#843)
* Update tooltips.md * Update table-header-freezing.md * Update document-map.md * Update bookmarks.md * Update overview.md * Update how-to-add-a-table-of-contents-to-report-book.md * Update overview.md * Update bookmarks.md * Update document-map.md * Update overview.md * Update overview.md * Update how-to-add-a-table-of-contents-to-report-book.md --------- Co-authored-by: Todor Arabadzhiev <todor.arabadzhiev@progress.com>
This commit is contained in:
Dimitar Nikolov
GitHub
Родитель
6f98a05a60
Коммит
a70ff22ea8
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Actions Overview
|
||||
page_title: Actions Overview
|
||||
description: Actions Overview
|
||||
title: Overview
|
||||
page_title: Interactive Actions in Reports
|
||||
description: "Learn how to add all kinds of interactive actions(predefined or custom) to your reports via the Edit Action dialog."
|
||||
slug: telerikreporting/designing-reports/adding-interactivity-to-reports/actions/overview
|
||||
tags: overview
|
||||
published: True
|
||||
|
|
@ -11,19 +11,19 @@ previous_url: /designing-reports-interactivity-actions
|
|||
|
||||
# Actions Overview
|
||||
|
||||
You can add interactive actions that allow users to open Web pages or other reports, jump to another location within the same report or drilldown to detail data. To add an interactive action, you define an Action on a report item. Use the [Edit Action dialog]({%slug telerikreporting/designing-reports/report-designer-tools/desktop-designers/tools/edit-action-dialog%}) to set the type of interactive action. When the user clicks that report item, the action that you define takes place. The report engine supports the following action types:
|
||||
You can add interactive actions that allow users to open Web pages or other reports, jump to another location within the same report or drilldown to detail data. To add an interactive action, you define an `Action` on a report item. Use the [Edit Action dialog]({%slug telerikreporting/designing-reports/report-designer-tools/desktop-designers/tools/edit-action-dialog%}) to set the type of interactive action. When the user clicks that report item, the action that you define takes place. The report engine supports the following action types:
|
||||
|
||||
* __Navigate to Report__ : Jump to other reports from the main report (Drillthrough report).
|
||||
* `Navigate to Report` : Jump to other reports from the main report (Drillthrough report).
|
||||
|
||||
* __Navigate to Bookmark__ : Jump to areas within a report.
|
||||
* `Navigate to Bookmark` : Jump to areas within a report.
|
||||
|
||||
* __Navigate to Url__ : Jump to external web URLs that specify the address of web pages.
|
||||
* `Navigate to Url` : Jump to external web URLs that specify the address of web pages.
|
||||
|
||||
* __Toggle Visibility__ : Show or hide report items within the same report.
|
||||
* `Toggle Visibility` : Show or hide report items within the same report.
|
||||
|
||||
* __Sorting__ : Apply sorting on report items like __Table__ , __Crosstab__ or __Graph__.
|
||||
* `Sorting` : Apply sorting on report items like `Table` , `Crosstab` or `Graph`.
|
||||
|
||||
* __Custom__ : An action that contains collection of parameters that are evaluated during report processing.
|
||||
* `Custom` : An action that contains collection of parameters that are evaluated during report processing.
|
||||
|
||||
> The actions are feature of the report viewers and not of the rendering extension. You can find more info about the supported interactive features in each format by checking the Interactivity section of the respective articles in [Design Considerations for Report Rendering Overview]({%slug telerikreporting/designing-reports/rendering-and-paging/design-considerations-for-report-rendering/overview%}) help section.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,32 +1,34 @@
|
|||
---
|
||||
title: Bookmarks
|
||||
page_title: Bookmarks
|
||||
description: Bookmarks Overview
|
||||
page_title: Report Bookmarks
|
||||
description: "Learn how to implement internal navigation in a report by adding custom Bookmark IDs to report items, sections or groups."
|
||||
slug: telerikreporting/designing-reports/adding-interactivity-to-reports/bookmarks/overview
|
||||
tags: bookmarks,overview
|
||||
tags: bookmarks,overview,internal,navigation,reports,links
|
||||
published: True
|
||||
previous_url: /designing-reports-interactivity-bookmarks
|
||||
---
|
||||
|
||||
# Bookmarks Overview
|
||||
|
||||
Add bookmarks to a report when you want to provide customized internal navigation in the report. Typically, you add bookmarks to locations in the report to which you want to direct users. You can create your own strings to use as bookmarks, or, for groups, you can set the bookmark to the group expression. After you create bookmarks, you can add report items that the user can click to go to each bookmark. These items are typically text boxes or images. For example, if your report displays a table grouped by color, you would add a bookmark based on the group expression to the group header. Then you would add a table with a single text box at the beginning of the report that displayed the color values, and set the bookmark link on that text box. When you click the color, the report jumps to the page that displays the group header row for that color. You can add a bookmark to any report item/group and add a bookmark link to any report item.
|
||||
Add bookmarks to a report when you want to provide customized internal navigation in the report. Typically, you add bookmarks to locations in the report to which you want to direct users. You can create your own strings to use as bookmarks, or, for groups, you can set the bookmark to the group expression. After you create bookmarks, you can add report items that the user can click to go to each bookmark. These items are typically text boxes or images.
|
||||
|
||||
To define a bookmark on item/group use the [BookmarkId](/reporting/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_BookmarkId) property. To define a bookmark action add a [NavigateToBookmarkAction](/reporting/api/Telerik.Reporting.NavigateToBookmarkAction) on another item.
|
||||
For example, if your report displays a table grouped by color, you would add a bookmark based on the group expression to the group header. Then, you would add a table with a single text box at the beginning of the report that displayed the color values, and set the bookmark link on that text box. When you click the color, the report jumps to the page that displays the group header row for that color. You can add a bookmark to any report item/group and add a bookmark link to any report item.
|
||||
|
||||
>important It is recommended that the BookmarkId property value is unique and conforms to the [C# Language Specification for Identifiers](https://docs.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/identifier-names). If the BookmarkId contains characters which are not allowed by this specification, they will be escaped by the reporting engine.
|
||||
To define a bookmark on item/group use the [BookmarkId](/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_BookmarkId) property. To define a bookmark action add a [NavigateToBookmarkAction](/api/Telerik.Reporting.NavigateToBookmarkAction) on another item.
|
||||
|
||||
>important It is recommended that the `BookmarkId` property value is unique and conforms to the [C# Language Specification for Identifiers](https://docs.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/identifier-names). If the `BookmarkId` contains characters which are not allowed by this specification, they will be escaped by the reporting engine.
|
||||
|
||||
## How to Add Bookmarks to a Report item
|
||||
|
||||
Add bookmarks to a report when you want to provide a customized table of contents or to provide customized internal navigation in the report. Typically, you add bookmarks to locations in the report to which you want to direct users. You can create your own strings to use as bookmarks, or, for groups, you can set the bookmark to the group expression. After you create bookmarks, you can add report items that the user can click to go to each bookmark. These items are typically text boxes or images.
|
||||
Add bookmarks to a report when you want to provide a customized table of contents or to provide customized internal navigation in the report. Typically, you add bookmarks to locations in the report to which you want to direct users. You can create your own strings to use as bookmarks, or, for groups, you can set the bookmark to the group expression. After you create bookmarks, you can add report items that the user can click to go to each bookmark. These items are typically text boxes or images.
|
||||
|
||||
### Adding a bookmark to a report item
|
||||
|
||||
1. In __Design view__, select a report item to which you want to add a bookmark. The properties for the selected item appear in the __Properties__ pane.
|
||||
|
||||
1. In the [BookmarkId](/reporting/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_BookmarkId) property, type a string that is the label for this bookmark. Alternatively, click the ellipsis to open the Expression dialog box to specify an expression that evaluates to a label.
|
||||
1. In the [BookmarkId](/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_BookmarkId) property, type a string that is the label for this bookmark. Alternatively, click the ellipsis to open the Expression dialog box to specify an expression that evaluates to a label.
|
||||
|
||||
>note The [BookmarkId](/reporting/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_BookmarkId) can be any string, but it must be unique in the report. If the __BookmarkID__ is not unique, an action to the bookmark finds the first matching bookmark.
|
||||
>note The [BookmarkId](/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_BookmarkId) can be any string, but it must be unique in the report. If the `BookmarkID` is not unique, an action to the bookmark finds the _first_ matching bookmark.
|
||||
|
||||
## How to Add Bookmarks to a Report group
|
||||
|
||||
|
|
@ -36,12 +38,12 @@ Add bookmarks to a report when you want to provide a customized table of content
|
|||
|
||||
1. In __Design view__, right click outside the report sections, select View and open up the [Group Explorer]({%slug telerikreporting/designing-reports/report-designer-tools/desktop-designers/tools/group-explorer%}). Select a report group to which you want to add a bookmark. The properties for the selected group appear in the __Properties__ pane.
|
||||
|
||||
1. In the [BookmarkId](/reporting/api/Telerik.Reporting.Group#Telerik_Reporting_Group_BookmarkId) property,
|
||||
1. In the [BookmarkId](/api/Telerik.Reporting.Group#Telerik_Reporting_Group_BookmarkId) property,
|
||||
type a string that is the label for this bookmark. Alternatively, click
|
||||
the ellipsis to open the __Expression__ dialog box to specify an expression that evaluates to text.
|
||||
Typically for a group, the expression you type should be the group expression.
|
||||
|
||||
>note The [BookmarkId](/reporting/api/Telerik.Reporting.Group#Telerik_Reporting_Group_BookmarkId) can be any string, but it must be unique in the report. If the __BookmarkID__ is not unique, an action to the bookmark finds the first matching bookmark.
|
||||
>note The [BookmarkId](/api/Telerik.Reporting.Group#Telerik_Reporting_Group_BookmarkId) can be any string, but it must be unique in the report. If the `BookmarkID` is not unique, an action to the bookmark finds the first matching bookmark.
|
||||
|
||||
## How to Add Bookmarks to a Table group
|
||||
|
||||
|
|
@ -49,13 +51,13 @@ Add bookmarks to a report when you want to provide a customized table of content
|
|||
|
||||
### Adding a bookmark to a Table group
|
||||
|
||||
1. In __Design view__, right click outside the report sections, select View and open up the [Group Explorer]({%slug telerikreporting/designing-reports/report-designer-tools/desktop-designers/tools/group-explorer%}). Select a [Table](/reporting/api/Telerik.Reporting.Table), [Crosstab](/reporting/api/Telerik.Reporting.Crosstab) or [List](/reporting/api/Telerik.Reporting.List) report item, so the __Group Explorer__ shows the respective groups. Select a group to which you want to add a bookmark, right click on it and select __Group Properties__. The properties for the selected group appear in the __Edit Table Group__ dialog.
|
||||
1. In __Design view__, right click outside the report sections, select View and open up the [Group Explorer]({%slug telerikreporting/designing-reports/report-designer-tools/desktop-designers/tools/group-explorer%}). Select a [Table](/api/Telerik.Reporting.Table), [Crosstab](/api/Telerik.Reporting.Crosstab) or [List](/api/Telerik.Reporting.List) report item, so the __Group Explorer__ shows the respective groups. Select a group to which you want to add a bookmark, right click on it and select __Group Properties__. The properties for the selected group appear in the __Edit Table Group__ dialog.
|
||||
|
||||
1. In the [BookmarkId](/reporting/api/Telerik.Reporting.TableGroup#Telerik_Reporting_TableGroup_BookmarkId) property,
|
||||
1. In the [BookmarkId](/api/Telerik.Reporting.TableGroup#Telerik_Reporting_TableGroup_BookmarkId) property,
|
||||
type a string that is the label for this bookmark. Alternatively, click the ellipsis to open the __Expression__ dialog box to
|
||||
specify an expression that evaluates to text. Typically for a group, the expression you type should be the group expression.
|
||||
|
||||
>note The [BookmarkId](/reporting/api/Telerik.Reporting.TableGroup#Telerik_Reporting_TableGroup_BookmarkId) can be any string, but it must be unique in the report. If the __BookmarkID__ is not unique, an action to the bookmark finds the first matching bookmark.
|
||||
>note The [BookmarkId](/api/Telerik.Reporting.TableGroup#Telerik_Reporting_TableGroup_BookmarkId) can be any string, but it must be unique in the report. If the `BookmarkID` is not unique, an action to the bookmark finds the first matching bookmark.
|
||||
|
||||
## See Also
|
||||
|
||||
|
|
|
|||
|
|
@ -1,34 +1,34 @@
|
|||
---
|
||||
title: Document Map
|
||||
page_title: Document Map
|
||||
description: Document Map Overview
|
||||
page_title: Document Map in Detail
|
||||
description: "Learn how to use the document map functionality by configuring the DocumentMapText and BookmarkId properties of the report items."
|
||||
slug: telerikreporting/designing-reports/adding-interactivity-to-reports/document-map/overview
|
||||
tags: overview
|
||||
tags: overview,document,map,bookmark
|
||||
published: True
|
||||
previous_url: /designing-reports-document-map, /designing-reports-interactivity-how-to-add-document-map
|
||||
---
|
||||
|
||||
# Document Map
|
||||
# Document Map Overview
|
||||
|
||||
A document map provides a set of navigational links to report items in the rendered report. A user can click links in the document map to jump to the report page that displays that item.
|
||||
A document map provides a set of navigational links to report items in the rendered report. A user can click links in the document map to jump to the report page that displays that item.
|
||||
|
||||
>note The Page Header section is skipped when jumping to a report page using a document map navigational link i.e., the report viewer/designer preview will always be positioned after the Page Header section.
|
||||
>note The Page Header section is skipped when jumping to a report page using a document map navigational link i.e., the report viewer/designer preview will always be positioned after the Page Header section.
|
||||
|
||||
The document map is also used to provide a set of navigational links to reports in a [Report Book]({%slug telerikreporting/designing-reports/report-book/overview%}).
|
||||
The document map is also used to provide a set of navigational links to reports in a [Report Book]({%slug telerikreporting/designing-reports/report-book/overview%}).
|
||||
|
||||
|
||||
|
||||
|
||||
The Document map is defined by setting the [DocumentMapText](/reporting/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_DocumentMapText) and [BookmarkId](/reporting/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_BookmarkId) properties of any report item/group. The __BookmarkID__ property should be unique for the whole [IReportDocument](/reporting/api/Telerik.Reporting.IReportDocument). If __BookmarkID__ is not set, then the Value of __DocumentMapText__ is taken into account. Valid values are static text, expression, or text with embedded expressions. The resulting text will be displayed in the document map tree.
|
||||
The Document map is defined by setting the [DocumentMapText](/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_DocumentMapText) and [BookmarkId](/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_BookmarkId) properties of any report item/group. The `BookmarkID` property should be unique for the whole [IReportDocument](/api/Telerik.Reporting.IReportDocument). If the `BookmarkID` is not set, then the Value of `DocumentMapText` is taken into account. Valid values are static text, expressions, or text with embedded expressions. The resulting text will be displayed in the document map tree.
|
||||
|
||||
To form hierarchical structure of the document map, you may set the [DocumentMapText](/reporting/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_DocumentMapText) property of the report groups, the CrossTab/Table groups, the Detail section and the Report (useful for SubReports). For example nested groups will create nested nodes in the tree. Each of the produced nodes will navigate to the most appropriate page and location in the rendered report. For example bookmark of a report group will navigate to the group header (or first detail inside the group if header is not visible).
|
||||
To form the hierarchical structure of the document map, you may set the [DocumentMapText](/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_DocumentMapText) property of the report groups, the CrossTab/Table groups, the Detail section and the Report (useful for SubReports). For example, nested groups will create nested nodes in the tree. Each of the produced nodes will navigate to the most appropriate page and location in the rendered report. For example, bookmark of a report group will navigate to the group header (or first detail inside the group if header is not visible).
|
||||
|
||||
To add a node in the document map pointing to a report item, you may use the [DocumentMapText](/reporting/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_DocumentMapText) property of that item. Note that all report items (except the Detail section and the Report itself) produce leaf nodes in the document map tree. For example if you have a Panel item with TextBox item inside, and set the DocumentMapText property of both, the resulting nodes will be added as leaf siblings in the document map.
|
||||
To add a node in the document map pointing to a report item, you may use the [DocumentMapText](/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_DocumentMapText) property of that item. Note that all report items (except the Detail section and the Report itself) produce leaf nodes in the document map tree. For example if you have a Panel item with TextBox item inside, and set the `DocumentMapText` property of both, the resulting nodes will be added as leaf siblings in the document map.
|
||||
|
||||
>note Report items positioned in the Page Header/Page Footer section of the report cannot be used to create nodes in the document map. Setting the [DocumentMapText](/reporting/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_DocumentMapText) property of such item will have no effect.
|
||||
>note Report items positioned in the Page Header/Page Footer section of the report cannot be used to create nodes in the document map. Setting the [DocumentMapText](/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_DocumentMapText) property of such item will have no effect.
|
||||
|
||||
The order of items in the document map is according to the order of the report items in the report items' collection, and not by the order in which you have added [DocumentMapText](/reporting/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_DocumentMapText) to items.
|
||||
The order of items in the document map is according to the order of the report items in the report items' collection, and not by the order in which you have added [DocumentMapText](/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_DocumentMapText) to items.
|
||||
|
||||
>note The document map is intended for use in the __Designer Preview__ and in all __ReportViewers__. From the supported rendering extensions, only the PDF renders a document map as Bookmarks pane. All other rendering extensions ignore document maps.
|
||||
>note The document map is intended for use in the __Designer Preview__ and in all __ReportViewers__. From the supported rendering extensions, only the PDF renders a document map as Bookmarks pane. All other rendering extensions ignore document maps.
|
||||
|
||||
## How to Add a Report Item to Document Map
|
||||
|
||||
|
|
@ -36,21 +36,19 @@ You can add a document map, which acts like a table of contents. A user can clic
|
|||
|
||||
### Adding a report item to document map
|
||||
|
||||
1. In __Design view__, make sure the Properties pane is visible. Select the report item that you want to add to the document map. In the Properties pane, type the text that you want to appear in the document map in the [DocumentMapText](/reporting/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_DocumentMapText) property, or enter an expression that evaluates to a text. For example, type __Product Catalog__. If the [DocumentMapText](/reporting/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_DocumentMapText) does not evaluate to unique value, then a unique value should be set to the [BookmarkId](/reporting/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_BookmarkId) property.
|
||||
|
||||
1. In __Design view__, make sure the Properties pane is visible. Select the report item that you want to add to the document map. In the Properties pane, type the text that you want to appear in the document map in the [DocumentMapText](/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_DocumentMapText) property, or enter an expression that evaluates to a text. For example, type __Product Catalog__. If the [DocumentMapText](/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_DocumentMapText) does not evaluate to unique value, then a unique value should be set to the [BookmarkId](/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_BookmarkId) property.
|
||||
1. Repeat step 1 for every report item that you want to appear in the document map.
|
||||
1. Click __Preview__. The report runs and the document map displays the text you created. Click any link to jump to the report page and the exact location of that item.
|
||||
|
||||
1. Click __Preview__. The report runs and the document map displays the text you created. Click any link to jump to the report page and the exact location of that item.
|
||||
|
||||
>note Report items positioned in the Page Header/Page Footer section of the report cannot be used to create nodes in the document map. Setting the [DocumentMapText](/reporting/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_DocumentMapText) property of such item will have no effect.
|
||||
>note Report items positioned in the Page Header/Page Footer section of the report cannot be used to create nodes in the document map. Setting the [DocumentMapText](/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_DocumentMapText) property of such item will have no effect.
|
||||
|
||||
### Hiding the document map when you view a report
|
||||
|
||||
You can run the report without initially displaying the document map by setting the __ReportViewer.DocumentMapVisible__ property to false (true by default), and then click the Show/Hide button on the report viewer toolbar to toggle its display whenever needed.
|
||||
You can run the report without initially displaying the document map by setting the `ReportViewer.DocumentMapVisible` property to `false` (true by default), and then click the Show/Hide button on the report viewer toolbar to toggle its display whenever needed.
|
||||
|
||||
If you want to restrict the user from showing/hiding the document map, you can hide the corresponding button by altering the viewer's __ShowDocumentMapButton__ (true by default) property.
|
||||
If you want to restrict the user from showing/hiding the document map, you can hide the corresponding button by altering the viewer's `ShowDocumentMapButton` (true by default) property.
|
||||
|
||||
>note The order of items in the document map is according to the order of the report items in the report items' collection, and not by the order in which you have added [DocumentMapText](/reporting/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_DocumentMapText) to items.
|
||||
>note The order of items in the document map is according to the order of the report items in the report items' collection, and not by the order in which you have added [DocumentMapText](/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_DocumentMapText) to items.
|
||||
|
||||
## How to Add a Report group to Document Map
|
||||
|
||||
|
|
@ -59,17 +57,14 @@ A user can click items in the document map to jump to areas within a report.
|
|||
### Adding a Report group to document map
|
||||
|
||||
1. In __Design view__, right click outside the report sections, select View and open up the [Group Explorer]({%slug telerikreporting/designing-reports/report-designer-tools/desktop-designers/tools/group-explorer%}).
|
||||
|
||||
1. Select a report group to which you want to add a document map. The properties for the selected group appear in the __Properties__ pane.
|
||||
1. In the [DocumentMapText](/api/Telerik.Reporting.Group#Telerik_Reporting_Group_DocumentMapText) property, type the text
|
||||
|
||||
1. In the [DocumentMapText](/reporting/api/Telerik.Reporting.Group#Telerik_Reporting_Group_DocumentMapText) property, type the text
|
||||
that you want to appear in the document map. Alternatively, click the ellipsis to open the __Expression__ dialog box to specify an
|
||||
expression that evaluates to a text. Typically for a group, the expression you type should match the group expression.
|
||||
|
||||
1. Click __OK__.
|
||||
|
||||
1. Repeat steps 1-4 for every group that you want to appear in the document map.
|
||||
|
||||
1. Run the report - the document map displays the group values. Click any document map node to jump to the report page with that item.
|
||||
|
||||
## How to Add a Table group to Document Map
|
||||
|
|
@ -79,18 +74,13 @@ A user can click items in the document map to jump to areas within a report.
|
|||
### Adding a Table group to document map
|
||||
|
||||
1. In __Design view__, right click outside the report sections, select View and open up the [Group Explorer]({%slug telerikreporting/designing-reports/report-designer-tools/desktop-designers/tools/group-explorer%}).
|
||||
|
||||
1. Select a [Table](/reporting/api/Telerik.Reporting.Table), [Crosstab](/reporting/api/Telerik.Reporting.Crosstab) or [List](/reporting/api/Telerik.Reporting.List) report item, so the __Group Explorer__ shows the respective groups.
|
||||
|
||||
1. Select a [Table](/api/Telerik.Reporting.Table), [Crosstab](/api/Telerik.Reporting.Crosstab) or [List](/api/Telerik.Reporting.List) report item, so the __Group Explorer__ shows the respective groups.
|
||||
1. Select a group to which you want to add a document map, right click on it and select __Group Properties__. The properties for the selected group appear in the __Edit Table Group__ dialog.
|
||||
1. In the [DocumentMapText](/api/Telerik.Reporting.TableGroup#Telerik_Reporting_TableGroup_DocumentMapText) property,
|
||||
|
||||
1. In the [DocumentMapText](/reporting/api/Telerik.Reporting.TableGroup#Telerik_Reporting_TableGroup_DocumentMapText) property,
|
||||
type the text that you want to appear in the document map. Alternatively, click the ellipsis to open the __Expression__ dialog box to specify an expression that evaluates to a text.
|
||||
Typically for a group, the expression you type should match the group expression.
|
||||
|
||||
1. Click __OK__.
|
||||
|
||||
1. Repeat steps 1-4 for every group that you want to appear in the document map.
|
||||
|
||||
1. Run the report - the document map displays the group values. Click any document map node to jump to the report page with that item.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,48 +1,48 @@
|
|||
---
|
||||
title: Table Header Freezing
|
||||
page_title: Table Header Freezing
|
||||
description: Table Header Freezing
|
||||
page_title: Table Header Freezing in Detail
|
||||
description: "Learn how to enable the table headers freezing functionality, its behavior and where it is applicable."
|
||||
slug: telerikreporting/designing-reports/adding-interactivity-to-reports/table-header-freezing
|
||||
tags: table,header,freezing
|
||||
tags: table,header,freezing,columnheader,rowheader
|
||||
published: True
|
||||
position: 5
|
||||
previous_url: /table-headers-freezing
|
||||
---
|
||||
|
||||
# Table Header Freezing
|
||||
# Table Header Freezing Overview
|
||||
|
||||
|
||||
Freezing the table headers prevents the row and column headers of a table from scrolling out of view while examining extensive data of a report document. All HTML5-based report viewers provide support for freezing in Interactive rendering mode and all report designers provide support for enabling the functionality. Header freezing is supported also in Web Report Designer Preview mode.
|
||||
Freezing the table headers prevents the row and/or column headers of a table from scrolling out of view while examining extensive data of a report document. All HTML5-based report viewers provide support for freezing in `Interactive` rendering mode and all report designers provide support for enabling the functionality. Header freezing is also supported in the Web Report Designer Preview mode.
|
||||
|
||||
## Settings in the Report Designers
|
||||
|
||||
Each table or crosstab has [FreezeColumnHeaders](/reporting/api/Telerik.Reporting.Table#Telerik_Reporting_Table_FreezeColumnHeaders) and [FreezeRowHeaders](/reporting/api/Telerik.Reporting.Table#Telerik_Reporting_Table_FreezeRowHeaders) properties:
|
||||
Each table or crosstab has [FreezeColumnHeaders](api/Telerik.Reporting.Table#Telerik_Reporting_Table_FreezeColumnHeaders) and [FreezeRowHeaders](/api/Telerik.Reporting.Table#Telerik_Reporting_Table_FreezeRowHeaders) properties:
|
||||
|
||||
* FreezeColumnHeaders keeps the column headers visible while scrolling vertically.
|
||||
* `FreezeColumnHeaders` keeps the column headers visible while scrolling vertically.
|
||||
|
||||
* FreezeRowHeaders keeps the row headers visible while scrolling horizontally.
|
||||
* `FreezeRowHeaders` keeps the row headers visible while scrolling horizontally.
|
||||
|
||||
To keep the table headers visible while scrolling:
|
||||
|
||||
1. Select a table/crosstab component from the __Explorer tab__ , or click the corner handle of a table data region, and then go to its Properties pane on the right.
|
||||
1. Select a table/crosstab component from the `Explorer` tab , or click the corner handle of a table data region, and then go to its `Properties` pane on the right.
|
||||
|
||||
1. Under __Layout__ , select which headers (row, column or both) should remain visible while scrolling.
|
||||
1. Under `Layout`, select which headers (row, column or both) should remain visible while scrolling.
|
||||
|
||||
|
||||
|
||||
|
||||
## Settings in the Report Viewers
|
||||
|
||||
The HTML5 Viewer automatically applies the freeze functionality in __[Interactive mode]({%slug telerikreporting/using-reports-in-applications/display-reports-in-applications/interactive-vs.-print-layout%})__ when it is enabled from the designers. The picture below shows a report with frozen row and column headers:
|
||||
The HTML5 Viewer automatically applies the freeze functionality in __[Interactive mode]({%slug telerikreporting/using-reports-in-applications/display-reports-in-applications/interactive-vs.-print-layout%})__ when it is enabled from the designers. The picture below shows a report with frozen row and column headers:
|
||||
|
||||
|
||||
|
||||
|
||||
## Behaviour
|
||||
|
||||
If the cells of the table headers have no or transparent background color, in order to preserve readability, their parent's background color is applied to them while scrolling.
|
||||
If the cells of the table headers have no or transparent background color, in order to preserve readability, their parent's background color is applied to them while scrolling.
|
||||
|
||||
When *PageBreak* is set to a group, FreezeRowHeaders and FreezeColumnHeaders will work only if *RowHeadersPrintOnEveryPage* and *ColumnHeadersPrintOnEveryPage* , respectively, are also set to true. Otherwise, the headers will be frozen only on the first page.
|
||||
When `PageBreak` is set to a group, `FreezeRowHeaders` and `FreezeColumnHeaders` will work only if `RowHeadersPrintOnEveryPage` and `ColumnHeadersPrintOnEveryPage` , respectively, are also set to true. Otherwise, the headers will be frozen only on the first page.
|
||||
|
||||
Even though the List report item has FreezeRowHeaders and FreezeColumnHeaders in the Properties pane, it doesn't have any headers and therefore, this feature is not applicable to it.
|
||||
>note Even though the List report item has `FreezeRowHeaders` and `FreezeColumnHeaders` in the Properties pane, it doesn't have any headers and therefore, this feature is not applicable to it.
|
||||
|
||||
## See Also
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: How to Add a Table of Contents to Report Book
|
||||
page_title: How to Add a Table of Contents to Report Book
|
||||
description: How to Add a Table of Contents to Report Book
|
||||
title: Report Book TOC
|
||||
page_title: Integrating Table of Contents inside a Report Book
|
||||
description: "Learn how to display the TOC(Table of Contents) section inside a Report Book."
|
||||
slug: telerikreporting/designing-reports/adding-interactivity-to-reports/table-of-contents/how-to-add-a-table-of-contents-to-report-book
|
||||
tags: how,to,add,a,table,of,contents,to,report,book
|
||||
published: True
|
||||
|
|
@ -13,15 +13,15 @@ previous_url: /table-of-contents-report-book
|
|||
|
||||
You can add a table of contents to the report book and click on entries in the table of contents to jump to specific areas within any report.
|
||||
|
||||
>important The TocReportSource should be a dedicated Report that contains significant information only in its TOC section. Including other content in this Report may result in an unexpected behavior as incorrectly ordered sections and wrong page numbering.
|
||||
>important The `TocReportSource` should be a dedicated Report that contains significant information only in its TOC section. Including other content in this Report may result in an unexpected behavior as incorrectly ordered sections and wrong page numbering.
|
||||
|
||||
## Adding a table of contents to a Report Book
|
||||
|
||||
1. Create a new report, add a TOC section to it, and configure its Title, Levels, and Styles as described in the [Overview]({%slug telerikreporting/designing-reports/adding-interactivity-to-reports/table-of-contents/overview%}) article. This special purpose report with its TOC section will be used to display the TOC entries from all of the reports in the Report Book.
|
||||
|
||||
1. Tell the Report Book that it needs to use the specially created TOC report in step 1 to display its Table of Contents. This is achieved by setting the [TocReportSource](/reporting/api/Telerik.Reporting.ReportBook#Telerik_Reporting_ReportBook_TocReportSource) property of the Report Book. In Visual Studio you can set the property using the Report Book designer (double-click on your Report Book class) or programmatically. In Standalone Report Designer you can set the TOC report source by clicking the corresponding button from the top menu. You need to use a suitable report source in this step. For more information please see [Report Sources Overview]({%slug telerikreporting/designing-reports/report-sources/overview%}).
|
||||
1. Tell the Report Book that it needs to use the specially created TOC report in step 1 to display its Table of Contents. This is achieved by setting the [TocReportSource](/api/Telerik.Reporting.ReportBook#Telerik_Reporting_ReportBook_TocReportSource) property of the Report Book. In Visual Studio you can set the property using the Report Book designer (double-click on your Report Book class) or programmatically. In Standalone Report Designer you can set the TOC report source by clicking the corresponding button from the top menu. You need to use a suitable report source in this step. For more information please see [Report Sources Overview]({%slug telerikreporting/designing-reports/report-sources/overview%}).
|
||||
|
||||
1. Configure where the TOC will appear in the Report Book. You can choose to position it before all of the reports or after them by setting the [TocPosition](/reporting/api/Telerik.Reporting.ReportBook#Telerik_Reporting_ReportBook_TocPosition) property.
|
||||
1. Configure where the TOC will appear in the Report Book. You can choose to position it before all of the reports or after them by setting the [TocPosition](/api/Telerik.Reporting.ReportBook#Telerik_Reporting_ReportBook_TocPosition) property.
|
||||
|
||||
## See Also
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Table of Contents Overview
|
||||
page_title: Table of Contents Overview
|
||||
description: Table of Contents Structure and Levels Explained
|
||||
title: Overview
|
||||
page_title: Table of Contents in a Report
|
||||
description: "Learn how to add a TOC(Table of Contents) section to your report, as well as how to change its Structure and how the TOC Levels are determined."
|
||||
slug: telerikreporting/designing-reports/adding-interactivity-to-reports/table-of-contents/overview
|
||||
tags: overview
|
||||
published: True
|
||||
|
|
@ -13,11 +13,11 @@ previous_url: /table-of-contents
|
|||
|
||||
The table of contents (TOC) provides a summary/overview of the report structure and a set of navigational links to report items in the rendered report and displays the page numbers of the pages where these report items are located. The user can click the entries in the table of contents to navigate to the report page which displays that item. The table of contents is part of the report and can be displayed before or after the report header/footer section. As such it will be included in the page numbering of the report. The following image illustrates the table of contents section during design-time and at run-time.
|
||||
|
||||
|
||||
|
||||
|
||||
The table of contents can be added to the report by enabling it from the report's context menu:
|
||||
|
||||
|
||||
|
||||
|
||||
## Structure
|
||||
|
||||
|
|
@ -27,7 +27,7 @@ At run-time, the table of contents entries are defined by the [TocText](/api/Tel
|
|||
|
||||
The table of contents definition contains a title and a hierarchy of levels. The title text can be configured using the [Title](/api/Telerik.Reporting.TocSection#Telerik_Reporting_TocSection_Title) property. Its style is controlled via the [TitleStyle](/api/Telerik.Reporting.TocSection#Telerik_Reporting_TocSection_TitleStyle) property.
|
||||
|
||||
|
||||
|
||||
|
||||
The [Levels](/api/Telerik.Reporting.TocSection#Telerik_Reporting_TocSection_Levels) property contains the properties and styles for each TOC level. The hierarchy of levels corresponds to the hierarchical structure of the report sections, items, and groups for which the [TocText](/api/Telerik.Reporting.ReportItemBase#Telerik_Reporting_ReportItemBase_TocText) property is set. The properties and styles of a particular level in the Levels collection will be applied only to TOC entries for report sections/items/groups which have the exact same level in the report hierarchy.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Tooltips
|
||||
page_title: Tooltips
|
||||
description: Tooltips
|
||||
page_title: Tooltips at a Glance
|
||||
description: "Learn how to add tooltips to report elements in a Telerik Report as well as how to configure them in the Report Viewers."
|
||||
slug: telerikreporting/designing-reports/adding-interactivity-to-reports/tooltips
|
||||
tags: tooltips
|
||||
published: True
|
||||
|
|
@ -9,28 +9,28 @@ position: 4
|
|||
previous_url: /designing-reports-interactivity-tooltips
|
||||
---
|
||||
|
||||
# Tooltips
|
||||
# Tooltips Overview
|
||||
|
||||
Tooltips are added since Telerik Reporting R1 2017. The feature allows you add custom text and title of a box displayed on hover of an element in a Telerik Report. All report viewers provide support for displaying tooltips in a report viewer’s native rendering technology. Tooltips are supported also in PDF files.
|
||||
Tooltips are added since Telerik Reporting `R1 2017`. The feature allows you add custom text and title of a box displayed on hover of an element in a Telerik Report. All report viewers provide support for displaying tooltips in a report viewer’s native rendering technology. Tooltips are supported also in PDF files.
|
||||
|
||||
## Settings in Reports
|
||||
|
||||
Each Report section and item has a __Tooltip property__ where you can configure the __Text__ you want to appear on hover. You can also specify a __Title__ for the tooltip's box.
|
||||
Each Report section and item has a `Tooltip` property where you can configure the `Text` you want to appear on hover. You can also specify a `Title` for the tooltip's box.
|
||||
|
||||
The Series collection of the [Graph item]({%slug telerikreporting/designing-reports/report-structure/graph/overview%}) also has support for tooltips.
|
||||
|
||||
## Settings in Viewers
|
||||
|
||||
The HTML5 Viewer (JavaScript, MVC and WebForms), WinForms ReportViewer and WPF ReportViewer controls have __ToolTipOpening__ events. In this events you can modify tooltips content:
|
||||
The HTML5-based Report Viewers, WinForms ReportViewer and WPF ReportViewer controls have `ToolTipOpening` events. In those events you can modify tooltips content:
|
||||
|
||||
* __HTML5 Viewer:__ [viewerToolTipOpening(e, args)]({%slug telerikreporting/using-reports-in-applications/display-reports-in-applications/web-application/html5-report-viewer/api-reference/reportviewer/events/viewertooltipopening(e,-args)%})
|
||||
* __HTML5 Report Viewer:__ [viewerToolTipOpening(e, args)]({%slug telerikreporting/using-reports-in-applications/display-reports-in-applications/web-application/html5-report-viewer/api-reference/reportviewer/events/viewertooltipopening(e,-args)%})
|
||||
|
||||
* __WPF ReportViewer control:__ [ViewerToolTipOpening](/reporting/api/Telerik.ReportViewer.Wpf.ReportViewer#Telerik_ReportViewer_Wpf_ReportViewer_ViewerToolTipOpening) event.
|
||||
|
||||
* __WinForms ReportViewer control:__ [ViewerToolTipOpening](/reporting/api/Telerik.ReportViewer.WinForms.ReportViewerBase#Telerik_ReportViewer_WinForms_ReportViewerBase_ViewerToolTipOpening) event.
|
||||
|
||||
>note If you use the HTML5 Viewer, the new Tooltips functionality requires additional Kendo UI dependency. This dependency is included in the Kendo UI subset bundle provided by Telerik Reporting - *telerikReportViewer.kendo-{{site.kendosubsetversion}}.min.js*.
|
||||
>If you use a custom set of Kendo UI widgets, you can load __kendo.tooltip.min.js__ of your version (2015.3.1111+) of Kendo UI.
|
||||
>If you use a custom set of Kendo UI widgets, you can load __kendo.tooltip.min.js__ of your version ({{site.kendosubsetversion}}+) of Kendo UI.
|
||||
|
||||
## See Also
|
||||
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче