Foxit PDF SDK

Public 类型 | Public 成员函数 | 所有成员列表
foxit::pdf::AnnotationSummaryCallback类 参考abstract

## Public 类型
enum | AnnotationSummaryStringID { e_AnnotationSummaryStringIDAuthor = 0, e_AnnotationSummaryStringIDDate = 1, e_AnnotationSummaryStringIDPage = 2, e_AnnotationSummaryStringIDType = 3, e_AnnotationSummaryStringIDDocumentTitle = 4, e_AnnotationSummaryStringIDPageTitle = 5, e_AnnotationSummaryStringIDNoAnnotations = 6, e_AnnotationSummaryStringIDNumber = 7, e_AnnotationSummaryStringIDSubject = 8 }
| 用于指定注释摘要时结果文档中的字符串或前缀的字符串 ID 枚举。 更多...

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

## 详细描述

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

## 成员枚举类型说明

## ◆ AnnotationSummaryStringID

enum foxit::pdf::AnnotationSummaryCallback::AnnotationSummaryStringID

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

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

枚举值
e_AnnotationSummaryStringIDAuthor | 注释摘要字符串 ID：指定在结果文档中输出作者信息时的前缀。 默认前缀是 "Author:"。
e_AnnotationSummaryStringIDDate | 注释摘要字符串 ID：指定在结果文档中输出日期信息时的前缀。 默认前缀是 "Date:"。
e_AnnotationSummaryStringIDPage | 注释摘要字符串 ID：指定在结果文档中输出页面信息时的前缀。 默认前缀是 "Page:"。
e_AnnotationSummaryStringIDType | 注释摘要字符串 ID：指定在结果文档中输出注释类型时的前缀。 默认前缀是 "Type:"。
e_AnnotationSummaryStringIDDocumentTitle | 注释摘要字符串 ID：指定结果文档中的文档标题。默认标题是 "Summary of comments:"。
e_AnnotationSummaryStringIDPageTitle | 注释摘要字符串 ID：指定在结果文档中输出页面标题时的前缀。默认字符串是 "Page:"。
e_AnnotationSummaryStringIDNoAnnotations | 注释摘要字符串 ID：指定在页面没有任何注释时在结果文档中作为内容使用的字符串。 默认内容是 "No Annotations."。
e_AnnotationSummaryStringIDNumber | 注释摘要字符串 ID：指定在结果文档中输出数量信息时的前缀。 默认前缀是 "Number:"。
e_AnnotationSummaryStringIDSubject | 注释摘要字符串 ID：指定在结果文档中输出主题信息时的前缀。 默认前缀是 "Subject:"。

## 成员函数说明

## ◆ GetCurrentLocaleID()

virtual common::LocaleID foxit::pdf::AnnotationSummaryCallback::GetCurrentLocaleID | ( |  | ) |
| pure virtual

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

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

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

## ◆ GetLocalFontName()

virtual WString foxit::pdf::AnnotationSummaryCallback::GetLocalFontName | ( |  | ) |
| pure virtual

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

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

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

## ◆ LoadString()

virtual WString foxit::pdf::AnnotationSummaryCallback::LoadString | ( | AnnotationSummaryStringID | id | ) |
| pure virtual

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

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

参数

  [in] | id | 指定摘要情况的注释摘要字符串 ID。请参考从 AnnotationSummaryCallback::e_AnnotationSummaryStringIDAuthor 开始的值， 这应该是这些值中的一个。

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

## ◆ Release()

virtual void foxit::pdf::AnnotationSummaryCallback::Release | ( |  | ) |
| pure virtual

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

返回
  无。