HiQPdf Client for .NET Core
Pdf
Controls the automatic creation of the table of contents in a PDF 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 PdfDocTableOfContents : PdfTableOfContentsVB
Public Class PdfDocTableOfContents
Inherits PdfTableOfContentsC++
public ref class PdfDocTableOfContents : public PdfTableOfContentsF#
type PdfDocTableOfContents =
class
inherit PdfTableOfContents
end- Inheritance
- Object PdfTableOfContents PdfDocTableOfContents
Constructors
| PdfDocTableOfContents | Initializes a new instance of the PdfDocTableOfContents class |
Properties
| AddPageNumbers |
Controls if the table of contents entries will have page numbers. This property is true by default
(Inherited from PdfTableOfContents) |
| BackgroundColor |
The table of contents background color
(Inherited from PdfTableOfContents) |
| DisplayFooter |
Controls if the footer is displayed on the table of content pages. The footer is displayed by default
(Inherited from PdfTableOfContents) |
| DisplayHeader |
Controls if the header is displayed on the table of content pages. The header is displayed by default
(Inherited from PdfTableOfContents) |
| ExclusivePageNumbering |
Controls if the page numbering in table of contents excludes the table of contents pages. By default this property is false
(Inherited from PdfTableOfContents) |
| 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
(Inherited from PdfTableOfContents) |
| MaxTextChars |
The maximum number of characters of the table of contents entry text. By default there is no limit
(Inherited from PdfTableOfContents) |
| NewSectionForEachHtml | Controls if a new section is started in the table of contents for each HTML document added to this PDF document. This property is true by default |
| TablePageCount |
The number of PDF pages used by table of contents
(Inherited from PdfTableOfContents) |
| TablePageIndex |
The index in document of the PDF page where the table of contents is rendered
(Inherited from PdfTableOfContents) |
| 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 }"
(Inherited from PdfTableOfContents) |
| TableTitle |
The table of contents title
(Inherited from PdfTableOfContents) |
| TableTitleStyle |
The table of contents title style can be set as a regular CSS style, for example "color:red; background-color:green"
(Inherited from PdfTableOfContents) |
| TableWidth |
The table of contents width in pixels
(Inherited from PdfTableOfContents) |
| 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
(Inherited from PdfTableOfContents) |
Methods
| Equals | (Inherited from Object) |
| Finalize | (Inherited from Object) |
| GetHashCode | (Inherited from Object) |
| GetType | (Inherited from Object) |
| InsertPdfFileBefore(Byte, Boolean, Boolean, Boolean) | Call this method to insert a PDF document from data before the table of contents in the final document. The boolean parameter controls if the header and footer are applied on external PDF document. When the parameter is true the interactive features are disabled in the external PDF |
| InsertPdfFileBefore(String, Boolean, Boolean, Boolean) | Call this method to insert a PDF file before the table of contents in the final document. The boolean parameter controls if the header and footer are applied on external PDF document. When the parameter is true the interactive features are disabled in the external PDF |
| MemberwiseClone | (Inherited from Object) |
| SetPageNumberStyle |
Call this method to set the CSS style of the page numbers for a level in table of contents
(Inherited from PdfTableOfContents) |
| SetTocEntryStyle |
Call this method to set the table of contents entry CSS style for a level
(Inherited from PdfTableOfContents) |
| ToString | (Inherited from Object) |