PdfDocumentTableOfContents Class

Initializes a new instance of the PdfDocumentTableOfContents class

This flag indicates if the external documents added by the AddStartDocument() are automatically closed after the final document was generated. By default the external documents are closed

A flag indicating if the automatic creation of a table of contents items for the H1 to H6 HTML elements is enabled or not. By default this property is false

The background color of the PDF pages on which the table of contents is created

Gets or sets the global CSS style of the table of contents. For example, setting a "body{background-color:blue}" will set a blue color for the table of contents background

Gets or sets the maximum accepted length of the table of contents item title. If a positive value is set for this property the table of contents item title will be truncated if necessary. By default the table of contents item title will not be truncated

Returns the number of pages on which the table of contents is created and together with the StartPageIndex helps to localize the position of the table of contents inside the generated PDF document. This property is set by converter after the document with table of contents was generated

Gets or sets the start index for page numbering in the table of contents. This property can be correlated with the PageNumberingStartIndex property of header and footer

A flag indicating if the table of contents items will have page numbers besides the title. By default this property is true

This flag indicates if the table of contents items level is reset before each HTML to PDF and HTML to Image element added to document. By default this property is true

A flag indicating if the document footer is displayed on the table of content pages or not

A flag indicating if the document header is displayed on the table of content pages or not

Returns the index in PDF document of the page where the table of contents starts. This property is set by converter after the document with table of contents was generated

A flag indicating if the page numbers start after the table of contents. This property also changes the page numbering both in document header and footer and in the table of contents

Gets or sets the table of contents title

Gets or sets the global CSS style of the table of contents title. When this property is set with a value, the default style of the title is replaced with the style given by this property. For example, setting a "font-family: 'Times New Roman'; font-size:30px; font-weight:bold; color:red" style will make the converter to use the 'Times New Roman' bold font of 30 pixels and the blue color to write the table of contents title

Gets or sets the table of contents width in pixels. The table can be resized if necessary to fit the PDF page width. If the property is 0 then the converter will automatically set the width of the table of contents

Adds a PDF document object before the table of contents. If the AutoCloseExternalDocs property is true the added document will be automatically closed when the final document is closed or saved.

Adds a PDF document from the given stream before the table of contents. If the AutoCloseExternalDocs property is true the added document will be automatically closed when the final document is closed or saved

Adds a PDF document from the given file before the table of contents. If the AutoCloseExternalDocs property is true the added document will be automatically closed when the final document is closed or saved

Determines whether the specified Object is equal to the current Object.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Serves as a hash function for a particular type.

Gets the Type of the current instance.

Creates a shallow copy of the current Object.

Sets the style of a table of contents item on a given level. The item level is a number from 1 to 6

Sets the style of the page page numbers on a given level in the table of contents. The page number level is a number from 1 to 6

Returns a string that represents the current object.