HiQPdf Client for .NET Core
Pdf
Controls the automatic creation of the table of contents for the converted HTML document
Definition
Namespace: HiQPdfClient
Assembly: HiQPdfClient.NetCore (in HiQPdfClient.NetCore.dll) Version: 16.0.0
Assembly: HiQPdfClient.NetCore (in HiQPdfClient.NetCore.dll) Version: 16.0.0
C#
public class PdfTableOfContentsVB
Public Class PdfTableOfContentsC++
public ref class PdfTableOfContentsF#
type PdfTableOfContents = class end- Inheritance
- Object PdfTableOfContents
- Derived
Properties
| AddPageNumbers | Controls if the table of contents entries will have page numbers. This property is true by default |
| BackgroundColor | The table of contents background color |
| DisplayFooter | Controls if the footer is displayed on the table of content pages. The footer is displayed by default |
| DisplayHeader | Controls if the header is displayed on the table of content pages. The header is displayed by default |
| ExclusivePageNumbering | Controls if the page numbering in table of contents excludes the table of contents pages. By default this property is false |
| FirstPageIndex | 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 |
| MaxTextChars | The maximum number of characters of the table of contents entry text. By default there is no limit |
| TablePageCount | The number of PDF pages used by table of contents |
| TablePageIndex | The index in document of the PDF page where the table of contents is rendered |
| TableStyle | 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 }" |
| TableTitle | The table of contents title |
| TableTitleStyle | The table of contents title style can be set as a regular CSS style, for example "color:red; background-color:green" |
| TableWidth | The table of contents width in pixels |
| TocEntriesForHeadingTags | 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 |
Methods
| Equals | (Inherited from Object) |
| Finalize | (Inherited from Object) |
| GetHashCode | (Inherited from Object) |
| GetType | (Inherited from Object) |
| MemberwiseClone | (Inherited from Object) |
| SetPageNumberStyle | Call this method to set the CSS style of the page numbers for a level in table of contents |
| SetTocEntryStyle | Call this method to set the table of contents entry CSS style for a level |
| ToString | (Inherited from Object) |