Foxit PDF SDK
foxit.pdf.TableOfContentsConfig Class Reference

Inherits SystemIDisposable.

Public Member Functions

 TableOfContentsConfig (string title, Int32Array bookmark_level_array, bool is_show_serial_number)
 Constructor, with parameter.
More...
 
 TableOfContentsConfig ()
 Constructor.

 
void Set (string title, Int32Array bookmark_level_array, bool is_show_serial_number)
 Set value.
More...
 

Properties

Int32Arraybookmark_level_array [get, set]
 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 PDFDoc.GetBookmarkLevelDepth . If input array is an empty array, that means all bookmarks are used to generate "Table of Contents".

 
bool is_show_serial_number [get, set]
 true means to show the serial number in the table of contents, while false means not to show the serial number.

 
string title [get, set]
 Title for the table of contents. If this is an empty string, the default value "Table of Contents" will be used.

 

Detailed Description

This class represents the table of contents configuration.

Constructor & Destructor Documentation

◆ TableOfContentsConfig()

foxit.pdf.TableOfContentsConfig.TableOfContentsConfig ( string  title,
Int32Array  bookmark_level_array,
bool  is_show_serial_number 
)
inline

Constructor, with parameter.

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.

Member Function Documentation

◆ Set()

void foxit.pdf.TableOfContentsConfig.Set ( string  title,
Int32Array  bookmark_level_array,
bool  is_show_serial_number 
)
inline

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.
@ return None.