HiQPdf Documentation

PdfDocTableOfContents Properties

Quickly Create High Quality PDFs

The PdfDocTableOfContents type exposes the following members.

Properties

  NameDescription
Public propertyAddPageNumbers
Controls if the table of contents entries will have page numbers. This property is true by default
(Inherited from PdfTableOfContents.)
Public propertyBackgroundColor
The table of contents background color
(Inherited from PdfTableOfContents.)
Public propertyCloseAdditionalDocuments
Controls if the external documents inserted before the table of contents are closed when the document is saved. This property is true by default
Public propertyDisplayFooter
Controls if the footer is displayed on the table of content pages. The footer is displayed by default
(Inherited from PdfTableOfContents.)
Public propertyDisplayHeader
Controls if the header is displayed on the table of content pages. The header is displayed by default
(Inherited from PdfTableOfContents.)
Public propertyExclusivePageNumbering
Controls if the page numbering in table of contents excludes the table of contents pages. By default this property is false
(Inherited from PdfTableOfContents.)
Public propertyFirstPageIndex
The index considered for the first page in PDF document when numbering the pages in table of contents. This property can be used to alter the page numbers in table of contents with a constant value. By default this property is 0
(Inherited from PdfTableOfContents.)
Public propertyMaxTextChars
The maximum number of characters of the table of contents entry text. By default there is no limit
(Inherited from PdfTableOfContents.)
Public propertyNewSectionForEachHtml
Controls if a new section is started in the table of contents for each HTML document added to this PDF document. This property is true by default
Public propertyTablePageCount
The number of PDF pages used by table of contents
(Inherited from PdfTableOfContents.)
Public propertyTablePageIndex
The index in document of the PDF page where the table of contents is rendered
(Inherited from PdfTableOfContents.)
Public propertyTableStyle
The style of the table of contents. For example, you can change the table of contents background color if you set this property with "body { background-color:green }"
(Inherited from PdfTableOfContents.)
Public propertyTableTitle
The table of contents title
(Inherited from PdfTableOfContents.)
Public propertyTableTitleStyle
The table of contents title style can be set as a regular CSS style, for example "color:red; background-color:green"
(Inherited from PdfTableOfContents.)
Public propertyTableWidth
The table of contents width in pixels
(Inherited from PdfTableOfContents.)
Public propertyTocEntriesForHeadingTags
Controls if the heading tags H1, H2, H3, H4, H5, H6 are automatically added a entries into the table of contents. This property is false by default
(Inherited from PdfTableOfContents.)
Top
See Also

Reference