Table of Contents report element

NAVIGATION   Modules > Advanced Reporting > Create icon > Create Report > select report type > Create > Table of Contents

NAVIGATION   Modules > Advanced Reporting > Categories icon > click a row > Edit > Table of Contents

SECURITY  Advanced Reporting > View Reporting and run reports

The Table of Contents element is used to display the document map of the report. A document map is a visual tool used to display the hierarchy of the report elements. This element allows you to quickly understand the contents of the report and to navigate inside a report using the organized hierarchy of the report headings and labels.

This element is available in the Page and RDL reports only. It can be used to render or print the table of contents of the report.

IMPORTANT  Before adding a Table of Contents to your report, it is important that you label all report controls that you want to display in the Table of Contents. You can do this in the Properties of each element within Misc: 

If you are unable to see the Label property, or are missing the Misc section entirely, ensure that you are in Show Advanced Properties mode:

  1. From the report toolbox on the left, drag and drop the Table of Contents element into the design area.
  2. Using the Properties pane, customize the appearance of the element. Refer to Table of Contents properties.

You can customize the appearance of a Table of Contents in the Properties pane.

NOTE  *Properties only visible in Show Advanced Properties mode are marked with a red asterisk.

Property Description
Common
  • Name: Add a unique name to the element. Special characters such as period (.), space ( ), forward slash (/), backslash (\), exclamation marks (!), and hyphens (-) are not supported. You can use an underscore (_) in the name of the element.
Background

  • Color: Select a background color for the element.
Border
  • Width: You can set the width of the text box border using this option. By default, the width is 1pt.
  • Style: Select the border style from the drop-down list. By default, the border style is none.
  • Color: Select the border color from the drop-down list. By default, the color is black.
Dimensions This sets the location and size of the Table of Contents.
  • Left: This option sets the distance to be maintained from the upper-left side of the list horizontally.
  • Top: This option sets the distance to be maintained from the top of the list vertically.
  • Width: This option sets the width of the element.
  • Height: This option sets the height of the element.
Layout
  • Style: Select a color theme for the element from the drop-down.
  • Page Break: Select a page break option (None, Start, End, StartAndEnd, or Between).
  • New Page: Select an option to start the content after a page break. The available options are Next, Odd, and Even.
  • *Layer Name: Sets the report layer.
  • *Z-Index: This property sets the position of the Table of Contents. Elements with a greater Z-Index value will always be in front of the control that has a lower Z-Index value.
*Visibility
  • Hidden: This option sets whether to hide the table of contents or not on the preview.
  • Toggle Item: Visibility can be toggled by another report item. This option sets another item, such as another text box, as a toggle button to display the current text box or not.
Data
  • Max Level: Set the maximum level of the data in the element.
  • *Element Name: Enter a name to be used in the XML output for this element.
  • *Element Output: Choose Auto, Output, NoOutput, or ContentsOnly to decide whether to include this control in the XML output. Choosing Auto exports the contents of the element.
*Misc
  • Tooltip: Sets the textual label of the element when the mouse is moved over the cell.
  • Label: Sets a textual content that is used as the display text for report catalog items. The report catalog is made using the Table of Contents element in the toolbox, and the Table of Contents is used for quick positioning jumps in multi-page reports.
  • Bookmark: Enter text or an expression to use as a positioning identifier to jump to this element. You can define the bookmark and then select the Jump to bookmark setting, to make it easier to jump between report content. You can bookmark any element in the report to make it a destination anchor for the jump.