fsdk.TableOfContentsConfig类 参考

Public 成员函数
def	GetBookmark_level_array ()
	Get 书签级别数组，用于指定用于生成"目录"的书签。 对于输入数组中的每个元素，有效范围：从1到(depth)。 depth 由函数 fsdk.PDFDoc.GetBookmarkLevelDepth 返回。 如果输入数组是空数组，则意味着所有书签都用于生成"目录"。 更多...
def	GetInclude_toc_pages ()
	Get true 表示在目录的页码计算中包含目录页面， false 表示在目录的页码计算中排除目录页面。 更多...
def	GetIs_show_serial_number ()
	Get true 表示在目录中显示序列号，false 表示不显示序列号。 更多...
def	GetTitle ()
	Get 目录的标题。如果这是空字符串，将使用默认值"Table of Contents"。 更多...
def	Set (title, bookmark_level_array, is_show_serial_number, include_toc_pages)
	设置值。 更多...
def	SetBookmark_level_array (value)
	Set 书签级别数组，用于指定用于生成"目录"的书签。 对于输入数组中的每个元素，有效范围：从1到(depth)。 depth 由函数 fsdk.PDFDoc.GetBookmarkLevelDepth 返回。 如果输入数组是空数组，则意味着所有书签都用于生成"目录"。 更多...
def	SetInclude_toc_pages (value)
	Set true 表示在目录的页码计算中包含目录页面， false 表示在目录的页码计算中排除目录页面。 更多...
def	SetIs_show_serial_number (value)
	Set true 表示在目录中显示序列号，false 表示不显示序列号。 更多...
def	SetTitle (value)
	Set 目录的标题。如果这是空字符串，将使用默认值"Table of Contents"。 更多...

详细描述

此类表示目录配置。

成员函数说明

GetBookmark_level_array()

fsdk.TableOfContentsConfig.GetBookmark_level_array

(

)

Get 书签级别数组，用于指定用于生成"目录"的书签。 对于输入数组中的每个元素，有效范围：从1到(depth)。 depth 由函数 fsdk.PDFDoc.GetBookmarkLevelDepth 返回。 如果输入数组是空数组，则意味着所有书签都用于生成"目录"。

返回

书签级别数组，用于指定用于生成"目录"的书签。 对于输入数组中的每个元素，有效范围：从1到(depth)。 depth 由函数 fsdk.PDFDoc.GetBookmarkLevelDepth 返回。 如果输入数组是空数组，则意味着所有书签都用于生成"目录"。

GetInclude_toc_pages()

fsdk.TableOfContentsConfig.GetInclude_toc_pages

(

)

Get true 表示在目录的页码计算中包含目录页面， false 表示在目录的页码计算中排除目录页面。

返回

true 表示在目录的页码计算中包含目录页面， false 表示在目录的页码计算中排除目录页面。

GetIs_show_serial_number()

fsdk.TableOfContentsConfig.GetIs_show_serial_number

(

)

Get true 表示在目录中显示序列号，false 表示不显示序列号。

返回

true 表示在目录中显示序列号，false 表示不显示序列号。

GetTitle()

fsdk.TableOfContentsConfig.GetTitle

(

)

Get 目录的标题。如果这是空字符串，将使用默认值"Table of Contents"。

返回

目录的标题。如果这是空字符串，将使用默认值"Table of Contents"。

Set()

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

设置值。

参数

[in]	title	目录的标题。
[in]	bookmark_level_array	书签级别数组，用于指定用于生成"目录"的书签。
[in]	is_show_serial_number	true 表示在目录中显示序列号，false 表示不显示序列号。
[in]	include_toc_pages	true 表示在目录的页码计算中包含目录页面， false 表示在目录的页码计算中排除目录页面。

@ return 无。

SetBookmark_level_array()

fsdk.TableOfContentsConfig.SetBookmark_level_array

(

value

)

Set 书签级别数组，用于指定用于生成"目录"的书签。 对于输入数组中的每个元素，有效范围：从1到(depth)。 depth 由函数 fsdk.PDFDoc.GetBookmarkLevelDepth 返回。 如果输入数组是空数组，则意味着所有书签都用于生成"目录"。

参数

[in]

value

书签级别数组，用于指定用于生成"目录"的书签。 对于输入数组中的每个元素，有效范围：从1到(depth)。 depth 由函数 fsdk.PDFDoc.GetBookmarkLevelDepth 返回。 如果输入数组是空数组，则意味着所有书签都用于生成"目录"。

返回

None.

SetInclude_toc_pages()

fsdk.TableOfContentsConfig.SetInclude_toc_pages

(

value

)

Set true 表示在目录的页码计算中包含目录页面， false 表示在目录的页码计算中排除目录页面。

参数

[in]

value

true 表示在目录的页码计算中包含目录页面， false 表示在目录的页码计算中排除目录页面。

返回

None.

SetIs_show_serial_number()

fsdk.TableOfContentsConfig.SetIs_show_serial_number

(

value

)

Set true 表示在目录中显示序列号，false 表示不显示序列号。

参数

[in]

value

true 表示在目录中显示序列号，false 表示不显示序列号。

返回

None.

SetTitle()

fsdk.TableOfContentsConfig.SetTitle

(

value

)

Set 目录的标题。如果这是空字符串，将使用默认值"Table of Contents"。

参数

[in]

value

目录的标题。如果这是空字符串，将使用默认值"Table of Contents"。

返回

None.