类 foxit::pdf::AnnotationSummarySettings 继承关系图:

Public 类型
enum	FontSizeType { e_FontSizeSmall = 0, e_FontSizeMedium = 1, e_FontSizeLarge = 2 }
	用于结果文档中字体大小类型选项的枚举。更多...

enum	SortType { e_TypeSortByAuthor = 0, e_TypeSortByDate = 1, e_TypeSortByPage = 2, e_TypeSortByAnnotationType = 3 }
	用于结果文档中注释排序选项的枚举。更多...

enum	SummaryLayout { e_SummaryLayoutSeparatePagesWithLine = 0, e_SummaryLayoutSinglePageWithLine = 1, e_SummaryLayoutAnnotationOnly = 2, e_SummaryLayoutSeparatePagesWithSequenceNumber = 3, e_SummaryLayoutSinglePageWithSequenceNumber = 4 }
	用于结果文档中注释摘要布局类型的枚举。更多...

Public 成员函数
	AnnotationSummarySettings ()
	构造函数，带参数。

	AnnotationSummarySettings (const AnnotationSummarySettings &other)
	构造函数，使用另一个注释摘要设置对象。更多...

	~AnnotationSummarySettings ()
	析构函数。

void	EnableOutputNoAnnotationPage (bool enable)
	设置标志以决定是否输出没有注释的页面信息。更多...

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

bool	operator!= (const AnnotationSummarySettings &other) const
	不等运算符。更多...

AnnotationSummarySettings &	operator= (const AnnotationSummarySettings &other)
	赋值运算符。更多...

bool	operator== (const AnnotationSummarySettings &other) const
	相等运算符。更多...

void	SetAnnotThumbnail (annots::Annot::Type type, const common::Bitmap &thumbnail)
	设置结果文档中用于指示注释类型的标记注释缩略图。更多...

void	SetAnnotType (annots::Annot::Type type, bool use_all)
	设置决定哪种类型的注释将被摘要的选项。更多...

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

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

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

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

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

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

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

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

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

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

Public 成员函数继承自 foxit::Base
FS_HANDLE	Handle () const
	获取当前对象的句柄。更多...

详细描述

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

参见: AnnotationSummary

成员枚举类型说明

◆ FontSizeType

enum foxit::pdf::AnnotationSummarySettings::FontSizeType

用于结果文档中字体大小类型选项的枚举。

此枚举的值可以单独使用。

枚举值
e_FontSizeSmall	如果设置，表示在结果文档中使用小字体。
e_FontSizeMedium	如果设置，表示在结果文档中使用中等字体。
e_FontSizeLarge	如果设置，表示在结果文档中使用大字体。

◆ SortType

enum foxit::pdf::AnnotationSummarySettings::SortType

用于结果文档中注释排序选项的枚举。

此枚举的值可以单独使用。

枚举值
e_TypeSortByAuthor	如果设置，表示在结果文档中按作者对注释进行排序。
e_TypeSortByDate	如果设置，表示在结果文档中按日期对注释进行排序。
e_TypeSortByPage	如果设置，表示在结果文档中按页面对注释进行排序。
e_TypeSortByAnnotationType	如果设置，表示在结果文档中按注释类型对注释进行排序。

◆ SummaryLayout

enum foxit::pdf::AnnotationSummarySettings::SummaryLayout

用于结果文档中注释摘要布局类型的枚举。

此枚举的值可以单独使用。

枚举值
e_SummaryLayoutSeparatePagesWithLine	如果设置，表示在结果文档中使用分页且带连接线的布局。注释内容会显示在注释原始位置的相对页面上。
e_SummaryLayoutSinglePageWithLine	如果设置，表示在结果文档中使用分页且不带连接线的布局。注释内容会显示在注释原始位置的相对页面上。
e_SummaryLayoutAnnotationOnly	如果设置，则表示仅布局注释。
e_SummaryLayoutSeparatePagesWithSequenceNumber	如果设置，这意味着在单独的页面上用序列号布局文档和注释。
e_SummaryLayoutSinglePageWithSequenceNumber	如果设置，这意味着在单独的页面上用序列号布局文档和注释。

构造及析构函数说明

◆ AnnotationSummarySettings()

foxit::pdf::AnnotationSummarySettings::AnnotationSummarySettings ( const AnnotationSummarySettings & other )

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

参数

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

成员函数说明

◆ EnableOutputNoAnnotationPage()

void foxit::pdf::AnnotationSummarySettings::EnableOutputNoAnnotationPage ( bool enable )

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

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

参数

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

返回: 无。

◆ IsEmpty()

bool foxit::pdf::AnnotationSummarySettings::IsEmpty ( ) const

检查当前对象是否为空。

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

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

◆ operator!=()

bool foxit::pdf::AnnotationSummarySettings::operator!= ( const AnnotationSummarySettings & other ) const

不等运算符。

参数

[in] other 另一个注释摘要设置对象。此函数将检查当前对象是否与此对象不相等。

返回: true 表示不相等，而 false 表示相等。

◆ operator=()

AnnotationSummarySettings& foxit::pdf::AnnotationSummarySettings::operator= ( const AnnotationSummarySettings & other )

赋值运算符。

参数

[in] other 另一个注释摘要设置对象，其值将被赋给当前对象。

返回: 对当前对象本身的引用。

◆ operator==()

bool foxit::pdf::AnnotationSummarySettings::operator== ( const AnnotationSummarySettings & other ) const

相等运算符。

参数

[in] other 另一个注释摘要设置对象。此函数将检查当前对象是否与此对象相等。

返回: true 表示相等，而 false 表示不相等。

◆ SetAnnotThumbnail()

void foxit::pdf::AnnotationSummarySettings::SetAnnotThumbnail	(	annots::Annot::Type	type,
		const common::Bitmap &	thumbnail
	)

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

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

参数

[in]	type	注释类型，用于决定要设置其缩略图的类型。请参考从 annots::Annot::e_Note 开始的值，这应该是这些值中的一个，除了 annots::Annot::e_Link, annots::Annot::e_PSInk, annots::Annot::e_Sound, annots::Annot::e_Movie, annots::Annot::e_Widget, annots::Annot::e_Screen, annots::Annot::e_PrinterMark, annots::Annot::e_TrapNet, annots::Annot::e_Watermark, annots::Annot::e_3D, annots::Annot::e_Popup, annots::Annot::e_Redact。
[in]	thumbnail	用作结果文档中注释类型缩略图的位图。这应该是有效的位图。如果位图大小不是 1212，位图在使用时将被缩放到 1212。

返回: 无。

◆ SetAnnotType()

void foxit::pdf::AnnotationSummarySettings::SetAnnotType	(	annots::Annot::Type	type,
		bool	use_all
	)

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

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

参数

[in]	type	注释类型，用于决定哪些注释将被摘要。请参考从 annots::Annot::e_Note 开始的值，这应该是这些值中的一个，除了 annots::Annot::e_Link, annots::Annot::e_PSInk, annots::Annot::e_Sound, annots::Annot::e_Movie, annots::Annot::e_Widget, annots::Annot::e_Screen, annots::Annot::e_PrinterMark, annots::Annot::e_TrapNet, annots::Annot::e_Watermark, annots::Annot::e_3D, annots::Annot::e_Popup, annots::Annot::e_Redact。
[in]	use_all	布尔值，用于决定是否在结果文档中摘要所有支持的注释： true 表示摘要所有支持类型的注释。在这种情况下，参数 type 将被忽略。 false 表示仅摘要由参数 type 指定的注释。

返回: 无。

◆ SetConnectorLineColor()

void foxit::pdf::AnnotationSummarySettings::SetConnectorLineColor ( RGB color )

设置连接线颜色。

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

参数

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

返回: 无。

◆ SetConnectorLineOpacity()

void foxit::pdf::AnnotationSummarySettings::SetConnectorLineOpacity ( float opacity )

设置连接线不透明度。

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

参数

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

返回: 无。

◆ SetEndPage()

void foxit::pdf::AnnotationSummarySettings::SetEndPage ( int page_index )

设置结束页面索引。

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

参数

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

返回: 无。

◆ SetFileTitle()

void foxit::pdf::AnnotationSummarySettings::SetFileTitle ( const wchar_t * title )

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

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

参数

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

返回: 无。

◆ SetFontSize()

void foxit::pdf::AnnotationSummarySettings::SetFontSize ( FontSizeType type )

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

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

参数

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

返回: 无。

◆ SetPageMargin()

void foxit::pdf::AnnotationSummarySettings::SetPageMargin ( const RectF & margin )

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

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

参数

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

返回: 无。

◆ SetPageRect()

void foxit::pdf::AnnotationSummarySettings::SetPageRect ( const RectF & rect )

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

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

参数

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

返回: 无。

◆ SetSortType()

void foxit::pdf::AnnotationSummarySettings::SetSortType ( SortType type )

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

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

参数

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

返回: 无。

◆ SetStartPage()

void foxit::pdf::AnnotationSummarySettings::SetStartPage ( int page_index )

设置起始页面索引。

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

参数

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

返回: 无。

◆ SetSummaryLayout()

void foxit::pdf::AnnotationSummarySettings::SetSummaryLayout ( SummaryLayout type )

设置摘要布局类型。

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

参数

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

返回: 无。

Public 类型

Public 成员函数

详细描述

成员枚举类型说明

◆ FontSizeType

◆ SortType

◆ SummaryLayout

构造及析构函数说明

◆ AnnotationSummarySettings()

成员函数说明

◆ EnableOutputNoAnnotationPage()

◆ IsEmpty()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ SetAnnotThumbnail()

◆ SetAnnotType()

◆ SetConnectorLineColor()

◆ SetConnectorLineOpacity()

◆ SetEndPage()

◆ SetFileTitle()

◆ SetFontSize()

◆ SetPageMargin()

◆ SetPageRect()

◆ SetSortType()

◆ SetStartPage()

◆ SetSummaryLayout()