Foxit PDF SDK

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

## Public 成员函数
| AppendPopupMenuItem (h_popup_menu, popup_menu_item, default_string)
| 当需要将弹出菜单项添加到弹出菜单时触发的回调函数。 更多...
| CreatePopupMenu ()
| 当需要创建弹出菜单时触发的回调函数。 更多...
| DestroyPopupMenu (h_popup_menu)
| 当需要销毁弹出菜单时触发的回调函数。 更多...
| EnablePopupMenuItem (h_popup_menu, popup_menu_item, is_enabled)
| 当需要启用弹出菜单中指定的弹出菜单项时触发的回调函数。 更多...
| FocusGotOnControl (control, value)
| 当焦点设置到表单控件时触发的回调函数。 更多...
| FocusLostFromControl (control, value)
| 当焦点从表单控件丢失时触发的回调函数。 更多...
| GetClipboardText ()
| 当需要获取剪贴板上的文本时触发的回调函数。 更多...
| GetVersion ()
| 获取派生实现的版本，用于兼容性原因。 更多...
SetTimerCallback(elapse, timer) | KillTimer (timer_id)
| 用于设置系统计时器的回调函数。 更多...
| Refresh (page, rect)
| 用于刷新指定页面上指定区域的回调函数。 更多...
| Release ()
| 用于释放当前回调对象本身的回调函数。 更多...
| ReportInvalidValue (form_field_name, invalid_value)
| 当用户输入无效值时触发的回调函数。 更多...
| SetClipboardText (text)
| 当需要设置剪贴板文本时触发的回调函数。 更多...
| ShowPopupMenu (h_popup_menu, point)
| 当需要显示弹出菜单时触发的回调函数。 更多...

## 静态 Public 属性
static | e_PopupMenuItemCopy
| 弹出菜单项："复制"。
static | e_PopupMenuItemCut
| 弹出菜单项："剪切"。
static | e_PopupMenuItemDelete
| 弹出菜单项："删除"。
static | e_PopupMenuItemNone
| 弹出菜单项的枚举。 更多...
static | e_PopupMenuItemPaste
| 弹出菜单项："粘贴"。
static | e_PopupMenuItemSelectAll
| 弹出菜单项:"全选"。

## 详细描述

此类表示用于辅助表单填充器的回调对象。 此类中的所有纯虚函数都用作回调函数，应由用户实现。

## 成员函数说明

## ◆ AppendPopupMenuItem()

FSDK::FillerAssistCallback::AppendPopupMenuItem | ( | h_popup_menu | ,
|  | popup_menu_item | ,
|  | default_string |
| ) |  |

当需要将弹出菜单项添加到弹出菜单时触发的回调函数。

此回调函数支持文本字段、组合框字段。

参数

  [in] | h_popup_menu | 弹出菜单句柄。
  [in] | popup_menu_item | 用于指定确切弹出菜单项的值。请参考从 FSDK.FillerAssistCallback.e_PopupMenuItemNone 开始的值，并且将是这些值之一。
  [in] | default_string | 指定弹出菜单项的默认字符串。

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

## ◆ CreatePopupMenu()

FSDK::FillerAssistCallback::CreatePopupMenu | ( |  | ) |

当需要创建弹出菜单时触发的回调函数。

此回调函数支持文本字段、组合框字段。

返回
  弹出菜单句柄。

## ◆ DestroyPopupMenu()

FSDK::FillerAssistCallback::DestroyPopupMenu | ( | h_popup_menu |  | ) |

当需要销毁弹出菜单时触发的回调函数。

此回调函数支持文本字段、组合框字段。

参数

  [in] | h_popup_menu | 弹出菜单句柄。

返回
  无。

## ◆ EnablePopupMenuItem()

FSDK::FillerAssistCallback::EnablePopupMenuItem | ( | h_popup_menu | ,
|  | popup_menu_item | ,
|  | is_enabled |
| ) |  |

当需要启用弹出菜单中指定的弹出菜单项时触发的回调函数。

此回调函数支持文本字段、组合框字段。

参数

  [in] | h_popup_menu | 弹出菜单句柄。
  [in] | popup_menu_item | 用于指定确切弹出菜单项的值。请参考从 FSDK.FillerAssistCallback.e_PopupMenuItemNone 开始的值，并且将是这些值之一。
  [in] | is_enabled | 布尔值，决定是启用指定的弹出菜单项还是禁用它。

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

## ◆ FocusGotOnControl()

FSDK::FillerAssistCallback::FocusGotOnControl | ( | control | ,
|  | value |
| ) |  |

当焦点设置到表单控件时触发的回调函数。

此回调函数支持文本字段、组合框字段、列表框字段、按钮字段、 复选框字段、单选按钮字段。

参数

  [in] | control | 设置焦点的表单控件对象。
  [in] | value | 与控件关联的表单字段的值。 如果控件属于按钮字段，此值始终为空字符串。

返回
  无。

## ◆ FocusLostFromControl()

FSDK::FillerAssistCallback::FocusLostFromControl | ( | control | ,
|  | value |
| ) |  |

当焦点从表单控件丢失时触发的回调函数。

此回调函数支持文本字段、组合框字段、列表框字段、按钮字段、 复选框字段、单选按钮字段。

参数

  [in] | control | 丢失焦点的表单控件对象。
  [in] | value | 与控件关联的表单字段的值。 如果控件属于按钮字段，此值始终为空字符串。

返回
  无。

## ◆ GetClipboardText()

FSDK::FillerAssistCallback::GetClipboardText | ( |  | ) |

当需要获取剪贴板上的文本时触发的回调函数。

此回调函数支持文本字段、组合框字段。

返回
  剪贴板上的文本。

## ◆ GetVersion()

FSDK::FillerAssistCallback::GetVersion | ( |  | ) |

获取派生实现的版本，用于兼容性原因。

返回
  派生实现的版本。

## ◆ KillTimer()

SetTimerCallback (elapse, timer) FSDK::FillerAssistCallback::KillTimer | ( | timer_id |  | ) |

用于设置系统计时器的回调函数。

此回调函数被调用以安装系统计时器。当指定超时值时， 并且每次发生超时时，系统将消息传递给计时器回调函数。

参数

  [in] | elapse | 指定超时值，以毫秒为单位。
  [in] | timer | FSDK.TimerCallback 对象作为计时器。

返回
  返回一个元组，第一个元素是布尔值，true 表示成功，而 false 表示失败。 The second element is the parameter that receives the timer identifier of the new timer if the function is finished successfully. This value would be passed to callback function FSDK.FillerAssistCallback.KillTimer to kill the timer. Nonzero if the function is successful; otherwise, this should be zero.

用于通过计时器标识符终止计时器事件的回调函数。

参数

  [in] | timer_id | 由早期调用回调函数 FSDK.FillerAssistCallback.SetTimerCallback 返回的计时器标识符。

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

## ◆ Refresh()

FSDK::FillerAssistCallback::Refresh | ( | page | ,
|  | rect |
| ) |  |

用于刷新指定页面上指定区域的回调函数。

参数

  [in] | page | PDF 页面对象。
  [in] | rect | 指定页面上要重绘区域的矩形。 null 表示刷新整个页面。

返回
  无。

## ◆ Release()

FSDK::FillerAssistCallback::Release | ( |  | ) |

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

返回
  无。

## ◆ ReportInvalidValue()

FSDK::FillerAssistCallback::ReportInvalidValue | ( | form_field_name | ,
|  | invalid_value |
| ) |  |

当用户输入无效值时触发的回调函数。

此回调函数支持文本字段、组合框字段。

参数

  [in] | form_field_name | 与控件关联的表单字段的名称。
  [in] | invalid_value | 与控件关联的表单字段的无效值。

返回
  无。

## ◆ SetClipboardText()

FSDK::FillerAssistCallback::SetClipboardText | ( | text |  | ) |

当需要设置剪贴板文本时触发的回调函数。

此回调函数支持文本字段、组合框字段。

参数

  [in] | text | 需要设置到剪贴板的文本。

返回
  无。

## ◆ ShowPopupMenu()

FSDK::FillerAssistCallback::ShowPopupMenu | ( | h_popup_menu | ,
|  | point |
| ) |  |

当需要显示弹出菜单时触发的回调函数。

此回调函数支持文本字段、组合框字段。

参数

  [in] | h_popup_menu | 弹出菜单句柄。
  [in] | point | 用于定位显示弹出菜单位置的左上点，位于 PDF 坐标系统 中。

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

## 类成员变量说明

## ◆ e_PopupMenuItemNone

FSDK::FillerAssistCallback::e_PopupMenuItemNone
| static

弹出菜单项的枚举。

此枚举的值应单独使用。

无弹出菜单项。