PDFTableOfContents is one of the PDF Builder objects, and is derived from PDFModel. PDFTableofContents and PDFTableOfContentsItem work together to manage the table of contents of a PDF document:
-
PDFTableOfContents is the container for the PDFTableOfContentsItem objects.
-
The first-level items (chapters, which are PDFTableOfContentsItem objects) in the table of contents are added using the PDFTableOfContents.AddItem, and the functions in PDFTableOfContent only work on the first-level items in the table of contents.
-
The sub-level items (chapters) in the table of contents are added using the PDFTableOfContentsItem.AddItem.
-
The indexes of the items are auto generated, and are structured by levels. For example, the level-1 chapters start their index at 1; and the sub-items in each chapter start their index at 1 too.
-
PDFTableOfContents currently does not support the language (such as Arabic, Hebrew etc.) displayed in the right-to-left order.
To view the full hierarchy of the PDF Builder objects, find "pdfobject" in the Browser, right-click the object, and then select "Show Hierarchy” in the pop-up menu.
PDFTableOfContents provides the following property. In addition, it inherits the properties from its parent, PDFModel.
|
PDFTableOfContents property |
Datatype |
Description |
|---|---|---|
|
ClassDefinition |
PowerObject |
An object of type PowerObject containing information about the class definition of the object or control. |
|
Double |
Gets or sets the size of the bottom margin between the table of contents and the printed page. |
|
|
Double |
Gets or sets the size of the left margin between the table of contents and the printed page. |
|
|
Double |
Gets or sets the size of the right margin between the table of contents and the printed page. |
|
|
Double |
Gets or sets the size of the top margin between the table of contents and the printed page. |
|
PDFTableOfContents event |
Occurs |
|---|---|
|
Immediately before the Open event occurs in the window. |
|
|
Immediately after the Close event occurs in the window. |
PDFTableOfContents provides the following functions.
|
PDFTableOfContents function |
Datatype returned |
Description |
|---|---|---|
|
None |
Adds a fallback font. |
|
|
PDFTableOfContentsItem |
Adds an item to the table of contents. |
|
|
String |
Returns the name assigned to the control. |
|
|
Double |
Gets the bottom margin between the table of contents and the bottom border of the page. |
|
|
Integer |
Creates a reference to a context-specific instance of the specified service. |
|
|
String |
Gets the name of the fallback font. |
|
|
Long |
Gets the count of the fallback fonts. |
|
|
PDFFont |
Gets the font of the title in the table of contents. |
|
|
PDFTableOfContentsItem |
Gets the specified item in the table of contents. |
|
|
Long |
Gets the count of items in the table of contents. |
|
|
Double |
Gets the margin between the table of contents and the left border of the page. |
|
|
PowerObject |
Returns a reference to the name of the parent object. |
|
|
Long |
Gets the page index of the table of contents in the PDF document. |
|
|
Double |
Gets the margin between the table of contents and the right border of the page. |
|
|
PDFTableOfContentsStyle |
Gets the display style of the table of contents. |
|
|
PDFText |
Gets the title in the table of contents. |
|
|
Double |
Gets the top margin between the table of contents and the top border of the page. |
|
|
Boolean |
Adds an event to the end of the message queue for the control. |
|
|
Long |
Removes all the items from the table of contents. |
|
|
Long |
Removes all fallback fonts. |
|
|
Long |
Removes a fallback font. |
|
|
Long |
Removes an item from the table of contents. |
|
|
None |
Sets the margin between the table of contents and the bottom border of the page. |
|
|
None |
Sets the font to use for the title in the table of contents. |
|
|
None |
Sets the margin between the table of contents and the left border of the page. |
|
|
None |
Sets the page index of the table of contents in the PDF document. |
|
|
None |
Sets the margin between the table of contents and the right border of the page. |
|
|
None |
Sets the display style of the table of contents. |
|
|
None |
Sets the title of the table of contents. |
|
|
None |
Sets the margin between the table of contents and the top border of the page. |
|
|
Integer |
Triggers a specified event in the control and executes the script for the event. |
|
|
Object |
Returns the type of the control. |
