Foxit PDF SDK

构造函数 | 所有成员列表
<FSActionCallback>协议 参考

继承自 <NSObject> .

## 构造函数
(BOOL) | - addMenuItem:is_prepend:
| 将菜单项添加到菜单的回调函数。 更多...
(FSSearchIndexConfig *) | - addSearchIndex:selected:
| 添加搜索索引的回调函数。 更多...
(BOOL) | - addSubMenu:
| 将带有子菜单的菜单项添加到应用程序的回调函数。 更多...
(BOOL) | - addToolButton:
| 添加工具按钮的回调函数。 更多...
(int) | - alert:title:type:icon:
| 用于弹出对话框显示警告或提示的回调函数。 更多...
(BOOL) | - beep:
| 使系统播放声音的回调函数。 更多...
(NSString *) | - browseFile
| 显示文件选择对话框的回调函数，应返回选定的文件路径。 更多...
(NSString *) | - browseFile:file_format:file_filter:
| 显示文件选择对话框的回调函数。 更多...
(void) | - closeDoc:is_prompt_to_save:
| 关闭文档的回调函数。 更多...
(FSPDFDoc *) | - createBlankDoc
| 创建空白 PDF 文档对象的回调函数。 更多...
(void) | - enablePageLoop:
| 设置标志的回调函数，该标志指定在全屏模式下响应页面前进（无论是由鼠标点击、 键盘还是计时器生成）时文档是否循环到文档开头。 更多...
(BOOL) | - executeNamedAction:named_action:
| 执行命名操作的回调函数。 更多...
(NSString *) | - getAppInfo:
| 获取应用程序信息的回调函数。 更多...
(NSString *) | - getAttachmentsFilePath:name:
| 获取附件文件的文件路径的回调函数。 更多...
(FSPDFDoc *) | - getCurrentDoc
| 接收当前 PDF 文档对象的回调函数。 更多...
(int) | - getCurrentPage:
| 用于接收当前页面索引的回调函数。 更多...
(BOOL) | - getDocChangeMark:
| 接收更改标记的回调函数，该标记指示文档内容是否 已更改。 更多...
(NSString *) | - getExtractedEmbeddedFilePath:name:
| 获取提取的嵌入文件的文件路径的回调函数。 更多...
(NSString *) | - getFilePath:
| 获取当前 PDF 文档的文件路径的回调函数。 更多...
(BOOL) | - getFullScreen
| 获取是否设置全屏模式的回调函数。 更多...
(FSIdentityProperties *) | - getIdentityProperties
| 用于获取当前用户身份属性的回调函数。 更多...
(FSActionCallbackLanguage) | - getLanguage
| 获取正在运行的查看器应用程序语言的回调函数。 更多...
(FSActionCallbackLayoutMode) | - getLayoutMode
| 获取当前文档的页面布局的回调函数。 更多...
(FSMenuListArray *) | - getMenuItemNameList
| 获取菜单项名称列表的回调函数。 更多...
(FSPointF *) | - getMousePosition
| 获取当前鼠标位置的回调函数。 更多...
(FSPDFDoc *) | - getOpenedDoc:
| 通过索引接收已打开的 PDF 文档对象的回调函数。 更多...
(int) | - getOpenedDocCount
| 接收已打开文档数量的回调函数。 更多...
(FSRotation) | - getPageRotation:page_index:
| 用于接收 PDF 查看器上页面当前显示旋转角度的回调函数。 更多...
(float) | - getPageScale
| 获取当前页面缩放值的回调函数。 更多...
(FSRectF *) | - getPageWindowRect
| 获取页面视图窗口矩形的回调函数。页面视图窗口是 内部文档窗口内显示 PDF 内容的区域。 更多...
(FSDestinationZoomMode) | - getPageZoomMode
| 获取当前页面缩放模式的回调函数。 更多...
(NSArray< NSString * > *) | - getPrinterNameList
| 获取打印机名称列表的回调函数。 更多...
(NSArray< NSString * > *) | - getSignatureAPStyleNameList
| 获取签名外观样式的名称列表的回调函数。 更多...
(NSString *) | - getTemporaryDirectory
| 获取临时目录的回调函数。 更多...
(NSString *) | - getTemporaryFileName:file_name:
| 获取临时文件路径的回调函数。临时文件名将文档名与文件后缀名组合。 更多...
(NSString *) | - getUntitledBookmarkName
| 获取未命名书签的新名称的回调函数。 更多...
(BOOL) | - invalidateRect:page_index:pdf_rect:
| 使指定矩形内的客户端区域无效的回调函数。 更多...
(BOOL) | - isCurrentDocOpenedInBrowser
| 获取指定当前文档是否在浏览器中打开的标志的回调函数。 更多...
(BOOL) | - isLocalFile:
| 获取文件是否为本地文件的回调函数。 更多...
(BOOL) | - isPageLoop
| 获取指定响应页面前进时文档是否循环到文档开头的标志的回调函数。 更多...
(BOOL) | - launchURL:
| 启动到指定 URL 的回调函数。 更多...
(BOOL) | - mailData:data_type:is_ui:to:subject:cc:bcc:message:
| 使用或不使用用户交互来邮寄数据或消息的回调函数。 更多...
(FSActionCallbackJsMailResult) | - mailDoc:to_address:cc_address:bcc_address:subject:message:is_ui:
| 将文档作为附件邮寄的回调函数。 更多...
(void) | - notifyAfterDataChange:modify_item_info:
| 通知数据已被修改的回调函数。 更多...
(void) | - notifyBeginDoJob:event_type:
| 用于通知JavaScript执行开始的回调函数。 更多...
(void) | - notifyEndDoJob:event_type:
| 通知JavaScript执行已结束的回调函数。 更多...
(void) | - onFieldValueChanged:type:value_before_changed:value_after_changed:
| 通知字段值更改的回调函数。 更多...
(FSPDFDoc *) | - openDoc:password:
| 打开 PDF 文件的回调函数。 更多...
(id< FSMediaPlayerCallback >) | - openMediaPlayer:
| 打开媒体播放器的回调函数。 更多...
(NSString *) | - popupMenu:is_selected_item:
| 弹出菜单窗口的回调函数。 更多...
(FSMenuItemEx *) | - popupMenuEx:is_selected_item:
| 弹出菜单窗口的回调函数。 更多...
(void) | - postMessageToHtml:
| 异步向PDF文档的宿主容器的消息处理程序发送消息的回调函数。 更多...
(BOOL) | - print:is_ui:page_range:is_silent:is_shrunk_to_fit:is_printed_as_image:is_reversed:is_to_print_annots:
| 在指定索引范围内打印页面的回调函数。 更多...
(BOOL) | - print:print_params:
| 使用打印参数打印文档的回调函数。 更多...
(void) | - query:search_scope:search_option:di_path:
| 查询文本关键字的回调函数。 更多...
(bool) | - removeSearchIndex:
| （保留，尚不支持）删除搜索索引的回调函数。 更多...
(BOOL) | - removeToolButtom:
| 删除由函数 ActionCallback::AddToolButton 添加的工具按钮的回调函数。 更多...
(NSString *) | - response:title:default_value:label:is_password:
| 显示包含问题和输入字段的对话框供用户 回答问题的回调函数。 更多...
(void) | - scroll:
| 将当前页面上的指定点滚动到当前视图中间的回调函数。 更多...
(void) | - selectPageNthWord:start_offset:end_offset:is_show_selection:
| 更改当前页面号并选择页面上指定单词的回调函数。 更多...
(void) | - setCurrentPage:destination:
| 用于通过目的地设置当前页面的回调函数。 更多...
(void) | - setCurrentPage:page_index:
| 用于通过索引设置当前页面的回调函数。 更多...
(void) | - setDefaultPageTransitionMode:trans_di:
| 设置全屏模式的默认页面过渡模式的回调函数。 更多...
(BOOL) | - setDocChangeMark:change_mark:
| 设置标记更改标记的回调函数，该标记指示文档内容是否 已更改。 更多...
(void) | - setFullScreen:
| 设置全屏模式的回调函数。 更多...
(BOOL) | - setIdentityProperties:
| 用于设置当前用户身份属性的回调函数。 更多...
(void) | - setLayoutMode:is_cover_mode:
| 设置当前文档的页面布局的回调函数。 更多...
(BOOL) | - setPageRotation:page_index:rotation:
| 用于在 PDF 查看器上设置页面的旋转角度值的回调函数。 更多...
(void) | - setPageScale:dest:
| 设置当前页面缩放值的回调函数。 更多...
(BOOL) | - showDialog:
| 显示对话框的回调函数。 更多...
(FSSOAPResponseInfo *) | - soapRequest:
| 启动远程过程调用 (RPC) 或将 XML 消息发送到 SOAP HTTP 端点的回调函数。 更多...
(BOOL) | - submitForm:form_data:url:file_format_type:
| 将表单数据提交到指定 URL 的回调函数。 更多...
(void) | - updateLogicalLabel
| 更新逻辑标签的回调函数。 更多...
(unsigned int) | - verifySignature:pdf_signature:
| 验证指定签名的回调函数。 更多...

## 详细描述

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

## 函数文档

## ◆ addMenuItem:is_prepend:()

- (BOOL) addMenuItem: |  | (FSMenuItemConfig *) | menu_item_config
is_prepend: |  | (BOOL) | is_prepend
| required

将菜单项添加到菜单的回调函数。

此回调函数将由 JavaScript 方法 "app.addMenuItem" 触发。

参数

  [in] | menu_item_config | 菜单项的配置。
  [in] | is_prepend | 确定新菜单项相对于 MenuItemConfig::pos 或 MenuItemConfig::pos_str 指定位置的位置。 默认值为 false。如果此参数为 true，插入规则如下： 如果使用 MenuItemConfig::pos_str，新项将放置在命名项之前。 如果使用 MenuItemConfig::pos，新项将放置在编号项之前。 如果找不到命名项或位置不在零和列表中项目数之间（包括）， 新项将作为菜单中的第一项插入（而不是菜单末尾）。

返回
  true 表示成功，而 false 表示失败。

## ◆ addSearchIndex:selected:()

- (FSSearchIndexConfig*) addSearchIndex: |  | (NSString *) | di_path
selected: |  | (bool) | is_selected
| required

添加搜索索引的回调函数。

此回调函数将由 JavaScript 方法 "search.addIndex" 触发。此回调函数是可选的， 因此可以实现为什么都不做。

参数

  [in] | di_path | 用户硬盘驱动器上索引文件的设备无关路径。
  [in] | is_selected | 指定是否应选择索引进行搜索。默认值：true。

返回
  一个 FSSearchIndexConfig。

## ◆ addSubMenu:()

- (BOOL) addSubMenu: |  | (FSMenuItemConfig *) | menu_item_config |
| required

将带有子菜单的菜单项添加到应用程序的回调函数。

此回调函数将由 JavaScript 方法 "app.addSubMenu" 触发。

参数

  [in] | menu_item_config | 菜单项的配置。

返回
  true 表示成功，而 false 表示失败。

## ◆ addToolButton:()

- (BOOL) addToolButton: |  | (FSButtonItem *) | button_item |
| required

添加工具按钮的回调函数。

此回调函数将由 JavaScript 方法 "app.addToolButton" 触发。

参数

  [in] | button_item | 工具按钮的 ButtonItem 对象。

返回
  true 表示成功，而 false 表示失败。

## ◆ alert:title:type:icon:()

- (int) alert: |  | (NSString *) | msg
title: |  | (NSString *) | title
type: |  | (int) | type
icon: |  | (int) | icon
| required

用于弹出对话框显示警告或提示的回调函数。

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

参数

  [in] | msg | 要在对话框中显示的消息字符串。
  [in] | title | 对话框的标题。
  [in] | type | 按钮组类型。将是以下值之一： 0: OK（默认值） 1: OK、Cancel 2: Yes、NO 3: Yes、NO、Cancel
  [in] | icon | 图标类型。将是以下值之一： 0: Error（默认值） 1: Warning 2: Question 3: Status

返回
  返回值应是以下值之一：
  - 1: OK
  - 2: Cancel
  - 3: NO
  - 4: Yes

## ◆ beep:()

- (BOOL) beep: |  | (int) | type |
| required

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

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

参数

  [in] | type | 声音类型。该值将是以下值之一： 0: 错误 1: 警告 2: 问题 3: 状态 4: 默认（默认值）

返回
  YES 表示成功，而 NO 表示失败。

## ◆ browseFile()

- (NSString*) browseFile |  |  |
| required

显示文件选择对话框的回调函数，应返回选定的文件路径。

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

返回
  文件路径。可以是空字符串。

## ◆ browseFile:file_format:file_filter:()

- (NSString*) browseFile: |  | (BOOL) | is_open_dialog
file_format: |  | (NSString *) | file_format
file_filter: |  | (NSString *) | file_filter
| required

显示文件选择对话框的回调函数。

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

参数

  [in] | is_open_dialog | 是打开还是保存对话框，true 表示打开对话框，false 表示保存对话框。
  [in] | file_format | 文件格式字符串。
  [in] | file_filter | 文件过滤器字符串。

返回
  文件路径。可以是空字符串。

## ◆ closeDoc:is_prompt_to_save:()

- (void) closeDoc: |  | (FSPDFDoc *) | document
is_prompt_to_save: |  | (BOOL) | is_prompt_to_save
| required

关闭文档的回调函数。

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

参数

  [in] | document | PDF 文档对象。它将是有效的。
  [in] | is_prompt_to_save | true 表示显示保存提示，而 false 表示不显示。

返回
  无。

## ◆ createBlankDoc()

- (FSPDFDoc*) createBlankDoc |  |  |
| required

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

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

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

## ◆ enablePageLoop:()

- (void) enablePageLoop: |  | (BOOL) | is_loop |
| required

设置标志的回调函数，该标志指定在全屏模式下响应页面前进（无论是由鼠标点击、 键盘还是计时器生成）时文档是否循环到文档开头。

此回调函数将由 JavaScript 属性 "app.fs.loop" 触发。 此回调函数是可选的，因此可以实现为什么都不做。

参数

  [in] | is_loop | true 表示循环到文档开头，而 false 表示不循环。

返回
  无。

## ◆ executeNamedAction:named_action:()

- (BOOL) executeNamedAction: |  | (FSPDFDoc *) | document
named_action: |  | (NSString *) | named_action
| required

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

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

参数

  [in] | document | PDF 文档对象。它将是有效的。
  [in] | named_action | 指定命名操作的字符串。

返回
  YES 表示成功，而 NO 表示失败。

## ◆ getAppInfo:()

- (NSString*) getAppInfo: |  | (FSActionCallbackAppInfoType) | type |
| required

获取应用程序信息的回调函数。

此回调函数是可选的，因此可以实现为什么都不做，并 只返回一个无用的值。
对于数字信息，如 FSActionCallbackAppInfoTypeViewerVersion、 FSActionCallbackAppInfoTypeAppVersion 和 FSActionCallbackAppInfoTypeFormsVersion， 请使用字符串来表示它。

参数

  [in] | type | 信息类型。请参阅从 FSActionCallbackAppInfoTypeFormsVersion 开始的值，并且将是这些宏之一。

返回
  应用程序信息。

## ◆ getAttachmentsFilePath:name:()

- (NSString*) getAttachmentsFilePath: |  | (FSPDFDoc *) | pdf_doc
name: |  | (NSString *) | name
| required

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

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

参数

  [in] | pdf_doc | PDF 文档对象。它将嵌入数据对象。
  [in] | name | 与数据对象关联的名称。这是方法 "Doc.importDataObject" 的参数 "cName"。

返回
  将作为数据对象嵌入的文件的路径。

## ◆ getCurrentDoc()

- (FSPDFDoc*) getCurrentDoc |  |  |
| required

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

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

返回
  当前的 PDF 文档对象。

## ◆ getCurrentPage:()

- (int) getCurrentPage: |  | (FSPDFDoc *) | document |
| required

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

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

参数

  [in] | document | PDF 文档对象。它将是有效的。

返回
  当前页面索引。该值应从 0 开始且小于指定文档的页数。

## ◆ getDocChangeMark:()

- (BOOL) getDocChangeMark: |  | (FSPDFDoc *) | document |
| required

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

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

参数

  [in] | document | PDF 文档对象。它将是有效的。

返回
  YES 表示 PDF 文档已更改，而 NO 表示未更改。

## ◆ getExtractedEmbeddedFilePath:name:()

- (NSString*) getExtractedEmbeddedFilePath: |  | (FSPDFDoc *) | pdf_doc
name: |  | (NSString *) | name
| required

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

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

参数

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

返回
  将嵌入数据对象的文件的路径。

## ◆ getFilePath:()

- (NSString*) getFilePath: |  | (FSPDFDoc *) | document |
| required

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

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

参数

  [in] | document | PDF 文档对象。它将是有效的。

返回
  文件路径。

## ◆ getFullScreen()

- (BOOL) getFullScreen |  |  |
| required

获取是否设置全屏模式的回调函数。

此回调函数将由 JavaScript 属性 "app.fullScreen" 或 "app.fs.isFullScreen" 触发。

返回
  true 表示设置了全屏模式，而 false 表示未设置。

## ◆ getIdentityProperties()

- (FSIdentityProperties*) getIdentityProperties |  |  |
| required

用于获取当前用户身份属性的回调函数。

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

返回
  指定当前用户身份属性的 IdentityProperties 对象。

## ◆ getLanguage()

- (FSActionCallbackLanguage) getLanguage |  |  |
| required

获取正在运行的查看器应用程序语言的回调函数。

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

返回
  语言类型。请参阅从 FSActionCallbackLanguageUnknown 开始的值， 并且应是其中一个值。

## ◆ getLayoutMode()

- (FSActionCallbackLayoutMode) getLayoutMode |  |  |
| required

获取当前文档的页面布局的回调函数。

此回调函数将由 JavaScript 属性 "Doc.layout" 触发。 此回调函数是可选的，因此可以实现为什么都不做，并 只返回一个无用的值。

返回
  布局模式。请参阅从 FSActionCallbackLayoutModeSinglePage 开始的值， 并且应是其中一个值。

## ◆ getMenuItemNameList()

- (FSMenuListArray*) getMenuItemNameList |  |  |
| required

获取菜单项名称列表的回调函数。

此回调函数将由 JavaScript 方法 "app.listMenuItems" 触发。

返回
  菜单列表对象数组。

## ◆ getMousePosition()

- (FSPointF*) getMousePosition |  |  |
| required

获取当前鼠标位置的回调函数。

此回调函数将由 JavaScript 属性 "doc.mouseX" 或 "doc.mouseY" 触发。 此回调函数是可选的，因此可以实现为什么都不做，并 只返回一个无用的值。

返回
  设备坐标系统中的位置。

## ◆ getOpenedDoc:()

- (FSPDFDoc*) getOpenedDoc: |  | (int) | index |
| required

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

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

参数

  [in] | index | 已打开 PDF 文档的索引。有效范围：从 0 到 count-1。 count 由回调函数 FSActionCallback::getOpenedDocCount 返回

返回
  已打开的 PDF 文档对象。

## ◆ getOpenedDocCount()

- (int) getOpenedDocCount |  |  |
| required

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

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

返回
  已打开文档的数量。

## ◆ getPageRotation:page_index:()

- (FSRotation) getPageRotation: |  | (FSPDFDoc *) | document
page_index: |  | (int) | page_index
| required

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

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

参数

  [in] | document | PDF 文档对象。它将是有效的。
  [in] | page_index | 页面索引，用于指定要检索哪个页面的旋转角度。 索引将从 0 开始且小于指定文档的页数。

返回
  指定页面的旋转角度。请参阅从 FSRotation0 开始的值， 并且应该是其中一个值。

## ◆ getPageScale()

- (float) getPageScale |  |  |
| required

获取当前页面缩放值的回调函数。

此回调函数将由 JavaScript 属性 "Doc.zoom" 触发。 此回调函数是可选的，因此可以实现为什么都不做，并 只返回一个无用的值。

返回
  缩放值。例如，缩放值 1.0 表示 100。它应是一个正数。

## ◆ getPageWindowRect()

- (FSRectF*) getPageWindowRect |  |  |
| required

获取页面视图窗口矩形的回调函数。页面视图窗口是 内部文档窗口内显示 PDF 内容的区域。

此回调函数将由 JavaScript 属性 "Doc.pageWindowRect" 触发。 此回调函数是可选的，因此可以实现为什么都不做，并 只返回一个无用的值。

返回
  页面视图窗口的矩形。

## ◆ getPageZoomMode()

- (FSDestinationZoomMode) getPageZoomMode |  |  |
| required

获取当前页面缩放模式的回调函数。

此回调函数将由 JavaScript 属性 "Doc.zoom" 或 "Doc.zoomType" 触发。 此回调函数是可选的，因此可以实现为什么都不做，并 只返回一个无用的值。

返回
  缩放模式。请参阅从 FSDestinationZoomXYZ 开始的值， 并且应是其中一个值。

## ◆ getPrinterNameList()

- (NSArray<NSString*>*) getPrinterNameList |  |  |
| required

获取打印机名称列表的回调函数。

此回调函数将由 JavaScript 属性 "app.printerNames" 触发。 此回调函数是可选的，因此可以实现为什么都不做，并 只返回一个无用的值。

返回
  打印机名称数组。

## ◆ getSignatureAPStyleNameList()

- (NSArray<NSString*>*) getSignatureAPStyleNameList |  |  |
| required

获取签名外观样式的名称列表的回调函数。

此回调函数将由 JavaScript 方法 "SecurityHandler.appearances" 触发。 此回调函数是可选的，因此可以实现为什么都不做。

返回
  签名外观样式名称数组。

## ◆ getTemporaryDirectory()

- (NSString*) getTemporaryDirectory |  |  |
| required

获取临时目录的回调函数。

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

返回
  临时目录。

## ◆ getTemporaryFileName:file_name:()

- (NSString*) getTemporaryFileName: |  | (FSPDFDoc *) | document
file_name: |  | (NSString *) | file_name
| required

获取临时文件路径的回调函数。临时文件名将文档名与文件后缀名组合。

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

参数

  [in] | document | PDF 文档对象。它将是有效的。
  [in] | file_name | 文件后缀名。

返回
  临时文件路径。

## ◆ getUntitledBookmarkName()

- (NSString*) getUntitledBookmarkName |  |  |
| required

获取未命名书签的新名称的回调函数。

当方法的参数 "cName" 为空字符串时，此回调函数将由 JavaScript 方法 "bookmark.createChild" 触发。 此回调函数是可选的，因此可以实现为什么都不做，并 只返回一个无用的值。

返回
  未命名书签的新名称。

## ◆ invalidateRect:page_index:pdf_rect:()

- (BOOL) invalidateRect: |  | (FSPDFDoc *) | document
page_index: |  | (int) | page_index
pdf_rect: |  | (FSRectF *) | pdf_rect
| required

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

所有位置都在 PDF "用户空间"中测量。实现应调用函数 FSRenderer::startRender:matrix:pause: 来重新绘制指定的页面区域。

参数

  [in] | document | PDF 文档对象。它将是有效的。
  [in] | page_index | 页面索引。它将从 0 开始且小于指定文档的页数。
  [in] | pdf_rect | 在 PDF 坐标系统 中指定页面区域的矩形。

返回
  YES 表示成功，而 NO 表示失败。

## ◆ isCurrentDocOpenedInBrowser()

- (BOOL) isCurrentDocOpenedInBrowser |  |  |
| required

获取指定当前文档是否在浏览器中打开的标志的回调函数。

此回调函数将由 JavaScript 属性 "doc.hostContainer" 触发。 此回调函数是可选的，因此可以实现为什么都不做。

返回
  true 表示当前文档在浏览器中打开，而 false 表示不是。

## ◆ isLocalFile:()

- (BOOL) isLocalFile: |  | (FSPDFDoc *) | document |
| required

获取文件是否为本地文件的回调函数。

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

参数

  [in] | document | PDF 文档对象。它将是有效的。

返回
  true 表示 PDF 文件是本地文件。

## ◆ isPageLoop()

- (BOOL) isPageLoop |  |  |
| required

获取指定响应页面前进时文档是否循环到文档开头的标志的回调函数。

此回调函数将由 JavaScript 属性 "app.fs.loop" 触发。 此回调函数是可选的，因此可以实现为什么都不做。

返回
  true 表示循环到文档开头，而 false 表示不循环。

## ◆ launchURL:()

- (BOOL) launchURL: |  | (NSString *) | url |
| required

启动到指定 URL 的回调函数。

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

参数

  [in] | url | 一个 URL。

返回
  YES 表示成功，而 NO 表示失败。

## ◆ mailData:data_type:is_ui:to:subject:cc:bcc:message:()

- (BOOL) mailData: |  | (void *) | data
data_type: |  | (FSActionCallbackMailType) | data_type
is_ui: |  | (BOOL) | is_ui
to: |  | (NSString *) | to
subject: |  | (NSString *) | subject
cc: |  | (NSString *) | cc
bcc: |  | (NSString *) | bcc
message: |  | (NSString *) | message
| required

使用或不使用用户交互来邮寄数据或消息的回调函数。

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

参数

  [in] | data | 指向要邮寄的数据的指针。 数据的值和类型取决于参数 data_type： 当参数 data_type 为 FSActionCallbackMailTypeMsg 时为 nil。 当参数 data_type 为 FSActionCallbackMailTypeForm 时为字符串指针。 当参数 data_type 为 FSActionCallbackMailTypeDoc 时为 FSPDFDoc 对象指针。
  [in] | data_type | 邮件类型。请参阅从 FSActionCallbackMailTypeDoc 开始的值， 并且将是其中一个值。
  [in] | is_ui | YES 表示剩余参数用于 填充显示给用户的撰写新消息窗口。 NO 表示参数 to 是必需的，所有其他参数 都是可选的。
  [in] | to | 指定消息收件人的分号分隔列表的字符串。
  [in] | subject | 指定消息主题的字符串。 此字符串的长度限制为 64 KB。
  [in] | cc | 指定消息抄送收件人的分号分隔列表的字符串。
  [in] | bcc | 指定消息密送收件人的分号分隔列表的字符串。
  [in] | message | 指定消息内容的字符串。 此字符串的长度限制为 64 KB。

返回
  YES 表示成功，而 NO 表示失败。

## ◆ mailDoc:to_address:cc_address:bcc_address:subject:message:is_ui:()

- (FSActionCallbackJsMailResult) mailDoc: |  | (FSPDFDoc *) | document
to_address: |  | (NSString *) | to_address
cc_address: |  | (NSString *) | cc_address
bcc_address: |  | (NSString *) | bcc_address
subject: |  | (NSString *) | subject
message: |  | (NSString *) | message
is_ui: |  | (BOOL) | is_ui
| required

将文档作为附件邮寄的回调函数。

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

参数

  [in] | document | PDF 文档对象。它将是有效的。
  [in] | to_address | 收件人地址。
  [in] | cc_address | 抄送地址。
  [in] | bcc_address | 密送地址。
  [in] | subject | 邮件主题。
  [in] | message | 邮件消息。
  [in] | is_ui | true 表示显示邮件对话框，而 false 表示不显示。

返回
  邮件结果。请参阅从 FSActionCallbackJSMailResultFailed 开始的值， 并且应是其中一个值。

## ◆ notifyAfterDataChange:modify_item_info:()

- (void) notifyAfterDataChange: |  | (FSPDFDoc *) | document
modify_item_info: |  | (FSJavascriptModifyItemInfo *) | modify_item_info
| required

通知数据已被修改的回调函数。

此回调函数是可选的，如果不需要任何操作，可以实现为什么都不做。

参数

  [in] | document | 一个PDF文档对象。它将是有效的。
  [in] | modify_item_info | 一个JavascriptModifyItemInfo对象，包含有关修改的详细信息。

返回
  无。

## ◆ notifyBeginDoJob:event_type:()

- (void) notifyBeginDoJob: |  | (FSPDFDoc *) | document
event_type: |  | (FSJavascriptModifyItemInfoJavascriptEventType) | event_type
| required

用于通知JavaScript执行开始的回调函数。

此回调函数是可选的，如果不需要任何操作，可以实现为什么都不做。

参数

  [in] | document | 一个PDF文档对象。它将是有效的。
  [in] | event_type | JavaScript事件类型。请参阅从JavascriptModifyItemInfo::e_JavascriptEventTypeUnknown开始的值， 并且应该是这些值之一。

返回
  无。

## ◆ notifyEndDoJob:event_type:()

- (void) notifyEndDoJob: |  | (FSPDFDoc *) | document
event_type: |  | (FSJavascriptModifyItemInfoJavascriptEventType) | event_type
| required

通知JavaScript执行已结束的回调函数。

此回调函数是可选的，如果不需要任何操作，可以实现为什么都不做。

参数

  [in] | document | 一个PDF文档对象。它将是有效的。
  [in] | event_type | JavaScript事件类型。请参阅从JavascriptModifyItemInfo::e_JavascriptEventTypeUnknown开始的值， 并且应该是这些值之一。

返回
  无。

## ◆ onFieldValueChanged:type:value_before_changed:value_after_changed:()

- (void) onFieldValueChanged: |  | (NSString *) | field_name
type: |  | (FSActionCallbackJSFieldValueChangeType) | type
value_before_changed: |  | (NSArray< NSString * > *) | value_before_changed
value_after_changed: |  | (NSArray< NSString * > *) | value_after_changed
| required

通知字段值更改的回调函数。

当字段的值通过 JavaScript 更改时，将触发此回调函数。

参数

  [in] | field_name | 指定字段名称的字符串。
  [in] | type | 字段值更改类型。请参阅从 FSActionCallbackJSFieldValueChangedByFormat 开始的值， 并且将是其中一个值。
  [in] | value_before_changed | 指定更改前字段值的字符串数组。 对于列表框，此参数表示同时被选中的一个或多个字段项。
  [in] | value_after_changed | 指定更改后字段值的字符串数组。 对于列表框，此参数表示同时被选中的一个或多个字段项。

返回
  无。

## ◆ openDoc:password:()

- (FSPDFDoc*) openDoc: |  | (NSString *) | file_path
password: |  | (NSString *) | password
| required

打开 PDF 文件的回调函数。

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

参数

  [in] | file_path | 现有 PDF 文件的完整路径。
  [in] | password | PDF 文件的密码。可以是空字符串。

返回
  已打开的 PDF 文档对象。

## ◆ openMediaPlayer:()

- (id<FSMediaPlayerCallback>) openMediaPlayer: |  | (FSPlayerArgs *) | player_args |
| required

打开媒体播放器的回调函数。

此回调函数将由 JavaScript 方法 "app.media.openPlayer" 或 "app.media.createPlayer" 触发。

参数

  [in] | player_args | FSPlayerArgs 对象。

返回
  一个 FSMediaPlayerCallback 对象。

## ◆ popupMenu:is_selected_item:()

- (NSString*) popupMenu: |  | (FSMenuListArray *) | menus
is_selected_item: |  | (NSNumber **) | is_selected_item
| required

弹出菜单窗口的回调函数。

菜单窗口的位置与光标相同。 此回调函数是可选的，因此可以实现为什么都不做，并 只返回一个无用的值。

参数

  [in] | menus | 菜单列表对象数组。
  [out] | is_selected_item | 接收是否选择此菜单项的值的输出参数。 true 表示选择了菜单项，而 false 表示未选择菜单项。

返回
  被选择的菜单项的名称。

## ◆ popupMenuEx:is_selected_item:()

- (FSMenuItemEx*) popupMenuEx: |  | (FSMenuItemExArray *) | menus
is_selected_item: |  | (NSNumber **) | is_selected_item
| required

弹出菜单窗口的回调函数。

菜单窗口的位置与光标相同。 此回调函数是可选的，因此可以实现为什么都不做，并 只返回一个无用的值。

参数

  [in] | menus | FSMenuItemEx 对象数组。
  [out] | is_selected_item | 接收是否选择菜单项的值的输出参数。 true 表示选择了菜单项，而 false 表示未选择菜单项。

返回
  被选择的菜单项的 MenuItemEx 对象。

## ◆ postMessageToHtml:()

- (void) postMessageToHtml: |  | (NSArray< NSString * > *) | message |
| required

异步向PDF文档的宿主容器的消息处理程序发送消息的回调函数。

为了传递此消息，宿主容器（例如，HTML页面中的<OBJECT>元素）必须通过设置其 messageHandler属性来注册接收通知。
此回调函数将由JavaScript方法"doc.hostContainer.postMessage"触发。 此回调函数是可选的，因此可以实现为什么都不做。

参数

  [in] | message | 指定要发送的消息的字符串数组。

返回
  无。

## ◆ print:is_ui:page_range:is_silent:is_shrunk_to_fit:is_printed_as_image:is_reversed:is_to_print_annots:()

- (BOOL) print: |  | (FSPDFDoc *) | document
is_ui: |  | (BOOL) | is_ui
page_range: |  | (FSRange *) | page_range
is_silent: |  | (BOOL) | is_silent
is_shrunk_to_fit: |  | (BOOL) | is_shrunk_to_fit
is_printed_as_image: |  | (BOOL) | is_printed_as_image
is_reversed: |  | (BOOL) | is_reversed
is_to_print_annots: |  | (BOOL) | is_to_print_annots
| required

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

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

参数

  [in] | document | PDF 文档对象。它将是有效的。
  [in] | is_ui | YES 表示应向用户显示 UI 以获取打印信息并确认操作。
  [in] | page_range | 用于指定打印页面范围的范围对象。 此范围中表示的所有索引将从 0 开始，并 小于指定文档的页数。
  [in] | is_silent | YES 表示在打印文档时应隐藏 取消对话框。
  [in] | is_shrunk_to_fit | YES 表示页面应（如有必要）缩小 以适合打印页面的区域。
  [in] | is_printed_as_image | YES 表示页面应作为图像打印。
  [in] | is_reversed | YES 表示打印顺序应从参数 end 到 参数 start。
  [in] | is_to_print_annots | YES 表示应与页面一起打印注释。

返回
  YES 表示成功，而 NO 表示失败。

## ◆ print:print_params:()

- (BOOL) print: |  | (FSPDFDoc *) | document
print_params: |  | (FSPrintParams *) | print_params
| required

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

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

参数

  [in] | document | PDF 文档对象。它将是有效的。
  [in] | print_params | 一个 FSPrintParams 对象。

返回
  true 表示成功，而 false 表示失败。

## ◆ query:search_scope:search_option:di_path:()

- (void) query: |  | (NSString *) | keywords
search_scope: |  | (FSActionCallbackSearchScope) | search_scope
search_option: |  | (FSSearchOption *) | search_opion
di_path: |  | (NSString *) | di_path
| required

查询文本关键字的回调函数。

此回调函数将由 JavaScript 方法 "search.query" 触发。此回调函数是可选的， 因此可以实现为什么都不做。

参数

  [in] | keywords | 要搜索的文本内容。
  [in] | search_scope | 指定应在何处搜索文本。请参阅从 FSActionCallbackSearchScopeActiveDoc 开始的值，并且应是其中一个值。
  [in] | search_option | 表示搜索选项的 FSSearchOption 对象。
  [in] | di_path | 用户计算机上文件夹或搜索索引的设备无关路径。此参数是 可选的。当 search_scope 为 FSActionCallbackSearchScopeFolder 或 FSActionCallbackSearchScopeIndex 时，此参数是必需的。

返回
  无。

## ◆ removeSearchIndex:()

- (bool) removeSearchIndex: |  | (FSSearchIndexConfig *) | search_index_config |
| required

（保留，尚不支持）删除搜索索引的回调函数。

此回调函数将由 JavaScript 方法 "search.removeIndex" 触发。此回调函数是可选的， 因此可以实现为什么都不做。

参数

  [in] | search_index_config | 表示搜索索引配置的 FSSearchIndexConfig。

返回
  true 表示成功，而 false 表示失败。

## ◆ removeToolButtom:()

- (BOOL) removeToolButtom: |  | (NSString *) | button_name |
| required

删除由函数 ActionCallback::AddToolButton 添加的工具按钮的回调函数。

此回调函数将由 JavaScript 方法 "app.removeToolButton" 触发。

参数

  [in] | button_name | 工具按钮的名称。

返回
  true 表示成功，而 false 表示失败。

## ◆ response:title:default_value:label:is_password:()

- (NSString*) response: |  | (NSString *) | question
title: |  | (NSString *) | title
default_value: |  | (NSString *) | default_value
label: |  | (NSString *) | label
is_password: |  | (BOOL) | is_password
| required

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

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

参数

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

返回
  用户的响应。可以是空字符串。

## ◆ scroll:()

- (void) scroll: |  | (FSPointF *) | point |
| required

将当前页面上的指定点滚动到当前视图中间的回调函数。

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

参数

  [in] | point | 指定的点[PDF 坐标系统]。

返回
  无。

## ◆ selectPageNthWord:start_offset:end_offset:is_show_selection:()

- (void) selectPageNthWord: |  | (int) | page_index
start_offset: |  | (int) | start_offset
end_offset: |  | (int) | end_offset
is_show_selection: |  | (BOOL) | is_show_selection
| required

更改当前页面号并选择页面上指定单词的回调函数。

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

参数

  page_index | 页面索引。
  start_offset | 开始单词偏移量。
  end_offset | 结束单词偏移量。
  is_show_selection | true 表示显示选择，而 false 表示不显示。

返回
  无。

## ◆ setCurrentPage:destination:()

- (void) setCurrentPage: |  | (FSPDFDoc *) | document
destination: |  | (FSDestination *) | destination
| required

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

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

参数

  [in] | document | PDF 文档对象。它将是有效的。
  [in] | destination | 一个 对象。 无。

## ◆ setCurrentPage:page_index:()

- (void) setCurrentPage: |  | (FSPDFDoc *) | document
page_index: |  | (int) | page_index
| required

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

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

参数

  [in] | document | PDF 文档对象。它将是有效的。
  [in] | page_index | 用于更改当前页面的页面索引。 索引将从 0 开始且小于指定文档的页数。

返回
  无。

## ◆ setDefaultPageTransitionMode:trans_di:()

- (void) setDefaultPageTransitionMode: |  | (NSString *) | trans_type
trans_di: |  | (NSString *) | trans_di
| required

设置全屏模式的默认页面过渡模式的回调函数。

此回调函数将由 JavaScript 属性 "app.fs.defaultTransition" 触发。 此回调函数是可选的，因此可以实现为什么都不做。

参数

  [in] | trans_type | 指定过渡效果类型的字符串。请参阅以下值： "Split"、"Box"、"Fly"、"Blinds"、"Push"、"Wipe"、"Glitter"、"Cover"、"Uncover"、"Dissolve"、"Replace"、"Fade"。
  [in] | trans_di | 指定过渡效果方向的字符串。 对于 "Split"，此值可以是 "HorizontalInward"、"HorizontalOutward"、"VerticalInward" 或 "VerticalOutward"。 对于 "Box"，此值可以是 "Outward" 或 "Inward"。 对于 "Fly" 和 "Push"，此值可以是 "Left"、"Right"、"Up" 或 "Down"。 对于 "Blinds"，此值可以是 "Horizontal" 或 "Vertical"。 对于 "Wipe"、"Glitter"、"Uncover" 和 "Cover"，此值可以是 "Left"、"LeftUp"、"LeftDown"、"Right"、"RightUp"、"RightDown"、"Up" 或 "Down"。 对于 "Dissolve"、"Replace" 和 "Fade"，此值将为 NULL。

返回
  无。

## ◆ setDocChangeMark:change_mark:()

- (BOOL) setDocChangeMark: |  | (FSPDFDoc *) | document
change_mark: |  | (BOOL) | change_mark
| required

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

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

参数

  [in] | document | PDF 文档对象。它将是有效的。
  [in] | change_mark | 一个布尔值，指示文档内容是否已更改。

返回
  YES 表示成功，而 NO 表示失败。

## ◆ setFullScreen:()

- (void) setFullScreen: |  | (BOOL) | is_full_screen |
| required

设置全屏模式的回调函数。

当要设置 JavaScript 属性 "app.fullScreen" 或 "app.fs.isFullScreen" 时，将触发此回调函数。

参数

  [in] | is_full_screen | true 表示设置全屏模式，而 false 表示不设置。

返回
  无。

## ◆ setIdentityProperties:()

- (BOOL) setIdentityProperties: |  | (FSIdentityProperties *) | identity_properties |
| required

用于设置当前用户身份属性的回调函数。

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

返回
  YES 表示成功，而 NO 表示失败。

## ◆ setLayoutMode:is_cover_mode:()

- (void) setLayoutMode: |  | (FSActionCallbackLayoutMode) | layout_mode
is_cover_mode: |  | (BOOL) | is_cover_mode
| required

设置当前文档的页面布局的回调函数。

此回调函数将由 JavaScript 属性 "Doc.layout" 触发。 此回调函数是可选的，因此可以实现为什么都不做，并 只返回一个无用的值。

参数

  [in] | layout_mode | 布局模式。请参阅从 FSActionCallbackLayoutModeSinglePage 开始的值， 并且应是其中一个值。
  [in] | is_cover_mode | true 表示封面将始终单独显示，而 false 表示不是。

返回
  无。

## ◆ setPageRotation:page_index:rotation:()

- (BOOL) setPageRotation: |  | (FSPDFDoc *) | document
page_index: |  | (int) | page_index
rotation: |  | (FSRotation) | rotation
| required

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

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

参数

  [in] | document | PDF 文档对象。它将是有效的。
  [in] | page_index | 页面索引，用于指定要更改哪个页面的旋转角度。 索引将从 0 开始且小于指定文档的页数。
  [in] | rotation | 新的旋转角度值。请参阅从 FSRotation0 开始的值， 并且应该是其中一个值，但不包括 FSRotationUnknown。

返回
  YES 表示成功，而 NO 表示失败。

## ◆ setPageScale:dest:()

- (void) setPageScale: |  | (FSDestinationZoomMode) | zoom_mode
dest: |  | (FSDestination *) | dest
| required

设置当前页面缩放值的回调函数。

此回调函数将由 JavaScript 属性 "Doc.zoom" 或 "Doc.zoomType" 触发。 此回调函数是可选的，因此可以实现为什么都不做，并 只返回一个无用的值。

参数

  zoom_mode | 缩放模式。请参阅从 FSDestinationZoomXYZ 开始的值， 并且应是其中一个值。
  dest | 表示目标数据的 pdf::Destination 对象。

返回
  无。

## ◆ showDialog:()

- (BOOL) showDialog: |  | (FSDialogDescriptionConfig *) | dlg_config |
| required

显示对话框的回调函数。

此回调函数将由 JavaScript 方法 "app.execDialog" 触发。

参数

  [in] | dlg_config | DialogDescriptionConfig 对象。

返回
  true 表示成功，而 false 表示失败。

## ◆ soapRequest:()

- (FSSOAPResponseInfo*) soapRequest: |  | (FSSOAPRequestProperties *) | request_params |
| required

启动远程过程调用 (RPC) 或将 XML 消息发送到 SOAP HTTP 端点的回调函数。

该方法可以等待端点回复（同步处理）或调用通知对象上的方法 （异步处理）。

参数

  [in] | request_params | 表示包含 SOAP 请求属性参数的 FSSOAPRequestProperties 对象的 FSSOAPRequestProperties。

返回
  一个 FSSOAPResponseInfo 对象。

## ◆ submitForm:form_data:url:file_format_type:()

- (BOOL) submitForm: |  | (FSPDFDoc *) | document
form_data: |  | (NSData *) | form_data
url: |  | (NSString *) | url
file_format_type: |  | (FSFileFormatType) | file_format_type
| required

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

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

参数

  [in] | document | PDF 文档对象。它将是有效的。
  [in] | form_data | 指向要提交的表单数据缓冲区的指针。
  [in] | url | 表单数据将提交到的 URL。
  [in] | file_format_type | 提交表单的文件格式类型。请参阅从 foxit::common::e_FileFormatTypeFDF 开始的值， 并且将是其中一个值。

返回
  YES 表示成功，而 NO 表示失败。

## ◆ updateLogicalLabel()

- (void) updateLogicalLabel |  |  |
| required

更新逻辑标签的回调函数。

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

返回
  无。

## ◆ verifySignature:pdf_signature:()

- (unsigned int) verifySignature: |  | (FSPDFDoc *) | document
pdf_signature: |  | (FSSignature *) | pdf_signature
| required

验证指定签名的回调函数。

当操作要验证签名时，将触发此回调函数。 如果用户不想验证签名，只需实现此函数不执行任何操作， 并返回 FSSignatureStateUnknown。 建议用户使用类 FSLTVVerifier 来验证已签名的签名是否有效。

参数

  [in] | document | PDF 文档对象。它将是有效的。
  [in] | pdf_signature | 已签名的 PDF 签名。此签名属于输入参数 document。

返回
  签名验证状态。请参阅从 FSSignatureStateUnknown 开始的值， 并且将是其中一个或其组合。