Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
FSDK::AnnotationSummarySettings类 参考

## Public 成员函数
| constructor ()
| 带参数的构造函数。
| EnableOutputNoAnnotationPage (enable)
| 设置标志以决定是否输出没有注释的页面的信息。 更多...
| IsEmpty ()
| 检查当前对象是否为空。 更多...
| SetAnnotThumbnail (type, thumbnail)
| 设置结果文档中使用的标记注释缩略图，用于指示注释的类型。 更多...
| SetAnnotType (type, use_all)
| 设置选项以决定将汇总哪种类型的注释。 更多...
| SetConnectorLineColor (color)
| 设置连接线颜色。 更多...
| SetConnectorLineOpacity (opacity)
| 设置连接线不透明度。 更多...
| SetEndPage (page_index)
| 设置结束页索引。 更多...
| SetFileTitle (title)
| 设置当需要在结果文档中输出文档位置时的文件标题字符串。 更多...
| SetFontSize (type)
| 设置注释摘要结果文档中使用的字体大小类型。 更多...
| SetPageMargin (margin)
| 设置结果文档中使用的页面边距。 更多...
| SetPageRect (rect)
| 设置结果文档中的页面矩形。 更多...
| SetSortType (type)
| 设置选项以决定按什么排序注释。 更多...
| SetStartPage (page_index)
| 设置起始页索引。 更多...
| SetSummaryLayout (type)
| 设置摘要布局类型。 更多...

## 静态 Public 属性
static | e_FontSizeLarge
| 如果设置，表示在结果文档中使用大字体大小。
static | e_FontSizeMedium
| 如果设置，表示在结果文档中使用中等字体大小。
static | e_FontSizeSmall
| 用于结果文档中字体大小类型的选项枚举。 更多...
static | e_SummaryLayoutAnnotationOnly
| 如果设置，表示仅布局注释。
static | e_SummaryLayoutSeparatePagesWithLine
| 用于注释摘要布局的选项枚举。 更多...
static | e_SummaryLayoutSeparatePagesWithSequenceNumber
| 如果设置，表示在单独的页面上使用序列号布局文档和注释。
static | e_SummaryLayoutSinglePageWithLine
| 如果设置，表示在单页上使用连接线布局文档和注释。
static | e_SummaryLayoutSinglePageWithSequenceNumber
| 如果设置，表示在单独的页面上使用序列号布局文档和注释。
static | e_TypeSortByAnnotationType
| 如果设置，表示在结果文档中按注释类型排序注释。
static | e_TypeSortByAuthor
| 用于在结果文档中排序注释的选项枚举。 更多...
static | e_TypeSortByDate
| 如果设置，表示在结果文档中按日期排序注释。
static | e_TypeSortByPage
| 如果设置，表示在结果文档中按页面排序注释。

## 详细描述

此类表示汇总注释的设置。这将在类 FSDK.AnnotationSummary 中使用。

参见
  FSDK.AnnotationSummary

## 成员函数说明

## ◆ EnableOutputNoAnnotationPage()

FSDK::AnnotationSummarySettings::EnableOutputNoAnnotationPage | ( | enable |  | ) |

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

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

参数

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

返回
  None.

## ◆ IsEmpty()

FSDK::AnnotationSummarySettings::IsEmpty | ( |  | ) |

检查当前对象是否为空。

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

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

## ◆ SetAnnotThumbnail()

FSDK::AnnotationSummarySettings::SetAnnotThumbnail | ( | type | ,
|  | thumbnail |
| ) |  |

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

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

参数

  [in] | type | 注释类型，用于决定将设置哪个的缩略图。请参考从 FSDK.Annot.e_Note 开始的值，这应该是这些值之一， 但不包括 FSDK.Annot.e_Link、FSDK.Annot.e_PSInk、 FSDK.Annot.e_Sound、FSDK.Annot.e_Movie、 FSDK.Annot.e_Widget、FSDK.Annot.e_Screen、 FSDK.Annot.e_PrinterMark、FSDK.Annot.e_TrapNet、 FSDK.Annot.e_Watermark、FSDK.Annot.e_3D、 FSDK.Annot.e_Popup、FSDK.Annot.e_Redact。
  [in] | thumbnail | 用作结果文档中注释类型的缩略图的位图。 这应该是一个有效的位图。如果位图大小不是12*12， 使用时位图将被缩放到12*12。

返回
  None.

## ◆ SetAnnotType()

FSDK::AnnotationSummarySettings::SetAnnotType | ( | type | ,
|  | use_all |
| ) |  |

设置选项以决定将汇总哪种类型的注释。

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

参数

  [in] | type | 注释类型，用于决定将汇总哪些注释。 请参考从 FSDK.Annot.e_Note 开始的值，这应该是这些值之一， 但不包括 FSDK.Annot.e_Link、FSDK.Annot.e_PSInk、 FSDK.Annot.e_Sound、FSDK.Annot.e_Movie、 FSDK.Annot.e_Widget、FSDK.Annot.e_Screen、 FSDK.Annot.e_PrinterMark、FSDK.Annot.e_TrapNet、 FSDK.Annot.e_Watermark、FSDK.Annot.e_3D、 FSDK.Annot.e_Popup、FSDK.Annot.e_Redact。
  [in] | use_all | 布尔值，用于决定是否在结果文档中汇总所有支持的注释： true 表示汇总所有支持类型的注释。 在这种情况下，参数 type 将被忽略。 false 表示仅汇总参数 type 指定的注释。

返回
  无。

## ◆ SetConnectorLineColor()

FSDK::AnnotationSummarySettings::SetConnectorLineColor | ( | color |  | ) |

设置连接线颜色。

此选项将在汇总布局类型设置为 FSDK.AnnotationSummarySettings.e_SummaryLayoutSeparatePagesWithLine 或 FSDK.AnnotationSummarySettings.e_SummaryLayoutSinglePageWithLine （通过函数 FSDK.AnnotationSummarySettings.SetSummaryLayout）时生效。 如果未设置，将使用默认值0x000000。

参数

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

返回
  None.

## ◆ SetConnectorLineOpacity()

FSDK::AnnotationSummarySettings::SetConnectorLineOpacity | ( | opacity |  | ) |

设置连接线不透明度。

此选项将在汇总布局类型设置为 FSDK.AnnotationSummarySettings.e_SummaryLayoutSeparatePagesWithLine 或 FSDK.AnnotationSummarySettings.e_SummaryLayoutSinglePageWithLine （通过函数 FSDK.AnnotationSummarySettings.SetSummaryLayout）时生效。 如果未设置，将使用默认值1.0。

参数

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

返回
  None.

## ◆ SetEndPage()

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 时被检查。

返回
  None.

## ◆ SetFileTitle()

FSDK::AnnotationSummarySettings::SetFileTitle | ( | title |  | ) |

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

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

参数

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

返回
  无。

## ◆ SetFontSize()

FSDK::AnnotationSummarySettings::SetFontSize | ( | type |  | ) |

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

对于新构造的对象，如果未调用此函数来设置此选项， 表示将 FSDK.AnnotationSummarySettings.e_FontSizeMedium 用作此选项的默认值。

参数

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

返回
  无。

## ◆ SetPageMargin()

FSDK::AnnotationSummarySettings::SetPageMargin | ( | margin |  | ) |

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

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

参数

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

返回
  无。

## ◆ SetPageRect()

FSDK::AnnotationSummarySettings::SetPageRect | ( | rect |  | ) |

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

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

参数

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

返回
  无。

## ◆ SetSortType()

FSDK::AnnotationSummarySettings::SetSortType | ( | type |  | ) |

设置选项以决定按什么排序注释。

对于新构造的对象，如果未调用此函数来设置此选项， 表示将 FSDK.AnnotationSummarySettings.e_TypeSortByAnnotationType 用作此选项的默认值。

参数

  [in] | type | 用于汇总注释的排序类型。请参考从 FSDK.AnnotationSummarySettings.e_TypeSortByAuthor 开始的值， 这应该是这些值之一。

返回
  无。

## ◆ SetStartPage()

FSDK::AnnotationSummarySettings::SetStartPage | ( | page_index |  | ) |

设置起始页索引。

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

参数

  [in] | page_index | 指定汇总操作开始的起始页的页索引。 有效范围：从0到(count-1)。count 由函数 FSDK.PDFDoc.GetPageCount 返回，用于将被汇总注释的PDF文档。 此索引将在调用函数 FSDK.AnnotationSummary.StartSummarize 时被检查。

返回
  None.

## ◆ SetSummaryLayout()

FSDK::AnnotationSummarySettings::SetSummaryLayout | ( | type |  | ) |

设置摘要布局类型。

对于新构造的对象，如果未调用此函数来设置此选项， 表示将 FSDK.AnnotationSummarySettings.e_SummaryLayoutSeparatePagesWithLine 用作此选项的默认值。

参数

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

返回
  无。

## 类成员变量说明

## ◆ e_FontSizeSmall

FSDK::AnnotationSummarySettings::e_FontSizeSmall
| static

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

此枚举的值应单独使用。

如果设置，表示在结果文档中使用小字体大小。

## ◆ e_SummaryLayoutSeparatePagesWithLine

FSDK::AnnotationSummarySettings::e_SummaryLayoutSeparatePagesWithLine
| static

用于注释摘要布局的选项枚举。

此枚举的值应单独使用。

如果设置，表示在单独的页面上使用连接线布局文档和注释。

## ◆ e_TypeSortByAuthor

FSDK::AnnotationSummarySettings::e_TypeSortByAuthor
| static

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

此枚举的值应单独使用。

如果设置，表示在结果文档中按作者排序注释。