PDF4Java Reference Documentation
com.o2sol.pdf4java.flowdocument Package / PDFFlowDocumentToCSettings Class
Methods Collapse All Expand All Members Options: Show All Members Options: Filtered
Include Inherited Members
Include Protected Members
In This Topic

PDFFlowDocumentToCSettings Class Members
In This Topic

The following tables list the members exposed by PDFFlowDocumentToCSettings.

Public Constructors

| Name | Description
--- | --- | ---
| PDFFlowDocumentToCSettings Constructor | Initializes a new PDFFlowDocumentToCSettings object.

Top
Public Methods

| Name | Description
--- | --- | ---
| getContentsEntryFiller | Gets the contents entry filler. The character is multiplied as necessary to fill the space between the heading text and the page number.
| getContentsEntrySpacingAfter | Gets the spacing after a table of contents entry.
| getContentsEntrySpacingBefore | Gets the spacing before a table of contents entry.
| getContentsHeadingIndent | Gets the heading indent.
| getContentsPageNumbers | Gets the collection of page numbers. The pairs in this collection specify a page and a number (or any string that can server as page number). If the page appears in the table of contents (because it contains a heading that is included in the table of contents), the corresponding page number will be displayed for the heading.
| getContentsPagePosition | Gets the contents page position in the document. This value is used if method returns true.
| getContentsTextColor | Gets the table of contents color. This value is used if method returns true.
| getContentsTextFont | Gets the font for displaying the contents text. This value is used if method returns true.
| getContentsTitle | Gets the table of contents title. Usually this property is a string like "Contents" or "Table of Contents".
| getGenerateContentsPage | Gets a value indicating whether the table of contents should be generated as separate pages in the document.
| getGenerateDocumentOutline | Gets a value indicating whether the table of contents should be generated as document outline (bookmarks).
| getMaxHeadingLevelForContentsPage | Gets the maximum heading level to be included in the contents page. This value is used if method returns true.
| getMaxHeadingLevelForDocumentOutline | Gets the maximum heading level to be included in the document outline.
| getParentStructureElementForTableOfContents | Gets the parent structure element for the table of contents.
| setContentsEntryFiller | Sets the contents entry filler. The character is multiplied as necessary to fill the space between the heading text and the page number. This value is used if method returns true.
| setContentsEntrySpacingAfter | Sets the spacing after a table of contents entry. This value is used if method returns true.
| setContentsEntrySpacingBefore | Sets the spacing before a table of contents entry. This value is used if method returns true.
| setContentsHeadingIndent | Sets the heading indent. Level 1 headings are aligned to page's left margin. Level 2 headings are indented with space, level 3 headings are indented with 2 * space, and so on. This value is used if method returns true.
| setContentsPageNumbers | Sets the collection of page numbers. The pairs in this collection specify a page and a number (or any string that can server as page number). If the page appears in the table of contents (because it contains a heading that is included in the table of contents), the corresponding page number will be displayed for the heading.
| setContentsPagePosition | Sets the contents page position in the document. This value is used if method returns true.
| setContentsTextColor | Sets the table of contents color. This value is used if method returns true.
| setContentsTextFont | Sets the font for displaying the contents text. This value is used if method returns true.
| setContentsTitle | Sets the table of contents title. Usually this property is a string like "Contents" or "Table of Contents".
| setGenerateContentsPage | Sets a value indicating whether the table of contents should be generated as separate pages in the document.
| setGenerateDocumentOutline | Sets a value indicating whether the table of contents should be generated as document outline (bookmarks).
| setMaxHeadingLevelForContentsPage | Sets the maximum heading level to be included in the contents page. This value is used if method returns true.
| setMaxHeadingLevelForDocumentOutline | Sets the maximum heading level to be included in the document outline.
| setParentStructureElementForTableOfContents | Sets the parent structure element for the table of contents.

Top
See Also

#### Reference

PDFFlowDocumentToCSettings Class
com.o2sol.pdf4java.flowdocument Package

© 2025 O2 Solutions All Rights Reserved.

Send comments on this topic.