TOC Properties
You can specify to show some objects in a page report or web report in a table of contents by setting their TOC Anchor and Anchor Display Value properties, so that when you preview the report in Logi Report format, export it to PDF or HTML, or run it in Page Report Studio for a page report, you can use the TOC tree to locate the objects. The appearance and behavior of the TOC is customizable. You can edit its properties, including the style, color, font, and accessibility attributes. This topic describes the properties of a 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 | Indicates 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 text of the label which will be displayed 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, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns 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, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns 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 make the text bold.
Data type: Boolean |
Font Face | Page Report, Web Report | Specifies the font of the text. Choose an option from the drop-down list.
Data type: Enumeration |
Font Size | Page Report, Web Report | Specifies the font size of the text. Type an integer value to change the size.
Data type: Integer |
Italic | Page Report, Web Report | Specifies whether to make the text italic.
Data type: Boolean |
Strikethrough | Page Report, Web Report | Specifies whether to add a strikethrough line to the text.
Data type: Boolean |
Underline | Page Report, Web Report | Specifies whether to underline the text.
Data type: Boolean |
Accessibility | ||
External CSS Class Selector | Query Page Report | Specifies a class selector to be applied to the object when exported as HTML. Type a valid class name from the CSS file.
Data type: String |
External ID | Query Page Report | It is mapped to the HTML attribute id. This attribute specifies a name to the object, which must be unique in the report.
Data type: String |
External Style | Query Page Report | It is mapped to the HTML attribute style. This attribute specifies style information for the object.
Data type: String |
External Title | Query Page Report | It is mapped to the HTML attribute title. This attribute offers advisory information about the object.
Data type: String |
Language | Query Page Report | It is mapped to the HTML attribute lang. This attribute specifies the base language of the object's attribute values and text content.
Data type: String |