PdfTableOfContents Class

Controls the automatic creation of the table of contents in PDF from HTML heading tags

Definition

Namespace: HiQPdf.Next
Assembly: HiQPdf.Next (in HiQPdf.Next.dll) Version: 18.0.0
C#
public class PdfTableOfContents
Inheritance
Object    PdfTableOfContents

Constructors

PdfTableOfContentsInitializes a new instance of the PdfTableOfContents class

Properties

AddPageNumbers Controls if the table of contents has page numbers for entires. The default value is true
CountStartPages Controls if the external PDF pages inserted before it are counted in page numbers displayed in table of contents. The property does not have any effect for inline table of contents. The default value is true
CountTocAndExternalPages Controls if table of contents pages and the external PDF pages inserted before it are counted in page numbers displayed in table of contents. The property does not have any effect for inline table of contents. The default value is true
CountTocPages Controls if table of contents pages are counted in page numbers. The property does not have any effect for inline table of contents. The default value is true
Inline A flag indicating whether the table of contents is integrated into the document being converted. In the context of the HTML to PDF Converter, its position is determined by a DIV element with the ID 'html-to-pdf-toc'. If such an element is not predefined in the HTML, it will be created by the converter. When creating a table of contents for other types of documents, the inline table of contents is created at the beginning of the document.
PageNumbersOffset An offset to be applied to all page numbers in the table of contents. This property can be useful when merging a PDF with a table of contents with other PDF documents. The default value is 0
Style The table of contents CSS style
Title The table of contents title
UseBrowserMode Control if the browser or custom mode is used to create the table of contents non inline table of contents. The default value is false

Methods

Equals
(Inherited from Object)
Finalize
(Inherited from Object)
GetHashCode
(Inherited from Object)
GetType
(Inherited from Object)
MemberwiseClone
(Inherited from Object)
ToString
(Inherited from Object)

See Also