Previous Topic
TOC Container Properties
When you insert the TOC Page object in a page report tab or web report, Designer automatically creates the TOC Container object in the Report Inspector to represent the Table of Contents generated via the TOC Page object. You can edit properties of the object to customize the font style, indentation, line spacing, and so on of the entries in the Table of Contents. This topic describes the properties of the TOC Container object.
Designer provides some properties only when you use the object in certain report types. You can get details from the Available For column in the property table.
| Property Name | Available For | Description |
|---|---|---|
| General | ||
| Class Type | Query Page Report | Shows the class type of the object. This property is read only. |
| Instance Name | Query Page Report | Shows the instance name of the object. This property is read only. |
| Title | Page Report, Web Report | Specifies the text you want to display as the title of the TOC. Data type: String |
| Color | ||
| Background | Page Report, Web Report | Specifies the background color of the object. Choose a color from the drop-down list or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String |
| Foreground | Page Report, Web Report | Specifies the foreground color of the object. Choose a color from the drop-down list or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String |
| CSS | ||
| Class | Page Report, Web Report | Specifies the name of the Class Selector to apply to the object, which you define in the CSS file of the style the report applies.
For example, if you define the CSS file as follows:
To apply the Class Selector in the file to the object, type C in the value cell. Data type: String |
| Style | Page Report, Web Report | Specifies the style you want to apply to the object. You can specify the style in two ways:
Data type: String |
| Font | ||
| Bold | Page Report, Web Report | Specifies whether to apply bold formatting to the text in the object. Data type: Boolean |
| Font Face | Page Report, Web Report | Specifies the font face of the text in the object. Choose an option from the drop-down list.
Data type: Enumeration |
| Font Size | Page Report, Web Report | Specifies the font size of the text in the object. Type an integer value to change the size. Data type: Integer |
| Italic | Page Report, Web Report | Specifies whether to italicize the text in the object. Data type: Boolean |
| Strikethrough | Page Report, Web Report | Specifies whether to draw a line through the text in the object.
Data type: Boolean |
| Underline | Page Report, Web Report | Specifies whether to add a horizontal line under the text in the object. Data type: Boolean |
| Others | ||
| Item Indentation | Page Report, Web Report | Specifies the indentation for entries in the TOC.
Data type: Float |
| Leader | Page Report, Web Report | Specifies the character that leads each entry and its commencing page number in the TOC. The leader does not display when you set Show Page Numbers to "false". Data type: String |
| Line Spacing | Page Report, Web Report | Specifies the line spacing between two entries in the TOC.
Data type: Float |
| Position | Page Report, Web Report | Designer enables this property when the object is in a flow layout container, such as the report body or a tabular cell, text box, or KPI. You can use it to specify the position of the object in the container. Choose an option from the drop-down list. Data type: Enumeration |
| Show Page Numbers | Page Report, Web Report | Specifies whether to show the commencing page number of the entries in the TOC. Data type: Boolean |
| Accessibility | ||
| External CSS Class Selector | Query Page Report | Specifies the name of the Class Selector for the object in the HTML output. Data type: String |