|
Foxit PDF SDK
|
Public 成员函数 | |
| AddMenuItem (menu_item_config, is_prepend) | |
| 向菜单添加菜单项的回调函数。 更多... | |
| AddSearchIndex (di_path, is_selected) | |
| 添加搜索索引的回调函数。 更多... | |
| AddSubMenu (menu_item_config) | |
| 向应用程序添加带有子菜单的菜单项的回调函数。 更多... | |
| AddToolButton (button_item) | |
| 用于添加工具按钮的回调函数。 更多... | |
| Alert (msg, title, type, icon) GetIdentityProperties() | |
| 用于弹出对话框显示警告或提示的回调函数。 更多... | |
| Beep (type) | |
| 使系统播放声音的回调函数。 更多... | |
| BrowseFile () | |
| 用于显示文件选择对话框的回调函数,应返回所选的文件路径。 更多... | |
| BrowseFile (is_open_dialog, file_format, file_filter) | |
| 用于显示文件选择对话框的回调函数。 更多... | |
| CloseDoc (document, is_prompt_to_save) | |
| 关闭文档的回调函数。 更多... | |
| CreateBlankDoc () | |
| 创建空白 PDF 文档对象的回调函数。 更多... | |
| EnablePageLoop (is_loop) | |
| 用于设置标志的回调函数,该标志指定文档是否将循环回到文档开头 以响应全屏模式下的页面前进(无论是由鼠标单击、键盘还是计时器生成)。 更多... | |
| ExecuteNamedAction (document, named_action) | |
| 执行命名操作的回调函数。 更多... | |
| GetAppInfo (type) | |
| 用于获取应用程序信息的回调函数。 更多... | |
| GetAttachmentsFilePath (pdf_doc, name) | |
| 获取附件文件的文件路径的回调函数。 更多... | |
| GetOpenedDocCount() | GetCurrentDoc () |
| 接收已打开文档数量的回调函数。 更多... | |
| GetCurrentPage (document) | |
| 用于接收当前页面索引的回调函数。 更多... | |
| GetDocChangeMark (document) | |
| 接收指示文档内容是否更改的更改标记的回调函数。 更多... | |
| GetExtractedEmbeddedFilePath (pdf_doc, name) | |
| 用于获取提取的嵌入文件的文件路径的回调函数。 更多... | |
| GetFilePath (document) | |
| 获取当前 PDF 文档的文件路径的回调函数。 更多... | |
| GetFullScreen () | |
| 获取是否设置了全屏模式的回调函数。 更多... | |
| GetLanguage () | |
| 用于获取正在运行的查看器应用程序的语言的回调函数。 更多... | |
| GetLayoutMode () | |
| 获取当前文档的页面布局的回调函数。 更多... | |
| GetMenuItemNameList () | |
| 用于获取菜单项名称列表的回调函数。 更多... | |
| GetMousePosition () | |
| 获取当前鼠标位置的回调函数。 更多... | |
| GetPageRotation (document, page_index) | |
| 用于接收当前 PDF 查看器上页面的显示旋转的回调函数。 更多... | |
| GetPageScale () | |
| 获取当前页面缩放值的回调函数。 更多... | |
| GetPageWindowRect (document, page_index) | |
| 获取页面视图窗口矩形的回调函数。页面视图窗口是 显示 PDF 内容的内部文档窗口内的区域。 更多... | |
| GetPageZoomMode () | |
| 获取当前页面缩放模式的回调函数。 更多... | |
| GetPrinterNameList () | |
| 用于获取打印机名称列表的回调函数。 更多... | |
| GetSignatureAPStyleNameList () | |
| 获取签名外观样式名称列表的回调函数。 更多... | |
| GetTemporaryDirectory () | |
| 获取临时目录的回调函数。 更多... | |
| GetTemporaryFileName (document, file_suffix_name) | |
| 获取临时文件路径的回调函数。临时文件名由文档名称和文件后缀名组合而成。 更多... | |
| GetUntitledBookmarkName () | |
| 用于获取未命名书签的新名称的回调函数。 更多... | |
| GetVisiblePage (document, index) | |
| A callback function to get the visible page index. 更多... | |
| GetVisiblePageCount (document) | |
| 获取可见页面个数的回调。 更多... | |
| InitModifyItem (document, item_type, page_index, dict_name) | |
| 初始化修改项的回调。 更多... | |
| InvalidateRect (document, page_index, pdf_rect) | |
| 使指定矩形内的客户区域无效的回调函数。 更多... | |
| IsCurrentDocOpenedInBrowser () | |
| 用于获取指定当前文档是否在浏览器中打开的标志的回调函数。 更多... | |
| IsLocalFile (document) | |
| 检查文件是否为本地文件的回调函数。 更多... | |
| IsPageLoop () | |
| 用于获取标志的回调函数,该标志指定文档是否将循环回到文档开头 以响应页面前进。 更多... | |
| LaunchURL (url) | |
| 用于启动到指定 URL 的回调函数。 更多... | |
| MailData (data, data_type, is_ui, to, subject, cc, bcc, message) | |
| 用于邮寄数据或消息的回调函数,无论是否与用户交互。 更多... | |
| MailDoc (document, to_address, cc_address, bcc_address, subject, message, is_ui) | |
| 将文档作为附件邮寄的回调函数。 更多... | |
| NotifyAfterDataChange (document, modify_item_info) | |
| 用于通知数据已被修改的回调函数。 更多... | |
| NotifyBeginDoJob (document, event_type) | |
| 用于通知 javascript 执行开始的回调函数。 更多... | |
| NotifyEndDoJob (document, event_type) | |
| 用于通知 javascript 执行已结束的回调函数。 更多... | |
| OnFieldValueChanged (field_name, type, value_before_changed, value_after_changed) | |
| 通知字段值更改的回调函数。 更多... | |
| OpenDoc (file_path, password) | |
| 打开 PDF 文件的回调函数。 更多... | |
| OpenMediaPlayer (player_args) | |
| 打开媒体播放器的回调函数。 更多... | |
| PopupMenu (menus, is_selected_item) | |
| 用于弹出菜单窗口的回调函数。 更多... | |
| PopupMenuEx (menus, is_selected_item) | |
| 用于弹出菜单窗口的回调函数。 更多... | |
| PostMessageToHtml (message) | |
| 用于向 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 | |
| 用于使用打印参数打印文档的回调函数。 更多... | |
| Query (keywords, search_scope, search_option, di_path) | |
| 查询文本关键字的回调函数。 更多... | |
| Release () | |
| 用于释放当前回调对象本身的回调函数。 更多... | |
| RemoveSearchIndex (search_index_config) | |
| (保留,尚不支持) 移除搜索索引的回调函数。 更多... | |
| RemoveToolButtom (button_name) | |
| 用于删除由函数 FSDK.ActionCallback.AddToolButton 添加的工具按钮的回调函数。 更多... | |
| ResetModifyItem (document) | |
| 重置修改项的回调。 更多... | |
| Response (question, title, default_value, label, is_password) | |
| 显示一个对话框的回调函数,该对话框包含一个问题和一个输入字段, 供用户回答问题。 更多... | |
| Scroll (point) | |
| 将当前页面上的指定点滚动到当前视图中间的回调函数。 更多... | |
| SelectPageNthWord (page_index, start_offset, end_offset, is_show_selection) | |
| 更改当前页码并选择页面上指定单词的回调函数。 更多... | |
| SetCurrentPage (document, page_index) | |
| 用于通过索引设置当前页面的回调函数。 更多... | |
| SetCurrentPage (document, destination) | |
| 用于通过目标设置当前页面的回调函数。 更多... | |
| SetDefaultPageTransitionMode (trans_type, trans_di) | |
| 用于设置全屏模式的默认页面过渡模式的回调函数。 更多... | |
| SetDocChangeMark (document, change_mark) | |
| 设置指示文档内容是否更改的更改标记的回调函数。 更多... | |
| SetFullScreen (is_full_screen) | |
| 设置全屏模式的回调函数。 更多... | |
| SetIdentityProperties (identity_properties) | |
| 用于设置当前用户的身份属性的回调函数。 更多... | |
| SetLayoutMode (layout_mode, is_cover_mode) | |
| 设置当前文档的页面布局的回调函数。 更多... | |
| SetPageRotation (document, page_index, rotation) | |
| 用于在 PDF 查看器上设置页面的旋转值的回调函数。 更多... | |
| SetPageScale (zoom_mode, dest) | |
| 设置当前页面缩放值的回调函数。 更多... | |
| ShowDialog (dlg_config) | |
| 显示对话框的回调函数。 更多... | |
| SoapRequest (request_params) | |
| 发起远程过程调用 (RPC) 或向 SOAP HTTP 端点发送 XML 消息。 更多... | |
| UpdateLogicalLabel () | |
| 更新逻辑标签的回调函数。 更多... | |
| VerifySignature (document, pdf_signature) | |
| 用于验证指定签名的回调函数。 更多... | |
此类表示用于执行PDF操作的回调对象。 此类中的所有纯虚函数都用作回调函数,应由用户实现。 以执行 PDF 操作,如 javascript 操作。
| FSDK::ActionCallback::AddMenuItem | ( | menu_item_config | , |
| is_prepend | |||
| ) |
向菜单添加菜单项的回调函数。
该回调函数将由 JavaScript 方法 "app.addMenuItem" 触发。
| [in] | menu_item_config | 菜单项的配置。 |
| [in] | is_prepend | 确定新菜单项相对于 FSDK.MenuItemConfig.pos 或 FSDK.MenuItemConfig.pos_str 指定位置的位置。默认值为 false。如果此参数为 true,则插入规则如下:
|
| FSDK::ActionCallback::AddSearchIndex | ( | di_path | , |
| is_selected | |||
| ) |
添加搜索索引的回调函数。
该回调函数将由 JavaScript 方法 "search.addIndex" 触发。此回调函数是可选的, 因此可以实现为不执行任何操作。
| [in] | di_path | 用户硬盘上索引文件的设备独立路径。 |
| [in] | is_selected | 指定是否应选择索引进行搜索。默认值:true。 |
| FSDK::ActionCallback::AddSubMenu | ( | menu_item_config | ) |
向应用程序添加带有子菜单的菜单项的回调函数。
该回调函数将由 JavaScript 方法 "app.addSubMenu" 触发。
| [in] | menu_item_config | 菜单项的配置。 |
| FSDK::ActionCallback::AddToolButton | ( | button_item | ) |
用于添加工具按钮的回调函数。
此回调函数将由 javascript 方法"app.addToolButton"触发。
| [in] | button_item | 工具按钮的 FSDK.ButtonItem 对象。 |
| FSDK::ActionCallback::Alert | ( | msg | , |
| title | , | ||
| type | , | ||
| icon | |||
| ) |
用于弹出对话框显示警告或提示的回调函数。
此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| [in] | msg | 要在对话框中显示的消息字符串。 |
| [in] | title | 对话框的标题。 |
| [in] | type | 按钮组的类型。它将是以下值之一:
|
| [in] | icon | 图标类型。它将是以下值之一:
|
此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| FSDK::ActionCallback::Beep | ( | type | ) |
使系统播放声音的回调函数。
此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| [in] | type | 声音类型。该值将是以下值之一:
|
| FSDK::ActionCallback::BrowseFile | ( | ) |
用于显示文件选择对话框的回调函数,应返回所选的文件路径。
此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| FSDK::ActionCallback::BrowseFile | ( | is_open_dialog | , |
| file_format | , | ||
| file_filter | |||
| ) |
用于显示文件选择对话框的回调函数。
此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| [in] | is_open_dialog | 一个布尔值,用于指定对话框是用于打开文件还是保存文件。 true 表示对话框应用于打开文件,而 false 表示 对话框应用于保存文件。 |
| [in] | file_format | 文件格式字符串。 |
| [in] | file_filter | 文件筛选器字符串。 |
| FSDK::ActionCallback::CloseDoc | ( | document | , |
| is_prompt_to_save | |||
| ) |
关闭文档的回调函数。
此回调函数将由 javascript 方法“Doc.closeDoc”触发。 此回调函数是可选的,因此可以实现为什么也不做。
| [in] | document | 一个 PDF 文档对象。它将是有效的。 |
| [in] | is_prompt_to_save | true 表示显示保存提示,而 false 表示不显示。 |
| FSDK::ActionCallback::CreateBlankDoc | ( | ) |
创建空白 PDF 文档对象的回调函数。
此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| FSDK::ActionCallback::EnablePageLoop | ( | is_loop | ) |
用于设置标志的回调函数,该标志指定文档是否将循环回到文档开头 以响应全屏模式下的页面前进(无论是由鼠标单击、键盘还是计时器生成)。
此回调函数将由 javascript 属性"app.fs.loop"触发。 此回调函数是可选的,因此可以实现为什么也不做。
| [in] | is_loop | true 表示循环回到文档开头,而 false 表示不循环。 |
| FSDK::ActionCallback::ExecuteNamedAction | ( | document | , |
| named_action | |||
| ) |
执行命名操作的回调函数。
有关更多详细信息,请参阅 <PDF Reference 1.7> 第 8.5.3 节中的“命名操作”的描述。 此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| [in] | document | 一个 PDF 文档对象。它将是有效的。 |
| [in] | named_action | 用于指定命名操作的字符串。 |
| FSDK::ActionCallback::GetAppInfo | ( | type | ) |
用于获取应用程序信息的回调函数。
此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
对于数字信息,如 FSDK.ActionCallback.e_AppInfoTypeViewerVersion、FSDK.ActionCallback.e_AppInfoTypeAppVersion 和 FSDK.ActionCallback.e_AppInfoTypeFormsVersion,请使用字符串来表示它。
| [in] | type | 信息类型。请参考从 FSDK.ActionCallback.e_AppInfoTypeFormsVersion 开始的值,此值应为这些值之一。 |
| FSDK::ActionCallback::GetAttachmentsFilePath | ( | pdf_doc | , |
| name | |||
| ) |
获取附件文件的文件路径的回调函数。
此回调函数将由 javascript 方法"Doc.importDataObject"触发。 此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| [in] | pdf_doc | 一个 PDF 文档对象。它将嵌入一个数据对象。 |
| [in] | name | 与数据对象关联的名称。它是方法"Doc.importDataObject"的参数"cName"。 |
| GetOpenedDocCount () FSDK::ActionCallback::GetCurrentDoc | ( | ) |
接收已打开文档数量的回调函数。
此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| [in] | index | 已打开 PDF 文档的索引。有效范围:从 0 到 count-1。 count 由回调函数 FSDK.ActionCallback.GetOpenedDocCount 返回; |
此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| FSDK::ActionCallback::GetCurrentPage | ( | document | ) |
用于接收当前页面索引的回调函数。
此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| [in] | document | 一个 PDF 文档对象。它将是有效的。 |
| FSDK::ActionCallback::GetDocChangeMark | ( | document | ) |
接收指示文档内容是否更改的更改标记的回调函数。
此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| [in] | document | 一个 PDF 文档对象。它将是有效的。 |
| FSDK::ActionCallback::GetExtractedEmbeddedFilePath | ( | pdf_doc | , |
| name | |||
| ) |
用于获取提取的嵌入文件的文件路径的回调函数。
此回调函数将由 javascript 方法"Doc.exportDataObject"触发。 此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| [in] | pdf_doc | 一个 PDF 文档对象。它将作为数据对象嵌入到文件中。 |
| [in] | name | 要提取的数据对象的名称。它是方法"Doc.exportDataObject"的参数"cName"。 |
| FSDK::ActionCallback::GetFilePath | ( | document | ) |
获取当前 PDF 文档的文件路径的回调函数。
此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| [in] | document | 一个 PDF 文档对象。它将是有效的。 |
| FSDK::ActionCallback::GetFullScreen | ( | ) |
获取是否设置了全屏模式的回调函数。
该回调函数将由 JavaScript 属性 "app.fullScreen" 或 "app.fs.isFullScreen" 触发。
| FSDK::ActionCallback::GetLanguage | ( | ) |
用于获取正在运行的查看器应用程序的语言的回调函数。
此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| FSDK::ActionCallback::GetLayoutMode | ( | ) |
获取当前文档的页面布局的回调函数。
该回调函数将由 JavaScript 属性 "Doc.layout" 触发。 此回调函数是可选的,因此可以实现为不执行任何操作并 只返回一个无用的值。
| FSDK::ActionCallback::GetMenuItemNameList | ( | ) |
用于获取菜单项名称列表的回调函数。
此回调函数将由 javascript 方法"app.listMenuItems"触发。
| FSDK::ActionCallback::GetMousePosition | ( | ) |
获取当前鼠标位置的回调函数。
该回调函数将由 JavaScript 属性 "doc.mouseX" 或 "doc.mouseY" 触发。 此回调函数是可选的,因此可以实现为不执行任何操作并 只返回一个无用的值。
| FSDK::ActionCallback::GetPageRotation | ( | document | , |
| page_index | |||
| ) |
用于接收当前 PDF 查看器上页面的显示旋转的回调函数。
此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| [in] | document | 一个 PDF 文档对象。它将是有效的。 |
| [in] | page_index | 页面索引,用于指定要检索哪个页面的旋转。 索引将从 0 开始,并小于指定文档的页面数。 |
| FSDK::ActionCallback::GetPageScale | ( | ) |
获取当前页面缩放值的回调函数。
该回调函数将由 JavaScript 属性 "Doc.zoom" 触发。 此回调函数是可选的,因此可以实现为不执行任何操作并 只返回一个无用的值。
| FSDK::ActionCallback::GetPageWindowRect | ( | document | , |
| page_index | |||
| ) |
获取页面视图窗口矩形的回调函数。页面视图窗口是 显示 PDF 内容的内部文档窗口内的区域。
| [in] | document | PDF文档对象,它应该有效。 |
| [in] | page_index | PDF页面索引。 |
该回调函数将由 JavaScript 属性 "Doc.pageWindowRect" 触发。 此回调函数是可选的,因此可以实现为不执行任何操作并 只返回一个无用的值。
| FSDK::ActionCallback::GetPageZoomMode | ( | ) |
获取当前页面缩放模式的回调函数。
该回调函数将由 JavaScript 属性 "Doc.zoom" 或 "Doc.zoomType" 触发。 此回调函数是可选的,因此可以实现为不执行任何操作并 只返回一个无用的值。
| FSDK::ActionCallback::GetPrinterNameList | ( | ) |
用于获取打印机名称列表的回调函数。
此回调函数将由 javascript 属性"app.printerNames"触发。 此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| FSDK::ActionCallback::GetSignatureAPStyleNameList | ( | ) |
获取签名外观样式名称列表的回调函数。
该回调函数将由 JavaScript 方法 "SecurityHandler.appearances" 触发。 此回调函数是可选的,因此可以实现为不执行任何操作。
| FSDK::ActionCallback::GetTemporaryDirectory | ( | ) |
获取临时目录的回调函数。
该回调函数将由 JavaScript 方法 "Doc.extractpages" 触发。 此回调函数是可选的,因此可以实现为不执行任何操作并 只返回一个无用的值。
| FSDK::ActionCallback::GetTemporaryFileName | ( | document | , |
| file_suffix_name | |||
| ) |
获取临时文件路径的回调函数。临时文件名由文档名称和文件后缀名组合而成。
该回调函数将由 JavaScript 方法 "Doc.mailForm" 触发。 此回调函数是可选的,因此可以实现为不执行任何操作并 只返回一个无用的值。
| [in] | document | PDF 文档对象。它将是有效的。 |
| [in] | file_suffix_name | 文件后缀名。 |
| FSDK::ActionCallback::GetUntitledBookmarkName | ( | ) |
用于获取未命名书签的新名称的回调函数。
此回调函数将由 javascript 方法"bookmark.createChild"触发, 当该方法的参数"cName"为空字符串时。 此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| FSDK::ActionCallback::GetVisiblePage | ( | document | , |
| index | |||
| ) |
A callback function to get the visible page index.
此回调函数是可选的,因此可以实现为不做任何事情。
| [in] | document | PDF文档对象,它应该有效。 |
| [in] | index | 可见页面索引。有效值范围:0到(count-1). count 由接口 FSDK.ActionCallback.GetVisiblePagesCount 返回。 |
| FSDK::ActionCallback::GetVisiblePageCount | ( | document | ) |
获取可见页面个数的回调。
此回调函数是可选的,因此可以实现为不做任何事情。
| [in] | document | PDF文档对象,它应该有效。 |
| FSDK::ActionCallback::InitModifyItem | ( | document | , |
| item_type | , | ||
| page_index | , | ||
| dict_name | |||
| ) |
初始化修改项的回调。
此回调函数是可选的,因此可以实现为不做任何事情。
| [in] | document | PDF文档对象,它应该有效。 |
| [in] | item_type | 修改项类型。请参考值从 ActionCallback::e_ModifyItemTypeNone , 它的值应该是这些值中的一个。 |
| [in] | page_index | 被修改的页面索引。 |
| [in] | dict_name | 字典名称。 |
| FSDK::ActionCallback::InvalidateRect | ( | document | , |
| page_index | , | ||
| pdf_rect | |||
| ) |
使指定矩形内的客户区域无效的回调函数。
所有位置均以 PDF“用户空间”测量。实现应调用函数 FSDK.Renderer.StartRender 来重新绘制指定的页面区域。
| [in] | document | 一个 PDF 文档对象。它将是有效的。 |
| [in] | page_index | 页面索引。它将从 0 开始,并小于指定文档的页面数。 |
| [in] | pdf_rect | 指定 PDF 坐标系统 中页面区域的矩形。 如果这是一个空矩形,则意味着刷新整个页面。 |
| FSDK::ActionCallback::IsCurrentDocOpenedInBrowser | ( | ) |
用于获取指定当前文档是否在浏览器中打开的标志的回调函数。
此回调函数将由 javascript 属性"doc.hostContainer"触发。 此回调函数是可选的,因此可以实现为什么也不做。
| FSDK::ActionCallback::IsLocalFile | ( | document | ) |
检查文件是否为本地文件的回调函数。
此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| [in] | document | 一个 PDF 文档对象。它将是有效的。 |
| FSDK::ActionCallback::IsPageLoop | ( | ) |
用于获取标志的回调函数,该标志指定文档是否将循环回到文档开头 以响应页面前进。
此回调函数将由 javascript 属性"app.fs.loop"触发。 此回调函数是可选的,因此可以实现为什么也不做。
| FSDK::ActionCallback::LaunchURL | ( | url | ) |
用于启动到指定 URL 的回调函数。
此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| [in] | url | 一个 URL。 |
| FSDK::ActionCallback::MailData | ( | data | , |
| data_type | , | ||
| is_ui | , | ||
| to | , | ||
| subject | , | ||
| cc | , | ||
| bcc | , | ||
| message | |||
| ) |
用于邮寄数据或消息的回调函数,无论是否与用户交互。
此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| [in] | data | 要邮寄的数据。 数据的值和类型取决于参数 data_type:
|
| [in] | data_type | 邮件类型。请参考从 FSDK.ActionCallback.e_MailTypeDoc 开始的值, 此值应为这些值之一。 |
| [in] | is_ui | true 表示剩余参数用于 为向用户显示的撰写新消息窗口提供种子。 false 表示参数 to 是必需的,所有其他参数 都是可选的。 |
| [in] | to | 指定消息收件人的分号分隔列表的字符串。 |
| [in] | subject | 指定消息主题的字符串。 此字符串的长度限制为 64 KB。 |
| [in] | cc | 指定消息抄送收件人的分号分隔列表的字符串。 |
| [in] | bcc | 指定消息密送收件人的分号分隔列表的字符串。 |
| [in] | message | 指定消息内容的字符串。 此字符串的长度限制为 64 KB。 |
| FSDK::ActionCallback::MailDoc | ( | document | , |
| to_address | , | ||
| cc_address | , | ||
| bcc_address | , | ||
| subject | , | ||
| message | , | ||
| is_ui | |||
| ) |
将文档作为附件邮寄的回调函数。
该回调函数将由 JavaScript 方法 "Doc.mailDoc" 触发。 此回调函数是可选的,因此可以实现为不执行任何操作并 只返回一个无用的值。
| [in] | document | PDF 文档对象。它将是有效的。 |
| [in] | to_address | 收件人地址。 |
| [in] | cc_address | 抄送地址。 |
| [in] | bcc_address | 密件抄送地址。 |
| [in] | subject | 邮件主题。 |
| [in] | message | 邮件消息。 |
| [in] | is_ui | true 表示显示邮件对话框,而 false 表示不显示。 |
| FSDK::ActionCallback::NotifyAfterDataChange | ( | document | , |
| modify_item_info | |||
| ) |
用于通知数据已被修改的回调函数。
此回调函数是可选的,如果不需要任何操作,可以实现为什么也不做。
| [in] | document | 一个 PDF 文档对象。它应该是有效的。 |
| [in] | modify_item_info | 一个 JavascriptModifyItemInfo 对象,包含有关修改的详细信息。 |
| FSDK::ActionCallback::NotifyBeginDoJob | ( | document | , |
| event_type | |||
| ) |
用于通知 javascript 执行开始的回调函数。
此回调函数是可选的,如果不需要任何操作,可以实现为什么也不做。
| [in] | document | 一个 PDF 文档对象。它应该是有效的。 |
| [in] | event_type | javascript 事件类型。请参考从 JavascriptModifyItemInfo::e_JavascriptEventTypeUnknown 开始的值, 此值应为这些值之一。 |
| FSDK::ActionCallback::NotifyEndDoJob | ( | document | , |
| event_type | |||
| ) |
用于通知 javascript 执行已结束的回调函数。
此回调函数是可选的,如果不需要任何操作,可以实现为什么也不做。
| [in] | document | 一个 PDF 文档对象。它应该是有效的。 |
| [in] | event_type | javascript 事件类型。请参考从 JavascriptModifyItemInfo::e_JavascriptEventTypeUnknown 开始的值, 此值应为这些值之一。 |
| FSDK::ActionCallback::OnFieldValueChanged | ( | field_name | , |
| type | , | ||
| value_before_changed | , | ||
| value_after_changed | |||
| ) |
通知字段值更改的回调函数。
该回调函数将在通过 JavaScript 更改字段值时触发。
| [in] | field_name | 指定字段名称的字符串。 |
| [in] | type | 字段值更改类型。请参考以 FSDK.ActionCallback.e_JSFieldValueChangedByFormat 开头的值,这将是其中之一。 |
| [in] | value_before_changed | 指定更改前字段值的字符串数组。 对于列表框,该参数表示同时选择的一个或多个字段项。 |
| [in] | value_after_changed | 指定更改后字段值的字符串数组。 对于列表框,该参数表示同时选择的一个或多个字段项。 |
| FSDK::ActionCallback::OpenDoc | ( | file_path | , |
| password | |||
| ) |
打开 PDF 文件的回调函数。
此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| [in] | file_path | 现有 PDF 文件的完整路径。 |
| [in] | password | 输入 PDF 文件的密码。这可以是一个空字符串。 |
| FSDK::ActionCallback::OpenMediaPlayer | ( | player_args | ) |
打开媒体播放器的回调函数。
该回调函数将由 JavaScript 方法 "app.media.openPlayer" 或 "app.media.createPlayer" 触发。
| [in] | player_args | FSDK.PlayerArgs 对象。 |
| FSDK::ActionCallback::PopupMenu | ( | menus | , |
| is_selected_item | |||
| ) |
用于弹出菜单窗口的回调函数。
菜单窗口的位置与光标位置相同。 此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| [in] | menus | 菜单列表对象的数组。 |
| [out] | is_selected_item | 输出参数,用于接收是否选择了菜单项的值。 true 表示选择了菜单项,而 false 表示未选择菜单项。 |
| FSDK::ActionCallback::PopupMenuEx | ( | menus | , |
| is_selected_item | |||
| ) |
用于弹出菜单窗口的回调函数。
菜单窗口的位置与光标位置相同。 此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| [in] | menus | FSDK.MenuItemEx 对象的数组。 |
| [out] | is_selected_item | 输出参数,用于接收是否选择了菜单项的值。 true 表示选择了菜单项,而 false 表示未选择菜单项。 |
| FSDK::ActionCallback::PostMessageToHtml | ( | message | ) |
用于向 PDF 文档的主机容器的消息处理程序异步发送消息的回调函数。
要传递此消息,主机容器(例如,HTML 页面中的 <OBJECT> 元素)必须 通过设置其 messageHandler 属性来注册通知。
此回调函数将由 javascript 方法"doc.hostContainer.postMessage"触发。 此回调函数是可选的,因此可以实现为什么也不做。
| [in] | message | 指定要发布的消息的字符串数组。 |
| FSDK::ActionCallback::Print | ( | document | , |
| is_ui | , | ||
| page_range | , | ||
| is_silent | , | ||
| is_shrunk_to_fit | , | ||
| is_printed_as_image | , | ||
| is_reversed | , | ||
| is_to_print_annots | |||
| ) |
用于打印指定索引范围内的页面的回调函数。
此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| [in] | document | 一个 PDF 文档对象。它应该是有效的。 |
| [in] | is_ui | true 表示应向用户显示 UI 以获取打印信息并确认操作。 |
| [in] | page_range | 用于指定打印页面范围的范围对象。 此范围中表示的所有索引将从 0 开始, 并小于指定文档的页面数。 |
| [in] | is_silent | true 表示在打印文档时 应禁止显示取消对话框。 |
| [in] | is_shrunk_to_fit | true 表示页面应缩小(如有必要) 以适应打印页面的区域。 |
| [in] | is_printed_as_image | true 表示页面应作为图像打印。 |
| [in] | is_reversed | true 表示打印顺序应从参数 end 到 参数 start。 |
| [in] | is_to_print_annots | true 表示注释应与页面一起打印。 |
| FSDK::ActionCallback::Print | ( | document, | |
| print_params | |||
| ) |
用于使用打印参数打印文档的回调函数。
此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| [in] | document | 一个 PDF 文档对象。它应该是有效的。 |
| [in] | print_params | 一个 FSDK.PrintParams 对象。 |
此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| [in] | document | 一个 PDF 文档对象。它应该是有效的。 |
| [in] | form_data | 要提交的表单数据缓冲区。 |
| [in] | length | 缓冲区参数 form_data 的大小(以字节为单位)。 |
| [in] | url | 要提交表单数据的 URL。 |
| [in] | file_format_type | 提交表单的文件格式类型。请参考从 FSDK.e_FileFormatTypeFDF 开始的值, 此值应为这些值之一。 |
| FSDK::ActionCallback::Query | ( | keywords | , |
| search_scope | , | ||
| search_option | , | ||
| di_path | |||
| ) |
查询文本关键字的回调函数。
该回调函数将由 JavaScript 方法 "search.query" 触发。此回调函数是可选的, 因此可以实现为不执行任何操作。
| [in] | keywords | 要搜索的文本内容。 |
| [in] | search_scope | 指定应在何处搜索文本。请参考以 FSDK.ActionCallback.e_SearchScopeActiveDoc 开头的值,这应该是其中之一。 |
| [in] | search_option | 表示搜索选项的 FSDK.SearchOption 对象。 |
| [in] | di_path | 用户计算机上文件夹或搜索索引的设备独立路径。此参数是 可选的。当 search_scope 是 FSDK.ActionCallback.e_SearchScopeFolder 或 FSDK.ActionCallback.e_SearchScopeIndex 时,此参数是必需的。 |
| FSDK::ActionCallback::Release | ( | ) |
用于释放当前回调对象本身的回调函数。
| FSDK::ActionCallback::RemoveSearchIndex | ( | search_index_config | ) |
(保留,尚不支持) 移除搜索索引的回调函数。
该回调函数将由 JavaScript 方法 "search.removeIndex" 触发。此回调函数是可选的, 因此可以实现为不执行任何操作。
| [in] | search_index_config | 表示搜索索引配置的 FSDK.SearchIndexConfig。 |
| FSDK::ActionCallback::RemoveToolButtom | ( | button_name | ) |
用于删除由函数 FSDK.ActionCallback.AddToolButton 添加的工具按钮的回调函数。
此回调函数将由 javascript 方法"app.removeToolButton"触发。
| [in] | button_name | 工具按钮的名称。 |
| FSDK::ActionCallback::ResetModifyItem | ( | document | ) |
重置修改项的回调。
此回调函数是可选的,因此可以实现为不做任何事情。
| [in] | document | PDF文档对象,它应该有效。 |
| FSDK::ActionCallback::Response | ( | question | , |
| title | , | ||
| default_value | , | ||
| label | , | ||
| is_password | |||
| ) |
显示一个对话框的回调函数,该对话框包含一个问题和一个输入字段, 供用户回答问题。
此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| [in] | question | 指定要向用户提出的问题的字符串。 |
| [in] | title | 指定对话框标题的字符串。 |
| [in] | default_value | 指定默认值作为问题答案的字符串。 如果未指定答案,则不显示默认值。 |
| [in] | label | 指定显示在编辑文本字段前面的短字符串。 |
| [in] | is_password | 指示是否应屏蔽用户的响应的布尔值: true 表示用户的响应应显示为星号 (*) 或项目符号 (?) 以屏蔽响应,因为可能是敏感信息。 |
| FSDK::ActionCallback::Scroll | ( | point | ) |
将当前页面上的指定点滚动到当前视图中间的回调函数。
该回调函数将由 JavaScript 方法 "Doc.scroll" 触发。 此回调函数是可选的,因此可以实现为不执行任何操作并 只返回一个无用的值。
| [in] | point | 指定的点 [PDF 坐标系统]。 |
| FSDK::ActionCallback::SelectPageNthWord | ( | page_index | , |
| start_offset | , | ||
| end_offset | , | ||
| is_show_selection | |||
| ) |
更改当前页码并选择页面上指定单词的回调函数。
该回调函数将由 JavaScript 方法 "Doc.selectPageNthWord" 触发。 此回调函数是可选的,因此可以实现为不执行任何操作并 只返回一个无用的值。
| [in] | page_index | 页面索引。 |
| [in] | start_offset | 起始单词偏移量。 |
| [in] | end_offset | 结束单词偏移量。 |
| [in] | is_show_selection | true 表示显示选择,而 false 表示不显示。 |
| FSDK::ActionCallback::SetCurrentPage | ( | document | , |
| page_index | |||
| ) |
用于通过索引设置当前页面的回调函数。
此回调函数是可选的,因此可以实现为什么也不做。
| [in] | document | 一个 PDF 文档对象。它将是有效的。 |
| [in] | page_index | 用于更改当前页面的页面索引。 索引将从 0 开始,并小于指定文档的页面数。 |
| FSDK::ActionCallback::SetCurrentPage | ( | document | , |
| destination | |||
| ) |
用于通过目标设置当前页面的回调函数。
此回调函数是可选的,因此可以实现为什么也不做。
| [in] | document | 一个 PDF 文档对象。它将是有效的。 |
| [in] | destination | 一个 FSDK.object。 无。 |
| FSDK::ActionCallback::SetDefaultPageTransitionMode | ( | trans_type | , |
| trans_di | |||
| ) |
用于设置全屏模式的默认页面过渡模式的回调函数。
此回调函数将由 javascript 属性"app.fs.defaultTransition"触发。 此回调函数是可选的,因此可以实现为什么也不做。
| [in] | trans_type | 指定过渡效果类型的字符串。请参考以下值: "Split"、"Box"、"Fly"、"Blinds"、"Push"、"Wipe"、"Glitter"、"Cover"、"Uncover"、"Dissolve"、"Replace"、"Fade"。 |
| [in] | trans_di | 指定过渡效果方向的字符串。
|
| FSDK::ActionCallback::SetDocChangeMark | ( | document | , |
| change_mark | |||
| ) |
设置指示文档内容是否更改的更改标记的回调函数。
此回调函数是可选的,因此可以实现为什么也不做, 并仅返回一个无用的值。
| [in] | document | 一个 PDF 文档对象。它将是有效的。 |
| [in] | change_mark | 一个布尔值,指示文档内容是否更改。 |
| FSDK::ActionCallback::SetFullScreen | ( | is_full_screen | ) |
设置全屏模式的回调函数。
该回调函数将在要设置 JavaScript 属性 "app.fullScreen" 或 "app.fs.isFullScreen" 时触发。
| [in] | is_full_screen | true 表示设置全屏模式,而 false 表示不设置。 |
| FSDK::ActionCallback::SetIdentityProperties | ( | identity_properties | ) |
用于设置当前用户的身份属性的回调函数。
此回调函数是可选的,因此可以实现为什么也不做。
| [in] | identity_properties | 要设置的身份属性对象。 |
| FSDK::ActionCallback::SetLayoutMode | ( | layout_mode | , |
| is_cover_mode | |||
| ) |
设置当前文档的页面布局的回调函数。
该回调函数将由 JavaScript 属性 "Doc.layout" 触发。 此回调函数是可选的,因此可以实现为不执行任何操作并 只返回一个无用的值。
| [in] | layout_mode | 布局模式。请参考以 FSDK.ActionCallback.e_LayoutModeSinglePage 开头的值, 这应该是其中之一。 |
| [in] | is_cover_mode | true 表示封面将始终单独显示,而 false 表示不是。 |
| FSDK::ActionCallback::SetPageRotation | ( | document | , |
| page_index | , | ||
| rotation | |||
| ) |
用于在 PDF 查看器上设置页面的旋转值的回调函数。
此回调函数是可选的,因此可以实现为什么也不做。
| [in] | document | 一个 PDF 文档对象。它将是有效的。 |
| [in] | page_index | 页面索引,用于指定要更改哪个页面的旋转。 索引将从 0 开始,并小于指定文档的页面数。 |
| [in] | rotation | 新的旋转值。请参考从 FSDK.e_Rotation0 开始的值, 此值应为这些值之一,除了 FSDK.e_RotationUnknown。 |
| FSDK::ActionCallback::SetPageScale | ( | zoom_mode | , |
| dest | |||
| ) |
设置当前页面缩放值的回调函数。
该回调函数将由 JavaScript 属性 "Doc.zoom" 或 "Doc.zoomType" 触发。 此回调函数是可选的,因此可以实现为不执行任何操作并 只返回一个无用的值。
| [in] | zoom_mode | 缩放模式。请参考以 FSDK.Destination.e_ZoomXYZ 开头的值, 这应该是其中之一。 |
| [in] | dest | 表示目标数据的 FSDK.Destination 对象。 |
| FSDK::ActionCallback::ShowDialog | ( | dlg_config | ) |
显示对话框的回调函数。
该回调函数将由 JavaScript 方法 "app.execDialog" 触发。
| [in] | dlg_config | FSDK.DialogDescriptionConfig 对象。 |
| FSDK::ActionCallback::SoapRequest | ( | request_params | ) |
发起远程过程调用 (RPC) 或向 SOAP HTTP 端点发送 XML 消息。
该方法要么等待端点回复(同步处理),要么调用 通知对象上的方法(异步处理)。
此回调函数将由 javascript 方法"SOAP.request"触发。 此回调函数是可选的,因此可以实现为什么也不做。
| [in] | request_params | 包含 SOAP 请求的属性参数的 FSDK.SOAPRequestProperties 对象。 |
| FSDK::ActionCallback::UpdateLogicalLabel | ( | ) |
更新逻辑标签的回调函数。
该回调函数将由 JavaScript 方法 "Doc.setPageLabels" 触发。 此回调函数是可选的,因此可以实现为不执行任何操作并 只返回一个无用的值。
| FSDK::ActionCallback::VerifySignature | ( | document | , |
| pdf_signature | |||
| ) |
用于验证指定签名的回调函数。
当签名要通过操作进行验证时,将触发此回调函数。 如果用户不想验证签名,只需实现此函数什么也不做, 并只返回 FSDK.Signature.e_StateUnknown。 建议用户使用类 FSDK.LTVVerifier 来验证已签名的签名是否有效。
| [in] | document | 一个 PDF 文档对象。它应该是有效的。 |
| [in] | pdf_signature | 一个已签名的 PDF 签名。此签名属于输入参数 document。 |
|
static |
应用程序信息类型的枚举。
此枚举的值应单独使用。应用程序的表单版本信息。
|
static |
javascript 字段值更改类型的枚举。
此枚举的值应单独使用。javascript 字段值更改类型:格式化。
|
static |
邮件结果的枚举。
此枚举的值应单独使用。邮件结果:邮件失败。
|
static |
媒体播放器状态的枚举。
此枚举的值应单独使用。媒体播放器状态:打开。
|
static |
语言的枚举。
此枚举的值应单独使用。未知语言。
|
static |
布局模式的枚举。
此枚举的值应单独使用。布局模式:单页。
|
static |
要发送的数据类型的枚举。
此枚举的值应单独使用。邮件数据类型:文档。
|
static |
修改项类型的枚举。
此枚举的值应单独使用。修改项类型:无。
|
static |
搜索范围的枚举。
此枚举的值应单独使用。搜索范围:活动文档。