PdfDocumentTableOfContents Class

EVO HTML to PDF Converter Client Documentation
This class contains the necessary properties to control the creation of a table of contents in a PDF document based on the HTML to PDF and HTML to Image elements added to document
Inheritance Hierarchy

SystemObject
  EvoPdf.HtmlToPdfClientTableOfContentsOptions
    EvoPdf.HtmlToPdfClientPdfDocumentTableOfContents

Namespace:  EvoPdf.HtmlToPdfClient
Assembly:  EvoHtmlToPdfClient (in EvoHtmlToPdfClient.dll) Version: 7.5.0.0 (7.5.0.0)
Syntax

public class PdfDocumentTableOfContents : TableOfContentsOptions

The PdfDocumentTableOfContents type exposes the following members.

Constructors

  NameDescription
Public methodPdfDocumentTableOfContents
Initializes a new instance of the PdfDocumentTableOfContents class
Top
Properties

  NameDescription
Public propertyAutoTocItemsEnabled
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
(Inherited from TableOfContentsOptions.)
Public propertyBackColor
The background color of the PDF pages on which the table of contents is created
(Inherited from TableOfContentsOptions.)
Public propertyGlobalStyle
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
(Inherited from TableOfContentsOptions.)
Public propertyMaxTocItemTitleLength
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
(Inherited from TableOfContentsOptions.)
Public propertyPageCount
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
(Inherited from TableOfContentsOptions.)
Public propertyPageNumberingStartIndex
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
(Inherited from TableOfContentsOptions.)
Public propertyPageNumbersEnabled
A flag indicating if the table of contents items will have page numbers besides the title. By default this property is true
(Inherited from TableOfContentsOptions.)
Public propertyResetLevelBeforeElement
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
Public propertyShowFooter
A flag indicating if the document footer is displayed on the table of content pages or not
(Inherited from TableOfContentsOptions.)
Public propertyShowHeader
A flag indicating if the document header is displayed on the table of content pages or not
(Inherited from TableOfContentsOptions.)
Public propertyStartPageIndex
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
(Inherited from TableOfContentsOptions.)
Public propertyStartPageNumbersAfterTOC
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
(Inherited from TableOfContentsOptions.)
Public propertyTitle
Gets or sets the table of contents title
(Inherited from TableOfContentsOptions.)
Public propertyTitleStyle
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
(Inherited from TableOfContentsOptions.)
Public propertyWidth
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
(Inherited from TableOfContentsOptions.)
Top
Methods

  NameDescription
Public methodAddStartDocument(Byte, Boolean, Boolean, Boolean)
Adds a PDF document from the given stream before the table of contents
Public methodAddStartDocument(String, Boolean, Boolean, Boolean)
Adds a PDF document from the given file before the table of contents
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 methodSetItemStyle
Sets the style of a table of contents item on a given level. The item level is a number from 1 to 6
(Inherited from TableOfContentsOptions.)
Public methodSetPageNumberStyle
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
(Inherited from TableOfContentsOptions.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also

Reference