注释摘要字符串 ID：指定在结果文档中输出作者信息时的前缀。默认前缀是 "Author:"。
更多...

类 FSAnnotationSummarySettings 继承关系图:

构造函数
(void)	- enableOutputNoAnnotationPage:
	设置标志以决定是否输出没有注释的页面信息。更多...

(id)	- init
	构造函数，带参数。

(id)	- initWithOther:
	构造函数，使用另一个注释摘要设置对象。更多...

(BOOL)	- isEmpty
	检查当前对象是否为空。更多...

(void)	- setAnnotThumbnail:thumbnail:
	设置结果文档中用于指示注释类型的标记注释缩略图。更多...

(void)	- setAnnotType:use_all:
	设置决定哪种类型的注释将被摘要的选项。更多...

(void)	- setConnectorLineColor:
	设置连接线颜色。更多...

(void)	- setConnectorLineOpacity:
	设置连接线不透明度。更多...

(void)	- setEndPage:
	设置结束页面索引。更多...

(void)	- setFileTitle:
	设置当需要在结果文档中输出文档位置时的文件标题字符串。更多...

(void)	- setFontSize:
	设置注释摘要结果文档中使用的字体大小类型。更多...

(void)	- setPageMargin:
	设置结果文档中使用的页面边距。更多...

(void)	- setPageRect:
	设置结果文档中的页面矩形。更多...

(void)	- setSortType:
	设置决定按什么对注释进行排序的选项。更多...

(void)	- setStartPage:
	设置起始页面索引。更多...

(void)	- setSummaryLayout:
	设置摘要布局类型。更多...

详细描述

注释摘要字符串 ID：指定在结果文档中输出作者信息时的前缀。默认前缀是 "Author:"。

注释摘要字符串 ID：指定在结果文档中输出日期信息时的前缀。默认前缀是 "Date:"。

注释摘要字符串 ID：指定在结果文档中输出页面信息时的前缀。默认前缀是 "Page:"。

注释摘要字符串 ID：指定在结果文档中输出注释类型时的前缀。默认前缀是 "Type:"。

注释摘要字符串 ID：指定结果文档中的文档标题。默认标题是 "Summary of comments:"。

注释摘要字符串 ID：指定在结果文档中输出页面标题时的前缀。默认字符串是 "Page:"。

注释摘要字符串 ID：指定在页面没有任何注释时在结果文档中作为内容使用的字符串。默认内容是 "No Annotations."。

注释摘要字符串 ID：指定在结果文档中输出数量信息时的前缀。默认前缀是 "Number:"。

注释摘要字符串 ID：指定在结果文档中输出主题信息时的前缀。默认前缀是 "Subject:"。

此类表示注释摘要的设置。这将在类 FSAnnotationSummary 中使用。

参见: FSAnnotationSummary

函数文档

◆ enableOutputNoAnnotationPage:()

- (void) enableOutputNoAnnotationPage: (BOOL) enable

设置标志以决定是否输出没有注释的页面信息。

对于新构造的对象，如果不调用此函数，将使用默认值 YES。

参数

[in] enable 布尔值，用于决定是否输出没有注释的页面信息： YES 表示输出没有注释的页面信息，而 NO 表示不输出没有注释的页面信息。

返回: 无。

◆ initWithOther:()

- (id) initWithOther: (FSAnnotationSummarySettings*) other

构造函数，使用另一个注释摘要设置对象。

参数

[in] other 另一个注释摘要设置对象。

◆ isEmpty()

- (BOOL) isEmpty

检查当前对象是否为空。

当当前对象为空时，表示当前对象无用。

返回: YES 表示当前对象为空，而 NO 表示不为空。

◆ setAnnotThumbnail:thumbnail:()

- (void) setAnnotThumbnail:	(FSAnnotType)	type
thumbnail:	(FSBitmap*)	thumbnail

设置结果文档中用于指示注释类型的标记注释缩略图。

缩略图位图不使用 alpha 通道。因此建议用户设置不带 alpha 通道的位图作为新缩略图。如果设置了带 alpha 通道的位图，新缩略图将默认使用白色背景。
如果未设置，相应注释类型将不使用缩略图。

参数

[in]	type	注释类型，用于决定要设置其缩略图的类型。请参考从 FSAnnotNote 开始的值，这应该是这些值中的一个，除了 FSAnnotLink, FSAnnotPSInk, FSAnnotSound, FSAnnotMovie, FSAnnotWidget, FSAnnotScreen, FSAnnotPrinterMark, FSAnnotTrapNet, FSAnnotWatermark, FSAnnot3D, FSAnnotPopup, FSAnnotRedact。
[in]	thumbnail	用作结果文档中注释类型缩略图的位图。这应该是有效的位图。如果位图大小不是 1212，位图在使用时将被缩放到 1212。

返回: 无。

◆ setAnnotType:use_all:()

- (void) setAnnotType:	(FSAnnotType)	type
use_all:	(BOOL)	use_all

设置决定哪种类型的注释将被摘要的选项。

对于新构造的对象，如果不调用此函数来设置此选项，表示摘要所有支持类型的注释。

参数

[in]	type	注释类型，用于决定哪些注释将被摘要。请参考从 FSAnnotNote 开始的值，这应该是这些值中的一个，除了 FSAnnotLink, FSAnnotPSInk, FSAnnotSound, FSAnnotMovie, FSAnnotWidget, FSAnnotScreen, FSAnnotPrinterMark, FSAnnotTrapNet, FSAnnotWatermark, FSAnnot3D, FSAnnotPopup, FSAnnotRedact。
[in]	use_all	布尔值，用于决定是否在结果文档中摘要所有支持的注释： YES 表示摘要所有支持类型的注释。在这种情况下，参数 type 将被忽略。 NO 表示仅摘要由参数 type 指定的注释。

返回: 无。

◆ setConnectorLineColor:()

- (void) setConnectorLineColor: (unsigned int) color

设置连接线颜色。

当摘要布局类型通过函数 FSAnnotationSummarySettings::setSummaryLayout: 设置为 FSAnnotationSummarySettingsSummaryLayoutSeparatePagesWithLine 或 FSAnnotationSummarySettingsSummaryLayoutSinglePageWithLine 时，此选项将生效。如果未设置，将使用默认值 0x000000。

参数

[in] color 连接线颜色。格式：0xRRGGBB。

返回: 无。

◆ setConnectorLineOpacity:()

- (void) setConnectorLineOpacity: (float) opacity

设置连接线不透明度。

当摘要布局类型通过函数 FSAnnotationSummarySettings::setSummaryLayout: 设置为 FSAnnotationSummarySettingsSummaryLayoutSeparatePagesWithLine 或 FSAnnotationSummarySettingsSummaryLayoutSinglePageWithLine 时，此选项将生效。如果未设置，将使用默认值 1.0。

参数

[in] opacity 连接线不透明度。有效范围：从 0.0 到 1.0。 0.0 表示完全透明，1.0 表示完全不透明。

返回: 无。

◆ setEndPage:()

- (void) setEndPage: (int) page_index

设置结束页面索引。

对于新构造的对象，如果不调用此函数，将使用默认值 (count-1) 作为结束页面索引。 count 是由函数 FSPDFDoc::getPageCount 为要摘要其注释的 PDF 文档返回的。

参数

[in] page_index 页面索引，指定摘要操作结束的结束页面。有效范围：从 0 到 (count-1)。count 是由函数 FSPDFDoc::getPageCount 为要摘要其注释的 PDF 文档返回的。当调用函数 FSAnnotationSummary::startSummarize:settings:pause: 时将检查此索引。

返回: 无。

◆ setFileTitle:()

- (void) setFileTitle: (NSString *) title

设置当需要在结果文档中输出文档位置时的文件标题字符串。

如果未设置，将使用空字符串作为默认值。

参数

[in] title 结果文档中使用的摘要标题。

返回: 无。

◆ setFontSize:()

- (void) setFontSize: (FSAnnotationSummarySettingsFontSizeType) type

设置注释摘要结果文档中使用的字体大小类型。

对于新构造的对象，如果不调用此函数来设置此选项，表示使用 FSAnnotationSummarySettingsFontSizeMedium 作为此选项的默认值。

参数

[in] type 注释摘要结果文档中使用的字体大小类型。请参考从 FSAnnotationSummarySettingsFontSizeSmall 开始的值，这应该是这些值中的一个。

返回: 无。

◆ setPageMargin:()

- (void) setPageMargin: (FSRectF*) margin

设置结果文档中使用的页面边距。

此值不表示矩形。它只是定义 PDF 页面的左边距、下边距、右边距和上边距。如果未设置边距值，Foxit PDF SDK 将使用定义为 (50.0, 50.0, 50.0, 50.0) 的边距作为默认值。

参数

[in] margin 结果文档中使用的页面边距。

返回: 无。

◆ setPageRect:()

- (void) setPageRect: (FSRectF*) rect

设置结果文档中的页面矩形。

如果未设置，将使用默认矩形 (0.0, 0.0, 612.0, 792.0)。

参数

[in] rect 结果文档中使用的页面矩形。

返回: 无。

◆ setSortType:()

- (void) setSortType: (FSAnnotationSummarySettingsSortType) type

设置决定按什么对注释进行排序的选项。

对于新构造的对象，如果不调用此函数来设置此选项，表示使用 FSAnnotationSummarySettingsTypeSortByAnnotationType 作为此选项的默认值。

参数

[in] type 注释摘要的排序类型。请参考从 FSAnnotationSummarySettingsTypeSortByAuthor 开始的值，这应该是这些值中的一个。

返回: 无。

◆ setStartPage:()

- (void) setStartPage: (int) page_index

设置起始页面索引。

对于新构造的对象，如果不调用此函数，将使用默认值 0 作为起始页面索引。

参数

[in] page_index 页面索引，指定摘要操作开始的起始页面。有效范围：从 0 到 (count-1)。count 是由函数 FSPDFDoc::getPageCount 为要摘要其注释的 PDF 文档返回的。当调用函数 FSAnnotationSummary::startSummarize:settings:pause: 时将检查此索引。

返回: 无。

◆ setSummaryLayout:()

- (void) setSummaryLayout: (FSAnnotationSummarySettingsSummaryLayout) type

设置摘要布局类型。

对于新构造的对象，如果不调用此函数来设置此选项，表示使用 FSAnnotationSummarySettingsSummaryLayoutSeparatePagesWithLine 作为此选项的默认值。

参数

[in] type 摘要布局类型。请参考从 FSAnnotationSummarySettingsSummaryLayoutSeparatePagesWithLine 开始的值，这应该是这些值中的一个。

返回: 无。