TableOfContentsConfig Class Reference

Inheritance diagram for TableOfContentsConfig:

Public Member Functions
	constructor () Set(title
	Constructor. More...
	constructor (r)
	constructor (title, bookmark_level_array, is_show_serial_number, include_toc_pages)
	Constructor, with parameter. More...
Public Member Functions inherited from NativeObjectWrapper
	constructor (r)
	GetPointerAsNumber ()

Public Attributes
	bookmark_level_array
	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".
	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.
	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.
	title
	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.

Examples

/Users/ec2-user/gitlab-runner/builds/E-xKdhDoq/0/foxit/sdk/mobile/gsdk-doc-auto-build/harmony_nodejs/input/Index.js.

Member Function Documentation

constructor() [1/3]

TableOfContentsConfig.constructor

(

)

Constructor.

Set value.

Parameters

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

Examples

/Users/ec2-user/gitlab-runner/builds/E-xKdhDoq/0/foxit/sdk/mobile/gsdk-doc-auto-build/harmony_nodejs/input/Index.js.

constructor() [2/3]

TableOfContentsConfig.constructor

(

r

)

@constructor

Parameters

{NativeObjectReference}

r - The native object reference to wrap

@description Creates a new wrapper instance around a native C++ object. The wrapper manages the object's lifecycle according to the ownership rules.

constructor() [3/3]

TableOfContentsConfig.constructor	(	title	,
		bookmark_level_array	,
		is_show_serial_number	,
		include_toc_pages
	)

Constructor, with parameter.

Parameters

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