ActiveReports 17 .NET Edition
Report Authors: Designer Components / Design Reports / Design Page/RDL Reports / Interactivity / Document Map
In This Topic
    Document Map
    In This Topic

    When you click an item in the document map, the viewer jumps to that item in the report.

    A document map functions as a table of contents and provides a convenient way to navigate a lengthy report.

    In a Page or an RDL report, you can add report controls, data regions, groups and detail groups to the document map by:

    Viewing the Document Map

    1. On the Viewer toolbar, click the Side Panel button to display the sidebar.
      Side Panel button in the Viewer toolbar
    2. At the bottom of the sidebar pane, click the Document map button to display the document map.
      Document Map button in the sidebar pane
      If there is no document map associated with the report, the button does not appear at the bottom of the sidebar pane.
    3. In the Document map that appears, click the item you want to view in the report.

    Exporting Document Map

    At preview, the document map appears in a sidebar to the left of the report, but when you export your report to various file formats, they handle document maps differently.

    Export Filter Effect on Document Map
    HTML A .toc file containing the document map is exported along with the HTML report.
    PDF Document map appears in the bookmarks panel.
    Text Document map does not appear in the exported report.
    Rich Text Format Document map does not appear in the exported report.
    TIFF Document map does not appear in the exported report.
    Excel Document map does not appear in the exported report.
    Note: For printing and rendering purposes use Table of Contents control in your Page report and RDL report.

    To add a control to the Document Map

    Using Document Map Label or Label Property 

    1. On the design surface, select a control you want to add to the Document map and right-click to choose Properties from the context menu.
    2. In the command section of the Properties Panel, click the Property dialog open the control's dialog.
    3. In the dialog that appears, go to the Navigation page and under the Document map label, enter a text or an expression representing the control in the Document map.

    Alternatively,

    1. On the design surface, select the report control you want to add to the Document map and right-click to choose Properties from the context menu.
    2. In the Properties window that appears, enter a text or an expression in the Label property to represent the report control in the Document map.

    Using HeadingLevel Property

    1. On the design surface, select the report control you want to add to the Document map (e.g. TextBox).
    2. In the Properties window that appears, set the HeadingLevel property of the report control.
      Note The HeadingLevel property defines the DocumentMap level for that control.
    3. Preview the report to view the document map.
      Report sample with Document Map at preview

    To create a hierarchical Document Map

    1. Open a report that contains a data region like a Table.
    2. Select the data region and in the Properties Panel that appears, select the Property dialog command at the bottom of the window to open the data region dialog.
    3. On the data region dialog, on the Groups page, set the grouping expression. For example, group the data on YearReleased (=Fields!YearReleased.Value).
    4. On the same Groups page, set the Document map label to the value of the grouping expression. For example, =Fields!YearReleased.Value.
    5. On the design surface, select a control inside the data region. For example, the TextBox in the detail row of the Table data region.
    6. Right-click the control and select properties to open the Properties Panel. In the command section of the Properties Panel, click Property dialog.
    7. In the dialog that appears, go to the Navigation page and under the Document map label, enter a text or an expression representing the control in the Document map.
    8. Preview the report to view the document map.
      Report sample with a hierarchical Document Map at preview
    Note: In an Page report, you can also set grouping and set the document map label on the FixedPage dialog > Groups page.

    To set the numbering style for Document Map levels

    You can the set the numbering style for all document map levels using the Report dialog or in the Properties Panel using the DocumentMap property.

    1. In the Report Explorer select the Report item.
    2. In the command section of the Properties Panel, click Property dialog to open the Report dialog.
    3. In the Report dialog that appears, go to the Document Map page and set the Source property to one of the available value.
    4. Set the Numbering Style to one of the available formats. The selected style would get applied to all the document levels and only to the selected source that you had set above.
    5. Click OK to close the dialog.

    You can also set separate numbering style to different document map levels using the DocumentMapLevelDesigner Collection Editor dialog.

    1. In the Report Explorer select the Report item.
    2. Go to the Properties Panel, click the Levels (Collection) property and then click the ellipsis button that appears.
      Report Levels Collection property for designing document map levels style
    3. In the DocumentMapLevelDesigner Collection Editor dialog that appears, consider the hierarchy of report bookmarks that appears in Document Map and add as many levels required using the Add button.
    4. Select each level and set its NumberingStyle to any of the available format.
    5. Click OK to close the dialog.
    Note: Any customization made here gets directly applied to the Table of Contents control.