TableOfContentsOptions Class

This class encapsulates the options to control the table of content automatically generated in PDF from HTML heading tags

Definition

Namespace: Winnovative.Pdf.Next
Assembly: Winnovative.Pdf.Next (in Winnovative.Pdf.Next.dll) Version: 20.0.0
C#
public class TableOfContentsOptions
Inheritance
Object    TableOfContentsOptions

Constructors

TableOfContentsOptionsInitializes a new instance of the TableOfContentsOptions class

Properties

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
CountTocAndStartPages A flag indicating if the table of contents pages and the PDF pages inserted before the HTML content are counted when calculating the page numbers displayed in table of contents. The property does not apply for inline table of contents. By default this property 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
CreateInline 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. By defult this property is 0
ShowPageNumbers A flag indicating if the table of contents includes page numbers for entires. By default this property is true
Style The table of contents CSS style
Title The table of contents title
UseBrowserMode This property can be used to select between using the browser or custom mode to create the table of contents. This property has effect only when CreateInline is false. By default this property 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