Foxit PDF SDK
FSTableOfContentsConfig类 参考

继承自 NSObject .

构造函数

(id) - init
 构造函数。

 
(id) - initWithTitle:bookmark_level_array:is_show_serial_number:include_toc_pages:
 带参数的构造函数。
更多...
 
(void) - set:bookmark_level_array:is_show_serial_number:include_toc_pages:
 设置值。
更多...
 

属性

FSInt32Array * bookmark_level_array
 书签级别数组,用于指定用于生成"目录"的书签。 对于输入数组中的每个元素,有效范围:从1到(depth)。 depth 由函数 FSPDFDoc::getBookmarkLevelDepth 返回。 如果输入数组是空数组,则意味着所有书签都用于生成"目录"。

 
BOOL include_toc_pages
 YES 表示在目录的页码计算中包含目录页面, NO 表示在目录的页码计算中排除目录页面。

 
BOOL is_show_serial_number
 YES 表示在目录中显示序列号,NO 表示不显示序列号。

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

 

详细描述

此类表示目录配置。

函数文档

◆ initWithTitle:bookmark_level_array:is_show_serial_number:include_toc_pages:()

- (id) initWithTitle: (NSString *)  title
bookmark_level_array: (FSInt32Array*)  bookmark_level_array
is_show_serial_number: (BOOL)  is_show_serial_number
include_toc_pages: (BOOL)  include_toc_pages 

带参数的构造函数。

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

◆ set:bookmark_level_array:is_show_serial_number:include_toc_pages:()

- (void) set: (NSString *)  title
bookmark_level_array: (FSInt32Array*)  bookmark_level_array
is_show_serial_number: (BOOL)  is_show_serial_number
include_toc_pages: (BOOL)  include_toc_pages 

设置值。

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

@ return 无。