Public 成员函数
def	EnableOutputNoAnnotationPage (enable)
	设置标志以决定是否输出没有注释的页面信息。更多...

def	IsEmpty ()
	检查当前对象是否为空。更多...

def	SetAnnotThumbnail (type, thumbnail)
	设置结果文档中用于指示注释类型的标记注释缩略图。更多...

def	SetAnnotType (type, use_all)
	设置决定哪种类型的注释将被摘要的选项。更多...

def	SetConnectorLineColor (color)
	设置连接线颜色。更多...

def	SetConnectorLineOpacity (opacity)
	设置连接线不透明度。更多...

def	SetEndPage (page_index)
	设置结束页面索引。更多...

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

def	SetFontSize (type)
	设置注释摘要结果文档中使用的字体大小类型。更多...

def	SetPageMargin (margin)
	设置结果文档中使用的页面边距。更多...

def	SetPageRect (rect)
	设置结果文档中的页面矩形。更多...

def	SetSortType (type)
	设置决定按什么对注释进行排序的选项。更多...

def	SetStartPage (page_index)
	设置起始页面索引。更多...

def	SetSummaryLayout (type)
	设置摘要布局类型。更多...

详细描述

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

参见: AnnotationSummary

成员函数说明

◆ EnableOutputNoAnnotationPage()

def fsdk.AnnotationSummarySettings.EnableOutputNoAnnotationPage ( enable )

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

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

参数

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

返回: 无。

◆ IsEmpty()

def fsdk.AnnotationSummarySettings.IsEmpty ( )

检查当前对象是否为空。

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

返回: true 表示当前对象为空，而 false 表示不为空。

◆ SetAnnotThumbnail()

def fsdk.AnnotationSummarySettings.SetAnnotThumbnail	(	type,
		thumbnail
	)

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

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

参数

[in]	type	注释类型，用于决定要设置其缩略图的类型。请参考从 fsdk.AnnotE_Note 开始的值，这应该是这些值中的一个，除了 fsdk.AnnotE_Link , fsdk.AnnotE_PSInk , fsdk.AnnotE_Sound , fsdk.AnnotE_Movie , fsdk.AnnotE_Widget , fsdk.AnnotE_Screen , fsdk.AnnotE_PrinterMark , fsdk.AnnotE_TrapNet , fsdk.AnnotE_Watermark , fsdk.AnnotE_3D , fsdk.AnnotE_Popup , fsdk.AnnotE_Redact 。
[in]	thumbnail	用作结果文档中注释类型缩略图的位图。这应该是有效的位图。如果位图大小不是 1212，位图在使用时将被缩放到 1212。

返回: 无。

◆ SetAnnotType()

def fsdk.AnnotationSummarySettings.SetAnnotType	(	type,
		use_all
	)

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

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

参数

[in]	type	注释类型，用于决定哪些注释将被摘要。请参考从 fsdk.AnnotE_Note 开始的值，这应该是这些值中的一个，除了 fsdk.AnnotE_Link , fsdk.AnnotE_PSInk , fsdk.AnnotE_Sound , fsdk.AnnotE_Movie , fsdk.AnnotE_Widget , fsdk.AnnotE_Screen , fsdk.AnnotE_PrinterMark , fsdk.AnnotE_TrapNet , fsdk.AnnotE_Watermark , fsdk.AnnotE_3D , fsdk.AnnotE_Popup , fsdk.AnnotE_Redact 。
[in]	use_all	布尔值，用于决定是否在结果文档中摘要所有支持的注释： true 表示摘要所有支持类型的注释。在这种情况下，参数 type 将被忽略。 false 表示仅摘要由参数 type 指定的注释。

返回: 无。

◆ SetConnectorLineColor()

def fsdk.AnnotationSummarySettings.SetConnectorLineColor ( color )

设置连接线颜色。

当摘要布局类型通过函数 fsdk.AnnotationSummarySettings.SetSummaryLayout 设置为 fsdk.AnnotationSummarySettingsE_SummaryLayoutSeparatePagesWithLine 或 fsdk.AnnotationSummarySettingsE_SummaryLayoutSinglePageWithLine 时，此选项将生效。如果未设置，将使用默认值 0x000000。

参数

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

返回: 无。

◆ SetConnectorLineOpacity()

def fsdk.AnnotationSummarySettings.SetConnectorLineOpacity ( opacity )

设置连接线不透明度。

当摘要布局类型通过函数 fsdk.AnnotationSummarySettings.SetSummaryLayout 设置为 fsdk.AnnotationSummarySettingsE_SummaryLayoutSeparatePagesWithLine 或 fsdk.AnnotationSummarySettingsE_SummaryLayoutSinglePageWithLine 时，此选项将生效。如果未设置，将使用默认值 1.0。

参数

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

返回: 无。

◆ SetEndPage()

def fsdk.AnnotationSummarySettings.SetEndPage ( page_index )

设置结束页面索引。

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

参数

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

返回: 无。

◆ SetFileTitle()

def fsdk.AnnotationSummarySettings.SetFileTitle ( title )

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

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

参数

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

返回: 无。

◆ SetFontSize()

def fsdk.AnnotationSummarySettings.SetFontSize ( type )

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

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

参数

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

返回: 无。

◆ SetPageMargin()

def fsdk.AnnotationSummarySettings.SetPageMargin ( margin )

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

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

参数

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

返回: 无。

◆ SetPageRect()

def fsdk.AnnotationSummarySettings.SetPageRect ( rect )

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

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

参数

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

返回: 无。

◆ SetSortType()

def fsdk.AnnotationSummarySettings.SetSortType ( type )

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

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

参数

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

返回: 无。

◆ SetStartPage()

def fsdk.AnnotationSummarySettings.SetStartPage ( page_index )

设置起始页面索引。

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

参数

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

返回: 无。

◆ SetSummaryLayout()

def fsdk.AnnotationSummarySettings.SetSummaryLayout ( type )

设置摘要布局类型。

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

参数

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

返回: 无。

Public 成员函数

详细描述

成员函数说明

◆ EnableOutputNoAnnotationPage()

◆ IsEmpty()

◆ SetAnnotThumbnail()

◆ SetAnnotType()

◆ SetConnectorLineColor()

◆ SetConnectorLineOpacity()

◆ SetEndPage()

◆ SetFileTitle()

◆ SetFontSize()

◆ SetPageMargin()

◆ SetPageRect()

◆ SetSortType()

◆ SetStartPage()

◆ SetSummaryLayout()