Foxit PDF SDK
fsdk.TableOfContentsConfig Class Reference

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...
 

Detailed Description

This class represents the table of contents configuration.

Member Function Documentation

◆ GetBookmark_level_array()

fsdk.TableOfContentsConfig.GetBookmark_level_array ( )

Get a bookmark level array which is used to specify bookmarks to be used to generate "Table of Contents".

Returns
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".

◆ GetInclude_toc_pages()

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.

Returns
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.

◆ GetIs_show_serial_number()

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.

Returns
true means to show the serial number in the table of contents, while false means not to show the serial number.

◆ GetTitle()

fsdk.TableOfContentsConfig.GetTitle ( )

Get title for the table of contents.

Returns
Title for the table of contents. If this is an empty string, the default value "Table of Contents" will be used.

◆ Set()

def fsdk.TableOfContentsConfig.Set (   title,
  bookmark_level_array,
  is_show_serial_number,
  include_toc_pages 
)

Set value.

Parameters
[in]titleTitle for the table of contents.
[in]bookmark_level_arrayA bookmark level array which is used to specify bookmarks to be used to generate "Table of Contents".
[in]is_show_serial_numbertrue means to show the serial number in the table of contents, while false means not to show the serial number.
[in]include_toc_pagestrue 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.

◆ SetBookmark_level_array()

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".

Parameters
[in]valueA 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".
Returns
None.

◆ SetInclude_toc_pages()

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.

Parameters
[in]valuetrue 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.
Returns
None.

◆ SetIs_show_serial_number()

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.

Parameters
[in]valuetrue means to show the serial number in the table of contents, while false means not to show the serial number.
Returns
None.

◆ SetTitle()

fsdk.TableOfContentsConfig.SetTitle (   value)

Set title for the table of contents.

Parameters
[in]valueTitle for the table of contents. If this is an empty string, the default value "Table of Contents" will be used.
Returns
None.