HiQPdf Documentation

PdfTableOfContents Class

Quickly Create High Quality PDFs
Controls the automatic creation of the table of contents for the converted HTML document
Inheritance Hierarchy

SystemObject
  HiQPdfPdfTableOfContents
    HiQPdfPdfDocTableOfContents

Namespace:  HiQPdf
Assembly:  HiQPdf (in HiQPdf.dll) Version: 15.0.0.0
Syntax

public class PdfTableOfContents

The PdfTableOfContents 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
Public propertyBackgroundColor
The table of contents background color
Public propertyDisplayFooter
Controls if the footer is displayed on the table of content pages. The footer is displayed by default
Public propertyDisplayHeader
Controls if the header is displayed on the table of content pages. The header is displayed by default
Public propertyExclusivePageNumbering
Controls if the page numbering in table of contents excludes the table of contents pages. By default this property is false
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
Public propertyMaxTextChars
The maximum number of characters of the table of contents entry text. By default there is no limit
Public propertyTablePageCount
The number of PDF pages used by table of contents
Public propertyTablePageIndex
The index in document of the PDF page where the table of contents is rendered
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 }"
Public propertyTableTitle
The table of contents title
Public propertyTableTitleStyle
The table of contents title style can be set as a regular CSS style, for example "color:red; background-color:green"
Public propertyTableWidth
The table of contents width in pixels
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
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSetPageNumberStyle
Call this method to set the CSS style of the page numbers for a level in table of contents
Public methodSetTocEntryStyle
Call this method to set the table of contents entry CSS style for a level
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also

Reference