|
Foxit PDF SDK
|
Public Member Functions | |
| def | GetBookmark_level_array () |
| Get a bookmark level array which is used to specify bookmarks to be used to generate "Table of Contents". More... | |
| def | GetInclude_toc_pages () |
| Get true means to include catalog page(s) in the calculation of pages number in the table of contents, while false means to exclude catalog page(s) from the calculation of pages number in the table of contents. More... | |
| def | GetIs_show_serial_number () |
| Get true means to show the serial number in the table of contents, while false means not to show the serial number. More... | |
| def | GetTitle () |
| Get title for the table of contents. More... | |
| def | Set (title, bookmark_level_array, is_show_serial_number, include_toc_pages) |
| Set value. More... | |
| def | SetBookmark_level_array (value) |
| Set a bookmark level array which is used to specify bookmarks to be used to generate "Table of Contents". More... | |
| def | SetInclude_toc_pages (value) |
| Set true means to include catalog page(s) in the calculation of pages number in the table of contents, while false means to exclude catalog page(s) from the calculation of pages number in the table of contents. More... | |
| def | SetIs_show_serial_number (value) |
| Set true means to show the serial number in the table of contents, while false means not to show the serial number. More... | |
| def | SetTitle (value) |
| Set title for the table of contents. More... | |
This class represents the table of contents configuration.
| fsdk.TableOfContentsConfig.GetBookmark_level_array | ( | ) |
Get a bookmark level array which is used to specify bookmarks to be used to generate "Table of Contents".
| fsdk.TableOfContentsConfig.GetInclude_toc_pages | ( | ) |
Get true means to include catalog page(s) in the calculation of pages number in the table of contents, while false means to exclude catalog page(s) from the calculation of pages number in the table of contents.
| fsdk.TableOfContentsConfig.GetIs_show_serial_number | ( | ) |
Get true means to show the serial number in the table of contents, while false means not to show the serial number.
| fsdk.TableOfContentsConfig.GetTitle | ( | ) |
Get title for the table of contents.
| def fsdk.TableOfContentsConfig.Set | ( | title, | |
| bookmark_level_array, | |||
| is_show_serial_number, | |||
| include_toc_pages | |||
| ) |
Set value.
| [in] | title | Title for the table of contents. |
| [in] | bookmark_level_array | A bookmark level array which is used to specify bookmarks to be used to generate "Table of Contents". |
| [in] | is_show_serial_number | true means to show the serial number in the table of contents, while false means not to show the serial number. |
| [in] | include_toc_pages | true means to include catalog page(s) in the calculation of pages number in the table of contents, while false means to exclude catalog page(s) from the calculation of pages number in the table of contents. |
@ return None.
| fsdk.TableOfContentsConfig.SetBookmark_level_array | ( | value | ) |
Set a bookmark level array which is used to specify bookmarks to be used to generate "Table of Contents".
| [in] | value | A bookmark level array which is used to specify bookmarks to be used to generate "Table of Contents". For each element in input array, valid range : from 1 to(depth). depth is returned by function fsdk.PDFDoc.GetBookmarkLevelDepth . If input array is an empty array, that means all bookmarks are used to generate "Table of Contents". |
| fsdk.TableOfContentsConfig.SetInclude_toc_pages | ( | value | ) |
Set true means to include catalog page(s) in the calculation of pages number in the table of contents, while false means to exclude catalog page(s) from the calculation of pages number in the table of contents.
| [in] | value | true means to include catalog page(s) in the calculation of pages number in the table of contents, while false means to exclude catalog page(s) from the calculation of pages number in the table of contents. |
| fsdk.TableOfContentsConfig.SetIs_show_serial_number | ( | value | ) |
Set true means to show the serial number in the table of contents, while false means not to show the serial number.
| [in] | value | true means to show the serial number in the table of contents, while false means not to show the serial number. |
| fsdk.TableOfContentsConfig.SetTitle | ( | value | ) |
Set title for the table of contents.
| [in] | value | Title for the table of contents. If this is an empty string, the default value "Table of Contents" will be used. |