mlreportgen.dom.LOT class
Package: mlreportgen.dom
Superclasses: mlreportgen.dom.LOC
List of tables
Description
Use an object of the mlreportgen.dom.LOT
class to create a list of tables
in a report.
Each list item contains the title of a table and links to the title in the report. In a
PDF or Microsoft® Word report, a list item also includes the page number and a leader that fills the
space between the title and page number. In a PDF or Word report, the list is located at the
point in the report where you append the LOT
object. In an HTML report, the
list is located in a sidebar with the title List of Tables
.
The way a list is generated depends on the report type.
PDF — The DOM API generates the list during report generation.
Word — The DOM API generates a placeholder for the list. To generate the list items, you must update the Word document in your report generation program or in Word. See Update a Table of Contents or Generated List in a Word Document.
HTML — The DOM API generates a placeholder for the list. When the report opens in an HTML browser, the browser generates the list.
To include tables in the list of tables:
Create titles for the tables using
mlreportgen.dom.Paragraph
objects.Associate the
Paragraph
objects with a numbering stream that has the nametable
by using anmlreportgen.dom.AutoNumber
object.
The mlreportgen.dom.LOT
class is a handle
class.
Class Attributes
ConstructOnLoad | true |
HandleCompatible | true |
For information on class attributes, see Class Attributes.
Creation
Description
creates an LOTObj
= mlreportgen.dom.LOT()
mlreportgen.dom.LOT
object and sets the LeaderPattern property to '.'
.
creates an LOTObj
= mlreportgen.dom.LOT(leaderPattern)
mlreportgen.dom.LOT
object and sets the LeaderPattern property to the specified leader pattern.