Foxit PDF SDK
Public 成员函数 | 静态 Public 属性 | 所有成员列表
FSDK::ActionCallback类 参考

Public 成员函数

 Beep (type)
 使系统播放声音的回调函数。 更多...
 
 CloseDoc (document, is_prompt_to_save)
 关闭文档的回调函数。 更多...
 
 CreateBlankDoc ()
 创建空白 PDF 文档对象的回调函数。 更多...
 
 ExecuteNamedAction (document, named_action)
 执行命名操作的回调函数。 更多...
 
 GetAttachmentsFilePath (pdf_doc, name)
 获取附件文件的文件路径的回调函数。 更多...
 
 GetCurrentDoc ()
 接收当前 PDF 文档对象的回调函数。 更多...
 
 GetCurrentPage (document)
 用于接收当前页面索引的回调函数。 更多...
 
 GetDocChangeMark (document)
 接收指示文档内容是否更改的更改标记的回调函数。 更多...
 
 GetExtractedEmbeddedFilePath (pdf_doc, name)
 用于获取提取的嵌入文件的文件路径的回调函数。 更多...
 
 GetFilePath (document)
 获取当前 PDF 文档的文件路径的回调函数。 更多...
 
 GetOpenedDocCount ()
 接收已打开文档数量的回调函数。 更多...
 
 GetPageRotation (document, page_index)
 用于接收当前 PDF 查看器上页面的显示旋转的回调函数。 更多...
 
 InvalidateRect (document, page_index, pdf_rect)
 使指定矩形内的客户区域无效的回调函数。 更多...
 
 IsLocalFile (document)
 检查文件是否为本地文件的回调函数。 更多...
 
 OpenDoc (file_path, password)
 打开 PDF 文件的回调函数。 更多...
 
 Print (document, is_ui, page_range, is_silent, is_shrunk_to_fit, is_printed_as_image, is_reversed, is_to_print_annots)
 用于打印指定索引范围内的页面的回调函数。 更多...
 
 Print (document, print_params) SubmitForm(document
 用于使用打印参数打印文档的回调函数。 更多...
 
 Release ()
 用于释放当前回调对象本身的回调函数。 更多...
 
 Response (question, title, default_value, label, is_password)
 显示一个对话框的回调函数，该对话框包含一个问题和一个输入字段， 供用户回答问题。 更多...
 
 SetCurrentPage (document, destination)
 用于通过目标设置当前页面的回调函数。 更多...
 
 SetCurrentPage (document, page_index)
 用于通过索引设置当前页面的回调函数。 更多...
 
 SetDocChangeMark (document, change_mark)
 设置指示文档内容是否更改的更改标记的回调函数。 更多...
 
 SetPageRotation (document, page_index, rotation)
 用于在 PDF 查看器上设置页面的旋转值的回调函数。 更多...
 

静态 Public 属性

static e_AppInfoTypeAppVersion
 应用程序的应用版本信息。
 
static e_AppInfoTypeFormsVersion
 应用程序信息类型的枚举。 更多...
 
static e_AppInfoTypeViewerType
 应用程序的查看器类型信息。
 
static e_AppInfoTypeViewerVariation
 应用程序的查看器变体信息。
 
static e_AppInfoTypeViewerVersion
 应用程序的查看器版本信息。
 
static e_JSFieldValueChangedByCalculation
 javascript 字段值更改类型：计算。
 
static e_JSFieldValueChangedByFormat
 javascript 字段值更改类型的枚举。 更多...
 
static e_JSFieldValueChangedBySet
 javascript 字段值更改类型：字段设置。
 
static e_JSMailResultFailed
 邮件结果的枚举。 更多...
 
static e_JSMailResultSuccess
 邮件结果：邮件成功。
 
static e_JSMailResultUserAbort
 邮件结果：用户中止。
 
static e_JSMediaPlayerStateClose
 媒体播放器状态：关闭。
 
static e_JSMediaPlayerStateOpen
 媒体播放器状态的枚举。 更多...
 
static e_JSMediaPlayerStatePlaying
 媒体播放器状态：播放中。
 
static e_JSMediaPlayerStateStop
 媒体播放器状态：停止。
 
static e_JSMediaPlayerStateSuspend
 媒体播放器状态：暂停。
 
static e_LanguageCHS
 简体中文。
 
static e_LanguageCHT
 繁体中文。
 
static e_LanguageDAN
 丹麦语。
 
static e_LanguageDEU
 德语。
 
static e_LanguageENU
 英语。
 
static e_LanguageESP
 西班牙语。
 
static e_LanguageFRA
 法语。
 
static e_LanguageITA
 意大利语。
 
static e_LanguageJPN
 日语。
 
static e_LanguageKOR
 韩语。
 
static e_LanguageNLD
 荷兰语。
 
static e_LanguageNOR
 挪威语。
 
static e_LanguagePTB
 巴西葡萄牙语。
 
static e_LanguageSUO
 芬兰语。
 
static e_LanguageSVE
 瑞典语。
 
static e_LanguageUnknown
 语言的枚举。 更多...
 
static e_LayoutModeContinuous
 布局模式：连续页。
 
static e_LayoutModeContinuousFacing
 布局模式：连续双页。
 
static e_LayoutModeFacing
 布局模式：双页。
 
static e_LayoutModeSinglePage
 布局模式的枚举。 更多...
 
static e_MailTypeDoc
 要发送的数据类型的枚举。 更多...
 
static e_MailTypeForm
 邮件数据类型：表单。
 
static e_MailTypeMsg
 邮件数据类型：字符串消息。
 
static e_ModifyItemTypeAnnot
 修改项类型：注释。
 
static e_ModifyItemTypeDoc
 修改项类型：文档。
 
static e_ModifyItemTypeField
 修改项类型：字段。
 
static e_ModifyItemTypeNone
 修改项类型的枚举。 更多...
 
static e_ModifyItemTypePage
 修改项类型：页面。
 
static e_SearchScopeActiveDoc
 搜索范围的枚举。 更多...
 
static e_SearchScopeActiveIndexes
 搜索范围：活动索引。
 
static e_SearchScopeFolder
 搜索范围：文件夹。
 
static e_SearchScopeIndex
 搜索范围：索引。
 

详细描述

此类表示用于执行PDF操作的回调对象。 此类中的所有纯虚函数都用作回调函数，应由用户实现。 以执行 PDF 操作，如 javascript 操作。

成员函数说明

◆ Beep()

FSDK::ActionCallback::Beep (   type)
inline

使系统播放声音的回调函数。

此回调函数是可选的，因此可以实现为什么也不做， 并仅返回一个无用的值。

参数
[in]type声音类型。该值将是以下值之一：
  • 0: 错误
  • 1: 警告
  • 2: 问题
  • 3: 状态
  • 4: 默认（默认值）
返回
true 表示成功，而 false 表示失败。

◆ CloseDoc()

FSDK::ActionCallback::CloseDoc (   document,
  is_prompt_to_save 
)
inline

关闭文档的回调函数。

此回调函数将由 javascript 方法“Doc.closeDoc”触发。 此回调函数是可选的，因此可以实现为什么也不做。

参数
[in]document一个 PDF 文档对象。它将是有效的。
[in]is_prompt_to_savetrue 表示显示保存提示，而 false 表示不显示。
返回
无。

◆ CreateBlankDoc()

FSDK::ActionCallback::CreateBlankDoc ( )
inline

创建空白 PDF 文档对象的回调函数。

此回调函数是可选的，因此可以实现为什么也不做， 并仅返回一个无用的值。

返回
新创建的空白 PDF 文档对象。

◆ ExecuteNamedAction()

FSDK::ActionCallback::ExecuteNamedAction (   document,
  named_action 
)
inline

执行命名操作的回调函数。

有关更多详细信息，请参阅 <PDF Reference 1.7> 第 8.5.3 节中的“命名操作”的描述。 此回调函数是可选的，因此可以实现为什么也不做， 并仅返回一个无用的值。

参数
[in]document一个 PDF 文档对象。它将是有效的。
[in]named_action用于指定命名操作的字符串。
返回
true 表示成功，而 false 表示失败。

◆ GetAttachmentsFilePath()

FSDK::ActionCallback::GetAttachmentsFilePath (   pdf_doc,
  name 
)
inline

获取附件文件的文件路径的回调函数。

此回调函数将由 javascript 方法"Doc.importDataObject"触发。 此回调函数是可选的，因此可以实现为什么也不做， 并仅返回一个无用的值。

参数
[in]pdf_doc一个 PDF 文档对象。它将嵌入一个数据对象。
[in]name与数据对象关联的名称。它是方法"Doc.importDataObject"的参数"cName"。
返回
将作为数据对象嵌入的文件的路径。

◆ GetCurrentDoc()

FSDK::ActionCallback::GetCurrentDoc ( )
inline

接收当前 PDF 文档对象的回调函数。

此回调函数是可选的，因此可以实现为什么也不做， 并仅返回一个无用的值。

返回
当前 PDF 文档对象。

◆ GetCurrentPage()

FSDK::ActionCallback::GetCurrentPage (   document)
inline

用于接收当前页面索引的回调函数。

此回调函数是可选的，因此可以实现为什么也不做， 并仅返回一个无用的值。

参数
[in]document一个 PDF 文档对象。它将是有效的。
返回
当前页面索引。该值应从 0 开始，并小于指定文档的页面数。

◆ GetDocChangeMark()

FSDK::ActionCallback::GetDocChangeMark (   document)
inline

接收指示文档内容是否更改的更改标记的回调函数。

此回调函数是可选的，因此可以实现为什么也不做， 并仅返回一个无用的值。

参数
[in]document一个 PDF 文档对象。它将是有效的。
返回
true 表示 PDF 文档已更改，而 false 表示未更改。

◆ GetExtractedEmbeddedFilePath()

FSDK::ActionCallback::GetExtractedEmbeddedFilePath (   pdf_doc,
  name 
)
inline

用于获取提取的嵌入文件的文件路径的回调函数。

此回调函数将由 javascript 方法"Doc.exportDataObject"触发。 此回调函数是可选的，因此可以实现为什么也不做， 并仅返回一个无用的值。

参数
[in]pdf_doc一个 PDF 文档对象。它将作为数据对象嵌入到文件中。
[in]name要提取的数据对象的名称。它是方法"Doc.exportDataObject"的参数"cName"。
返回
将嵌入数据对象的文件的路径。

◆ GetFilePath()

FSDK::ActionCallback::GetFilePath (   document)
inline

获取当前 PDF 文档的文件路径的回调函数。

此回调函数是可选的，因此可以实现为什么也不做， 并仅返回一个无用的值。

参数
[in]document一个 PDF 文档对象。它将是有效的。
返回
文件路径。

◆ GetOpenedDocCount()

FSDK::ActionCallback::GetOpenedDocCount ( )
inline

接收已打开文档数量的回调函数。

此回调函数是可选的，因此可以实现为什么也不做， 并仅返回一个无用的值。

返回
已打开文档的数量。

通过索引接收已打开的 PDF 文档对象的回调函数。

此回调函数是可选的，因此可以实现为什么也不做， 并仅返回一个无用的值。

参数
[in]index已打开 PDF 文档的索引。有效范围：从 0 到 count-1。 count 由回调函数 FSDK.ActionCallback.GetOpenedDocCount 返回；
返回
一个已打开的 PDF 文档对象。

◆ GetPageRotation()

FSDK::ActionCallback::GetPageRotation (   document,
  page_index 
)
inline

用于接收当前 PDF 查看器上页面的显示旋转的回调函数。

此回调函数是可选的，因此可以实现为什么也不做， 并仅返回一个无用的值。

参数
[in]document一个 PDF 文档对象。它将是有效的。
[in]page_index页面索引，用于指定要检索哪个页面的旋转。 索引将从 0 开始，并小于指定文档的页面数。
返回
指定页面的旋转。请参考从 FSDK.e_Rotation0 开始的值， 此值应为这些值之一。

◆ InvalidateRect()

FSDK::ActionCallback::InvalidateRect (   document,
  page_index,
  pdf_rect 
)
inline

使指定矩形内的客户区域无效的回调函数。

所有位置均以 PDF“用户空间”测量。实现应调用函数 FSDK.Renderer.StartRender 来重新绘制指定的页面区域。

参数
[in]document一个 PDF 文档对象。它将是有效的。
[in]page_index页面索引。它将从 0 开始，并小于指定文档的页面数。
[in]pdf_rect指定 PDF 坐标系统 中页面区域的矩形。 如果这是一个空矩形，则意味着刷新整个页面。
返回
true 表示成功，而 false 表示失败。

◆ IsLocalFile()

FSDK::ActionCallback::IsLocalFile (   document)
inline

检查文件是否为本地文件的回调函数。

此回调函数是可选的，因此可以实现为什么也不做， 并仅返回一个无用的值。

参数
[in]document一个 PDF 文档对象。它将是有效的。
返回
true 表示 PDF 文件是本地文件。

◆ OpenDoc()

FSDK::ActionCallback::OpenDoc (   file_path,
  password 
)
inline

打开 PDF 文件的回调函数。

此回调函数是可选的，因此可以实现为什么也不做， 并仅返回一个无用的值。

参数
[in]file_path现有 PDF 文件的完整路径。
[in]password输入 PDF 文件的密码。这可以是一个空字符串。
返回
一个已打开的 PDF 文档对象。

◆ Print() [1/2]

FSDK::ActionCallback::Print (   document,
  is_ui,
  page_range,
  is_silent,
  is_shrunk_to_fit,
  is_printed_as_image,
  is_reversed,
  is_to_print_annots 
)
inline

用于打印指定索引范围内的页面的回调函数。

此回调函数是可选的，因此可以实现为什么也不做， 并仅返回一个无用的值。

参数
[in]document一个 PDF 文档对象。它应该是有效的。
[in]is_uitrue 表示应向用户显示 UI 以获取打印信息并确认操作。
[in]page_range用于指定打印页面范围的范围对象。 此范围中表示的所有索引将从 0 开始， 并小于指定文档的页面数。
[in]is_silenttrue 表示在打印文档时 应禁止显示取消对话框。
[in]is_shrunk_to_fittrue 表示页面应缩小（如有必要） 以适应打印页面的区域。
[in]is_printed_as_imagetrue 表示页面应作为图像打印。
[in]is_reversedtrue 表示打印顺序应从参数 end 到 参数 start。
[in]is_to_print_annotstrue 表示注释应与页面一起打印。
返回
true 表示成功，而 false 表示失败。

◆ Print() [2/2]

FSDK::ActionCallback::Print (   document,
  print_params 
)

用于使用打印参数打印文档的回调函数。

此回调函数是可选的，因此可以实现为什么也不做， 并仅返回一个无用的值。

参数
[in]document一个 PDF 文档对象。它应该是有效的。
[in]print_params一个 FSDK.PrintParams 对象。
返回
true 表示成功，而 false 表示失败。

用于将表单数据提交到指定 URL 的回调函数。

此回调函数是可选的，因此可以实现为什么也不做， 并仅返回一个无用的值。

参数
[in]document一个 PDF 文档对象。它应该是有效的。
[in]form_data要提交的表单数据缓冲区。
[in]length缓冲区参数 form_data 的大小（以字节为单位）。
[in]url要提交表单数据的 URL。
[in]file_format_type提交表单的文件格式类型。请参考从 FSDK.e_FileFormatTypeFDF 开始的值， 此值应为这些值之一。
返回
true 表示成功，而 false 表示失败。

◆ Release()

FSDK::ActionCallback::Release ( )
inline

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

返回
无。

◆ Response()

FSDK::ActionCallback::Response (   question,
  title,
  default_value,
  label,
  is_password 
)
inline

显示一个对话框的回调函数，该对话框包含一个问题和一个输入字段， 供用户回答问题。

此回调函数是可选的，因此可以实现为什么也不做， 并仅返回一个无用的值。

参数
[in]question指定要向用户提出的问题的字符串。
[in]title指定对话框标题的字符串。
[in]default_value指定默认值作为问题答案的字符串。 如果未指定答案，则不显示默认值。
[in]label指定显示在编辑文本字段前面的短字符串。
[in]is_password指示是否应屏蔽用户的响应的布尔值：
true 表示用户的响应应显示为星号 (*) 或项目符号 (?) 以屏蔽响应，因为可能是敏感信息。
返回
用户的响应。可以是一个空字符串。

◆ SetCurrentPage() [1/2]

FSDK::ActionCallback::SetCurrentPage (   document,
  destination 
)
inline

用于通过目标设置当前页面的回调函数。

此回调函数是可选的，因此可以实现为什么也不做。

参数
[in]document一个 PDF 文档对象。它将是有效的。
[in]destination一个 FSDK.object。 无。

◆ SetCurrentPage() [2/2]

FSDK::ActionCallback::SetCurrentPage (   document,
  page_index 
)
inline

用于通过索引设置当前页面的回调函数。

此回调函数是可选的，因此可以实现为什么也不做。

参数
[in]document一个 PDF 文档对象。它将是有效的。
[in]page_index用于更改当前页面的页面索引。 索引将从 0 开始，并小于指定文档的页面数。
返回
无。

◆ SetDocChangeMark()

FSDK::ActionCallback::SetDocChangeMark (   document,
  change_mark 
)
inline

设置指示文档内容是否更改的更改标记的回调函数。

此回调函数是可选的，因此可以实现为什么也不做， 并仅返回一个无用的值。

参数
[in]document一个 PDF 文档对象。它将是有效的。
[in]change_mark一个布尔值，指示文档内容是否更改。
返回
true 表示成功，而 false 表示失败。

◆ SetPageRotation()

FSDK::ActionCallback::SetPageRotation (   document,
  page_index,
  rotation 
)
inline

用于在 PDF 查看器上设置页面的旋转值的回调函数。

此回调函数是可选的，因此可以实现为什么也不做。

参数
[in]document一个 PDF 文档对象。它将是有效的。
[in]page_index页面索引，用于指定要更改哪个页面的旋转。 索引将从 0 开始，并小于指定文档的页面数。
[in]rotation新的旋转值。请参考从 FSDK.e_Rotation0 开始的值， 此值应为这些值之一，除了 FSDK.e_RotationUnknown。
返回
true 表示成功，而 false 表示失败。

类成员变量说明

◆ e_AppInfoTypeFormsVersion

FSDK::ActionCallback::e_AppInfoTypeFormsVersion
static

应用程序信息类型的枚举。

此枚举的值应单独使用。

应用程序的表单版本信息。

◆ e_JSFieldValueChangedByFormat

FSDK::ActionCallback::e_JSFieldValueChangedByFormat
static

javascript 字段值更改类型的枚举。

此枚举的值应单独使用。

javascript 字段值更改类型：格式化。

◆ e_JSMailResultFailed

FSDK::ActionCallback::e_JSMailResultFailed
static

邮件结果的枚举。

此枚举的值应单独使用。

邮件结果：邮件失败。

◆ e_JSMediaPlayerStateOpen

FSDK::ActionCallback::e_JSMediaPlayerStateOpen
static

媒体播放器状态的枚举。

此枚举的值应单独使用。

媒体播放器状态：打开。

◆ e_LanguageUnknown

FSDK::ActionCallback::e_LanguageUnknown
static

语言的枚举。

此枚举的值应单独使用。

未知语言。

◆ e_LayoutModeSinglePage

FSDK::ActionCallback::e_LayoutModeSinglePage
static

布局模式的枚举。

此枚举的值应单独使用。

布局模式：单页。

◆ e_MailTypeDoc

FSDK::ActionCallback::e_MailTypeDoc
static

要发送的数据类型的枚举。

此枚举的值应单独使用。

邮件数据类型：文档。

◆ e_ModifyItemTypeNone

FSDK::ActionCallback::e_ModifyItemTypeNone
static

修改项类型的枚举。

此枚举的值应单独使用。

修改项类型：无。

◆ e_SearchScopeActiveDoc

FSDK::ActionCallback::e_SearchScopeActiveDoc
static

搜索范围的枚举。

此枚举的值应单独使用。

搜索范围：活动文档。