Studio Reports Table of Content
Kyvos Reporting Studio supports embedding a clickable Table of Contents (TOC) page at the beginning of a report. The TOC lists major sections and sub-sections from the main report and sub-reports, enabling users to jump directly to those sections in live and exported formats (PDF, Word).
Add a Table of Contents Page
Step 1: Add Section Headings
Open your report in Studio.
Insert a text-type or label control where you want a section heading.
In the Properties pane, set Class Name to TOCHeading.
Set the control text (e.g., “Sales Summary”).
Step 2: Insert Link Controls in TOC Page
Create a TOC page at the beginning of the main report above the TOCHeading fields.
Insert a text-type control to set the page numbers for each entry you want in the TOC.
In the Properties pane, set Class Name to TOCPageNumber.
TOCPageNumber must be created next to TOCHyperlink.
Step 3: Add Clickable TOC Hyperlinks
Insert a text-type control before the page number (e.g., the TOC entry name).
In the Properties pane, set Class Name to TOCHyperlink.
As a best practice, match the hyperlink text to the heading it should link to. (Optional)
Note
The system uses the TOC information to establish logical links between the TOCHeading, TOCPageNumber, and TOCHyperlink in the report. Title text top value must match exactly between TOCPageNumber and TOCHyperlink to ensure proper mapping and page number resolution.
Properties Reference
TOC Control Properties
Property | Description |
|---|---|
Class Name | Indicates the control’s TOC role (heading, page number, or hyperlink). |
TOCPageNumber | Stores and displays the dynamic page number for a matching heading. |
TOCHeading | Defines a heading that appears in the report as a navigable target. |
TOCHyperlink | Creates a clickable link to jump to a matching TOCHeading section. |
Mapping Logic
Rule | Description |
|---|---|
Text Top Value Match | TOCPageNumber and TOCHyperlink Top values must match for successful mapping. |
Order Match | Mapping is done based on the order of appearance in the report. |
Cross-Report Support | TOC controls can exist in different sub-reports; mapping works globally. |
Export and Navigation Behavior
Feature | Behavior |
|---|---|
Clickable Links | Available in live report viewer and exported PDF/Word files. |
Scheduled Reports | Page numbers are computed at runtime; links work in exported output (PDF and Word). |