Foxit PDF SDK

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

## Public 成员函数
| GetCurrentLocaleID ()
| 用于指定当前区域设置 ID 的回调函数。 更多...
| GetLocalFontName ()
| 用于指定本地使用的字体名称的回调函数。 更多...
| LoadString (id)
| 用于为指定情况加载本地语言字符串的回调函数。 更多...
| Release ()
| 用于释放当前回调对象本身的回调函数。 更多...

## 静态 Public 属性
static | e_AnnotationSummaryStringIDAuthor
| 字符串 ID 枚举，用于指定汇总注释时结果文档中的字符串或前缀。 更多...
static | e_AnnotationSummaryStringIDDate
| 注释摘要字符串 ID：指定在结果文档中输出日期信息时的前缀。 默认前缀为 "Date:"。
static | e_AnnotationSummaryStringIDDocumentTitle
| 注释摘要字符串 ID：指定结果文档中的文档标题。默认标题为 "Summary of comments:"。
static | e_AnnotationSummaryStringIDNoAnnotations
| 注释摘要字符串 ID：指定当页面没有任何注释时在结果文档中用作内容的字符串。 默认内容为 "No Annotations."。
static | e_AnnotationSummaryStringIDNumber
| 注释摘要字符串 ID：指定在结果文档中输出编号信息时的前缀。 默认前缀为 "Number:"。
static | e_AnnotationSummaryStringIDPage
| 注释摘要字符串 ID：指定在结果文档中输出页面信息时的前缀。 默认前缀为 "Page:"。
static | e_AnnotationSummaryStringIDPageTitle
| 注释摘要字符串 ID：指定在结果文档中输出页面标题时的前缀。默认字符串为 "Page:"。
static | e_AnnotationSummaryStringIDSubject
| 注释摘要字符串 ID：指定在结果文档中输出主题信息时的前缀。 默认前缀为 "Subject:"。
static | e_AnnotationSummaryStringIDType
| 注释摘要字符串 ID：指定在结果文档中输出注释类型时的前缀。 默认前缀为 "Type:"。

## 详细描述

此类表示一个回调对象，在汇总注释期间使用，以允许用户决定某些格式/数据。 此类中的所有纯虚函数都用作回调函数，应由用户实现。 实现的 FSDK.AnnotationSummaryCallback 对象可以通过函数 FSDK.AnnotationSummary.SetCallback 设置到 AnnotationSummary 对象。

## 成员函数说明

## ◆ GetCurrentLocaleID()

FSDK::AnnotationSummaryCallback::GetCurrentLocaleID | ( |  | ) |

用于指定当前区域设置 ID 的回调函数。

区域设置 ID 用于决定某些信息的区域设置格式，例如日期格式。

返回
  区域设置 ID。请参考从 FSDK.e_LocaleIDUnspecified 开始的值， 这应该是这些值之一。如果返回的区域设置 ID 不受支持，Foxit PDF SDK 将默认使用 值 FSDK.e_LocaleIDUnspecified。

## ◆ GetLocalFontName()

FSDK::AnnotationSummaryCallback::GetLocalFontName | ( |  | ) |

用于指定本地使用的字体名称的回调函数。

此函数对于用户指定结果文档中使用的字体非常有用。

返回
  字体名称字符串。如果返回空字符串，Foxit PDF SDK 将使用 "Helvetica" 作为默认字体名称。 如果返回的字体名称无效，此名称将不会产生任何效果。

## ◆ LoadString()

FSDK::AnnotationSummaryCallback::LoadString | ( | id |  | ) |

用于为指定情况加载本地语言字符串的回调函数。

此函数对于用户在结果文档中使用本地语言的某些字符串内容非常有用。 通过使用此函数，用户可以为结果文档中的指定情况重写或翻译默认输出字符串为本地语言。 这些指定情况的默认输出字符串可以在从 FSDK.AnnotationSummaryCallback.e_AnnotationSummaryStringIDAuthor 开始的值的注释中找到。
特别地，Foxit PDF SDK 将在结果文档的格式部分添加一些必要的信息/数据， 以使结果文档中的内容更有用。

参数

  [in] | id | 注释摘要字符串 ID，用于指定摘要情况。请参考从 FSDK.AnnotationSummaryCallback.e_AnnotationSummaryStringIDAuthor 开始的值，这将是 这些值之一。

返回
  用于指定情况的字符串。

## ◆ Release()

FSDK::AnnotationSummaryCallback::Release | ( |  | ) |

用于释放当前回调对象本身的回调函数。

返回
  无。

## 类成员变量说明

## ◆ e_AnnotationSummaryStringIDAuthor

FSDK::AnnotationSummaryCallback::e_AnnotationSummaryStringIDAuthor
| static

字符串 ID 枚举，用于指定汇总注释时结果文档中的字符串或前缀。

此枚举的值应单独使用。

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