PdfDocumentTableOfContents Class

The table of contents of a document created from code. The headings of the HTML content added to the document (the H1 to H6 tags and the elements marked with the data-heading attribute) are listed with their page numbers on pages inserted at the beginning of the document when the document is saved, each entry linking to its heading

Definition

Namespace: EvoPdf.Next
Assembly: EvoPdf.Next (in EvoPdf.Next.dll) Version: 15.0.0
C#
public class PdfDocumentTableOfContents
Inheritance
Object    PdfDocumentTableOfContents

Constructors

PdfDocumentTableOfContentsInitializes a new instance of the PdfDocumentTableOfContents class

Properties

CountTocPages Controls if the table of contents pages are counted in the page numbers displayed in the table of contents. The default value is true
Enabled A flag indicating whether the table of contents is generated when the document is saved. By default this property is false
HeadingSelectors The CSS selectors of the elements of the HTML content that become entries of the table of contents, one selector for each level: the first selector gives the level 1 entries, the second one the level 2 entries and so on, up to level 6. When this property is set the H1 to H6 headings and the data-heading attribute no longer select the entries, an element still being excluded with data-heading="false" and its title still being taken from data-heading-text when present. The default is null, the entries being created from the headings of the HTML content
PageNumbersBoldFont Gets or sets the default bold font used for page numbers. If not set but PageNumbersFont is set, that font will be used as a fallback. If PageNumbersFont is not set either, a default bold font will be used
PageNumbersBoldItalicFont Gets or sets the default bold italic font used for page numbers. If not set but PageNumbersFont is set, that font will be used as a fallback. If PageNumbersFont is not set either, a default bold italic font will be used
PageNumbersFont Gets or sets the default regular font used for page numbers. If not set, a default regular font will be used
PageNumbersItalicFont Gets or sets the default italic font used for page numbers. If not set but PageNumbersFont is set, that font will be used as a fallback. If PageNumbersFont is not set either, a default italic font will be used
PageNumbersOffset An offset to be applied to all the page numbers displayed in the table of contents. By default this property is 0
ShowPageNumbers A flag indicating if the table of contents includes page numbers for entries. By default this property is true
Style The table of contents CSS style. The default style can be replaced with a style for the html-to-pdf-toc element, its toc-title, level-N, toc-link, toc-link-level-N and page-link classes
Title The table of contents title

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