Table of Contents Control

Description

The Table of Contents control auto-generates the contents of a report based upon the hierarchy of bookmarks contained in a report's document map.

If the report does not contain a report header band when you add the Table of Contents control, one will be created automatically, and the control will be moved into it.

Properties Common to Most Controls

For more information about the properties listed below, see Properties Common to Most Controls.

For more information regarding each of the property groups, see the Control Reference.

Behavior

Level Title

Sets the title of the table of contents. The property contains the following options:

  • Text: Sets the text to appear in the title.
  • Text Alignment: Specifies the alignment of the report item's text.

All other properties are documented in the Control Reference under the Appearance heading.

Level Default

Defines the default formatting properties for the hierarchical levels of the table of contents. The property contains the following options:

  • Leader Symbol: Specifies the leader symbol for the level. This symbol is repeated to fill the space between the level's text and the page number.
  • Indent: Specifies the indent for the level. Used to highlight the hierarchy of the bookmarks assigned to the elements of the report.

All other properties are documented in the Control Reference under the Appearance heading.

Levels

Specifies the configuration for individual levels in the table of contents. Once a level has been added, the following options are available:

  • Leader Symbol: Specifies the leader symbol for the level. This symbol is repeated to fill the space between the level's text and the page number.
  • Indent: Specifies the indent for the level. Used to highlight the hierarchy of the bookmarks assigned to the elements of the report.

All other properties are documented in the Control Reference under the Appearance heading.

Max Nesting Level

Type: Int32

Specifies the maximum number of levels that can be displayed in the table of contents. If set to 0, no limit is applied.

Printing

Right to Left

Specifies the layout of the content within a report item.

The options include:

  • Inherit: The item inherits the printing configuration set at the parent level. This is the default.
  • Yes: The content is aligned to the right.
  • No: The content is aligned to the left.

Related Tutorials

Refer to the following resources for additional help on implementing this control:

© 2020 VertiGIS North America Ltd. All Rights Reserved.

Documentation Version 5.10