TOC Properties
Designer provides the TOC object for each page report tab and web report in the Report Inspector. You can use it to customize the appearance and accessibility attributes of the TOC tree that displays in the TOC Browser of Page Report Studio, and in the Table of Contents panel of the PDF and HTML browsers themselves if you select to include it in the outputs. This topic describes the properties of the TOC 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. |
Root Label | Page Report, Web Report | Specifies the label you want to display on the root of the TOC tree. 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 |
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 |
External ID | Query Page Report | This property is mapped to the HTML attribute id, as specified by w3.org. Data type: String |
External Style | Query Page Report | This property is mapped to the HTML attribute style, as specified by w3.org. Data type: String |
External Title | Query Page Report | This property is mapped to the HTML attribute title, as specified by w3.org. Data type: String |
Language | Query Page Report | This property is mapped to the HTML attribute lang, as specified by w3.org. Data type: String |