Foxit PDF SDK

Public 类型 | Public 成员函数 | 所有成员列表
foxit::pdf::interform::Filler类 参考
类 foxit::pdf::interform::Filler 继承关系图:

## Public 类型
enum | EventFlags { e_EventFlagShiftKey = 0x0001, e_EventFlagControlKey = 0x0002, e_EventFlagAltKey = 0x0004, e_EventFlagMetaKey = 0x0008, e_EventFlagKeyPad = 0x0010, e_EventFlagAutoRepeat = 0x0020, e_EventFlagLeftButtonDown = 0x0040, e_EventFlagMiddleButtonDown = 0x0080, e_EventFlagRightButtonDown = 0x0100, e_EventFlagCommand = 0x0200 }
| 键事件标志的枚举。 更多...
enum | VirtualKeyCode { e_VkeyUnknown = 0x00, e_VkeyBack = 0x08, e_VkeyTab = 0x09, e_VkeyReturn = 0x0D, e_VkeyShift = 0x10, e_VkeyControl = 0x11, e_VkeyMenu = 0x12, e_VkeyPause = 0x13, e_VkeyEscape = 0x1B, e_VkeySpace = 0x20, e_VkeyPrior = 0x21, e_VkeyNext = 0x22, e_VkeyEnd = 0x23, e_VkeyHome = 0x24, e_VkeyLeft = 0x25, e_VkeyUp = 0x26, e_VkeyRight = 0x27, e_VkeyDown = 0x28, e_VkeyPrint = 0x2A, e_VkeySnapshot = 0x2C, e_VkeyInsert = 0x2D, e_VkeyDelete = 0x2E, e_VkeyHelp = 0x2F, e_Vkey0 = 0x30, e_Vkey1 = 0x31, e_Vkey2 = 0x32, e_Vkey3 = 0x33, e_Vkey4 = 0x34, e_Vkey5 = 0x35, e_Vkey6 = 0x36, e_Vkey7 = 0x37, e_Vkey8 = 0x38, e_Vkey9 = 0x39, e_VkeyA = 0x41, e_VkeyB = 0x42, e_VkeyC = 0x43, e_VkeyD = 0x44, e_VkeyE = 0x45, e_VkeyF = 0x46, e_VkeyG = 0x47, e_VkeyH = 0x48, e_VkeyI = 0x49, e_VkeyJ = 0x4A, e_VkeyK = 0x4B, e_VkeyL = 0x4C, e_VkeyM = 0x4D, e_VkeyN = 0x4E, e_VkeyO = 0x4F, e_VkeyP = 0x50, e_VkeyQ = 0x51, e_VkeyR = 0x52, e_VkeyS = 0x53, e_VkeyT = 0x54, e_VkeyU = 0x55, e_VkeyV = 0x56, e_VkeyW = 0x57, e_VkeyX = 0x58, e_VkeyY = 0x59, e_VkeyZ = 0x5A, e_VkeyNumpad0 = 0x60, e_VkeyNumpad1 = 0x61, e_VkeyNumpad2 = 0x62, e_VkeyNumpad3 = 0x63, e_VkeyNumpad4 = 0x64, e_VkeyNumpad5 = 0x65, e_VkeyNumpad6 = 0x66, e_VkeyNumpad7 = 0x67, e_VkeyNumpad8 = 0x68, e_VkeyNumpad9 = 0x69, e_VkeyMultiply = 0x6A, e_VkeyAdd = 0x6B, e_VkeySeparator = 0x6C, e_VkeySubtract = 0x6D, e_VkeyDecimal = 0x6E, e_VkeyDivide = 0x6F, e_VkeyF1 = 0x70, e_VkeyF2 = 0x71, e_VkeyF3 = 0x72, e_VkeyF4 = 0x73, e_VkeyF5 = 0x74, e_VkeyF6 = 0x75, e_VkeyF7 = 0x76, e_VkeyF8 = 0x77, e_VkeyF9 = 0x78, e_VkeyF10 = 0x79, e_VkeyF11 = 0x7A, e_VkeyF12 = 0x7B }
| 虚拟键码的枚举。 更多...

## Public 成员函数
| Filler (const Form &form, FillerAssistCallback *assist)
| 构造函数。 更多...
| Filler (const Filler &other)
| 复制构造函数。 更多...
| ~Filler ()
| 析构函数。
PointF | GetEditingTextCaretPosition (Matrix matrix)
| 当文本字段或组合框处于编辑状态时获取文本光标位置。 更多...
void | HighlightFormFields (bool is_highlight)
| 决定是否高亮显示表单字段（包括签名字段）。 更多...
void | HighlightFormFields (bool is_highlight, bool is_sign_highlight)
| 决定是否高亮显示签名字段和其他表单字段。 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | KillFocus ()
| 从表单中移除焦点。 更多...
bool | OnChar (uint32 char_code, uint32 flags)
| 当字符代码即将输入到表单字段时调用此函数。 更多...
bool | OnCopy ()
| 当弹出菜单项"复制"按下时调用此函数。 更多...
bool | OnCut ()
| 当弹出菜单项"剪切"按下时调用此函数。 更多...
bool | OnDelete ()
| 当弹出菜单项"删除"按下时调用此函数。 更多...
bool | OnKeyDown (uint32 key_code, uint32 flags)
| 当键盘上的键按下时调用此函数。 更多...
bool | OnKeyUp (uint32 key_code, uint32 flags)
| 当键盘上的键抬起时调用此函数。 更多...
bool | OnLButtonDoubleClick (const PDFPage &page, const PointF &point, uint32 flags)
| 当鼠标左键双击时调用此函数。 更多...
bool | OnLButtonDown (const PDFPage &page, const PointF &point, uint32 flags)
| 当鼠标左键按下时调用此函数。 更多...
bool | OnLButtonUp (const PDFPage &page, const PointF &point, uint32 flags)
| 当鼠标左键抬起时调用此函数。 更多...
bool | OnMouseEnter (const PDFPage &page, const PointF &point, uint32 flags)
| （保留，尚未支持）当鼠标进入某处时调用此函数。 更多...
bool | OnMouseHover (const PDFPage &page, const PointF &point, uint32 flags)
| （保留，尚未支持）当鼠标悬停在某处时调用此函数。 更多...
bool | OnMouseLeave (const PDFPage &page, const PointF &point, uint32 flags)
| （保留，尚未支持）当鼠标离开某处时调用此函数。 更多...
bool | OnMouseMove (const PDFPage &page, const PointF &point, uint32 flags)
| 当鼠标移动时调用此函数。 更多...
bool | OnMouseWheel (const PDFPage &page, const PointF &point, int32 delta, uint32 flags)
| （保留，尚未支持）当鼠标滚轮移动时调用此函数。 更多...
bool | OnPaste ()
| 当弹出菜单项"粘贴"按下时调用此函数。 更多...
bool | OnRButtonDoubleClick (const PDFPage &page, const PointF &point, uint32 flags)
| （保留，尚未支持）当鼠标右键双击时调用此函数。 更多...
bool | OnRButtonDown (const PDFPage &page, const PointF &point, uint32 flags)
| 当鼠标右键按下时调用此函数。 更多...
bool | OnRButtonUp (const PDFPage &page, const PointF &point, uint32 flags)
| 当鼠标右键抬起时调用此函数。 更多...
bool | OnSelectAll ()
| 当弹出菜单项"全选"按下时调用此函数。 更多...
bool | OnWheelButtonDoubleClick (const PDFPage &page, const PointF &point, uint32 flags)
| （保留，尚未支持）当鼠标滚轮按钮双击时调用此函数。 更多...
bool | OnWheelButtonDown (const PDFPage &page, const PointF &point, uint32 flags)
| （保留，尚未支持）当鼠标滚轮按钮按下时调用此函数。 更多...
bool | OnWheelButtonUp (const PDFPage &page, const PointF &point, uint32 flags)
| （保留，尚未支持）当鼠标滚轮按钮抬起时调用此函数。 更多...
bool | operator != (const Filler &other) const
| 不等操作符。 更多...
Filler & | operator= (const Filler &other)
| 赋值操作符。 更多...
bool | operator== (const Filler &other) const
| 相等操作符。 更多...
void | Render (const PDFPage &page, const Matrix &matrix, const common::Renderer &renderer)
| 在页面上绘制当前获得焦点的表单控件。 更多...
bool | SetFocus (const Control &control)
| 将焦点设置到表单控件上。 更多...
void | SetHighlightColor (ARGB color)
| 设置用于高亮显示表单字段的高亮颜色。 更多...
void | ShowOverflowIndicator (bool is_show_overflow_indicator)
| 决定当文本字段中的文本溢出时是否显示溢出指示器。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 详细描述

此类表示用于填充PDF表单的表单填充器。对于一个交互式表单应该只有一个表单填充器对象， 因此不要为一个Form对象构造超过一个表单填充器。 建议用户实现foxit::ActionCallback并通过common::Library::SetActionCallback 函数将其设置到Foxit PDF SDK，以便实现表单填充器的更多功能。

参见
  common::Library

## 成员枚举类型说明

## ◆ EventFlags

enum foxit::pdf::interform::Filler::EventFlags

键事件标志的枚举。

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

枚举值
e_EventFlagShiftKey | 事件标志："Shift"键。
e_EventFlagControlKey | 事件标志："Ctrl"键。
e_EventFlagAltKey | 事件标志："Alt"键。
e_EventFlagMetaKey | 事件标志：元键。
e_EventFlagKeyPad | 事件标志：键盘。
e_EventFlagAutoRepeat | 事件标志：自动重复。
e_EventFlagLeftButtonDown | 事件标志：鼠标左键按下。
e_EventFlagMiddleButtonDown | 事件标志：鼠标中键按下。
e_EventFlagRightButtonDown | 事件标志：鼠标右键按下。
e_EventFlagCommand | 事件标志：命令键。

## ◆ VirtualKeyCode

enum foxit::pdf::interform::Filler::VirtualKeyCode

虚拟键码的枚举。

此枚举的值应单独使用。

枚举值
e_VkeyUnknown | 未知键。
e_VkeyBack | 退格键。
e_VkeyTab | Tab键。
e_VkeyReturn | 回车键。
e_VkeyShift | Shift键。
e_VkeyControl | Ctrl键。
e_VkeyMenu | 菜单键。
e_VkeyPause | Pause Break键。
e_VkeyEscape | ESC键。
e_VkeySpace | 空格键。
e_VkeyPrior | Page Up键。
e_VkeyNext | Page Down键。
e_VkeyEnd | End键。
e_VkeyHome | Home键。
e_VkeyLeft | 左箭头键。
e_VkeyUp | 上箭头键。
e_VkeyRight | 右箭头键。
e_VkeyDown | 下箭头键。
e_VkeyPrint | Print键。
e_VkeySnapshot | Print Screen键。
e_VkeyInsert | Insert键。
e_VkeyDelete | Delete键。
e_VkeyHelp | Help键。
e_Vkey0 | 0键。
e_Vkey1 | 1键。
e_Vkey2 | 2键。
e_Vkey3 | 3键。
e_Vkey4 | 4键。
e_Vkey5 | 5键。
e_Vkey6 | 6键。
e_Vkey7 | 7键。
e_Vkey8 | 8键。
e_Vkey9 | 9键。
e_VkeyA | A键。
e_VkeyB | B键。
e_VkeyC | C键。
e_VkeyD | D键。
e_VkeyE | E键。
e_VkeyF | F键。
e_VkeyG | G键。
e_VkeyH | H键。
e_VkeyI | I键。
e_VkeyJ | J键。
e_VkeyK | K键。
e_VkeyL | L键。
e_VkeyM | M键。
e_VkeyN | N键。
e_VkeyO | O键。
e_VkeyP | P键。
e_VkeyQ | Q键。
e_VkeyR | R键。
e_VkeyS | S键。
e_VkeyT | T键。
e_VkeyU | U键。
e_VkeyV | V键。
e_VkeyW | W键。
e_VkeyX | X键。
e_VkeyY | Y键。
e_VkeyZ | Z键。
e_VkeyNumpad0 | 数字键盘中的0键。
e_VkeyNumpad1 | 数字键盘中的1键。
e_VkeyNumpad2 | 数字键盘中的2键。
e_VkeyNumpad3 | 数字键盘中的3键。
e_VkeyNumpad4 | 数字键盘中的4键。
e_VkeyNumpad5 | 数字键盘中的5键。
e_VkeyNumpad6 | 数字键盘中的6键。
e_VkeyNumpad7 | 数字键盘中的7键。
e_VkeyNumpad8 | 数字键盘中的8键。
e_VkeyNumpad9 | 数字键盘中的9键。
e_VkeyMultiply | 数字键盘中的乘号键。
e_VkeyAdd | 数字键盘中的加号键。
e_VkeySeparator | 数字键盘中的回车键。
e_VkeySubtract | 数字键盘中的减号键。
e_VkeyDecimal | 数字键盘中的小数点键。
e_VkeyDivide | 数字键盘中的斜杠键。
e_VkeyF1 | F1键。
e_VkeyF2 | F2键。
e_VkeyF3 | F3键。
e_VkeyF4 | F4键。
e_VkeyF5 | F5键。
e_VkeyF6 | F6键。
e_VkeyF7 | F7键。
e_VkeyF8 | F8键。
e_VkeyF9 | F9键。
e_VkeyF10 | F10键。
e_VkeyF11 | F11键。
e_VkeyF12 | F12键。

## 构造及析构函数说明

## ◆ Filler() [1/2]

foxit::pdf::interform::Filler::Filler | ( | const Form & | form,
|  | FillerAssistCallback * | assist
| ) |  |
| explicit

构造函数。

一个表单只能有一个表单填充器。

参数

  [in] | form | 有效的PDF表单。
  [in] | assist | 表单填充器的辅助回调类。这应该由用户实现，不应为NULL。

## ◆ Filler() [2/2]

foxit::pdf::interform::Filler::Filler | ( | const Filler & | other | ) |

复制构造函数。

参数

  [in] | other | 另一个填充器对象。

## 成员函数说明

## ◆ GetEditingTextCaretPosition()

PointF foxit::pdf::interform::Filler::GetEditingTextCaretPosition | ( | Matrix | matrix | ) |

当文本字段或组合框处于编辑状态时获取文本光标位置。

参数

  [in] | matrix | 用于将返回位置转换到设备坐标系统的矩阵。

返回
  设备坐标系统中文本光标顶部的位置。
  (-1,-1) 表示没有文本字段或组合框处于编辑状态。

## ◆ HighlightFormFields() [1/2]

void foxit::pdf::interform::Filler::HighlightFormFields | ( | bool | is_highlight | ) |

决定是否高亮显示表单字段（包括签名字段）。

除按钮字段外，所有类型的表单字段都可以高亮显示。 如果不调用此函数，Foxit PDF SDK默认会高亮显示所有表单字段（包括签名字段）。

参数

  [in] | is_highlight | true 表示高亮显示表单字段（包括签名字段）， false 表示不高亮显示表单字段（包括签名字段）。

返回
  无。

## ◆ HighlightFormFields() [2/2]

void foxit::pdf::interform::Filler::HighlightFormFields | ( | bool | is_highlight,
|  | bool | is_sign_highlight
| ) |  |

决定是否高亮显示签名字段和其他表单字段。

除按钮字段外，所有类型的表单字段都可以高亮显示。 如果不调用此函数，Foxit PDF SDK默认会高亮显示除签名字段外的所有表单字段 （签名字段默认不高亮显示）。

参数

  [in] | is_highlight | 此布尔值用于非签名字段： true 表示高亮显示表单字段，false 表示 不高亮显示表单字段。
  [in] | is_sign_highlight | 此布尔值仅用于签名字段： true 表示高亮显示签名字段，false 表示 不高亮显示签名字段。

返回
  无。

## ◆ IsEmpty()

bool foxit::pdf::interform::Filler::IsEmpty | ( |  | ) | const

检查当前对象是否为空。

当当前对象为空时，表示当前对象无用。

返回
  true 表示当前对象为空，false 表示不为空。

## ◆ KillFocus()

bool foxit::pdf::interform::Filler::KillFocus | ( |  | ) |

从表单中移除焦点。

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

## ◆ OnChar()

bool foxit::pdf::interform::Filler::OnChar | ( | uint32 | char_code,
|  | uint32 | flags
| ) |  |

当字符代码即将输入到表单字段时调用此函数。

参数

  [in] | char_code | 字符代码，采用UTF16-LE编码。
  [in] | flags | 事件标志。请参考从Filler::e_EventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

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

## ◆ OnCopy()

bool foxit::pdf::interform::Filler::OnCopy | ( |  | ) |

当弹出菜单项"复制"按下时调用此函数。

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

## ◆ OnCut()

bool foxit::pdf::interform::Filler::OnCut | ( |  | ) |

当弹出菜单项"剪切"按下时调用此函数。

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

## ◆ OnDelete()

bool foxit::pdf::interform::Filler::OnDelete | ( |  | ) |

当弹出菜单项"删除"按下时调用此函数。

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

## ◆ OnKeyDown()

bool foxit::pdf::interform::Filler::OnKeyDown | ( | uint32 | key_code,
|  | uint32 | flags
| ) |  |

当键盘上的键按下时调用此函数。

参数

  [in] | key_code | 键码。请参考从Filler::e_VkeyUnknown开始的值， 这应该是这些值中的一个。
  [in] | flags | 事件标志。请参考从Filler::e_EventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  true 表示成功，false 表示失败。 目前此函数尚不支持使用，因此此函数将始终返回true。

## ◆ OnKeyUp()

bool foxit::pdf::interform::Filler::OnKeyUp | ( | uint32 | key_code,
|  | uint32 | flags
| ) |  |

当键盘上的键抬起时调用此函数。

参数

  [in] | key_code | 键码。请参考从Filler::e_VkeyUnknown开始的值， 这应该是这些值中的一个。
  [in] | flags | 事件标志。请参考从Filler::e_EventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  true 表示成功，false 表示失败。 目前此函数尚不支持使用，因此此函数将始终返回true。

## ◆ OnLButtonDoubleClick()

bool foxit::pdf::interform::Filler::OnLButtonDoubleClick | ( | const PDFPage & | page,
|  | const PointF & | point,
|  | uint32 | flags
| ) |  |

当鼠标左键双击时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在PDF坐标系统中。
  [in] | flags | 事件标志。请参考从Filler::e_EventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

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

## ◆ OnLButtonDown()

bool foxit::pdf::interform::Filler::OnLButtonDown | ( | const PDFPage & | page,
|  | const PointF & | point,
|  | uint32 | flags
| ) |  |

当鼠标左键按下时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键按下的点，在PDF坐标系统中。
  [in] | flags | 事件标志。请参考从Filler::e_EventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

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

## ◆ OnLButtonUp()

bool foxit::pdf::interform::Filler::OnLButtonUp | ( | const PDFPage & | page,
|  | const PointF & | point,
|  | uint32 | flags
| ) |  |

当鼠标左键抬起时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在PDF坐标系统中。
  [in] | flags | 事件标志。请参考从Filler::e_EventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

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

## ◆ OnMouseEnter()

bool foxit::pdf::interform::Filler::OnMouseEnter | ( | const PDFPage & | page,
|  | const PointF & | point,
|  | uint32 | flags
| ) |  |

（保留，尚未支持）当鼠标进入某处时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在PDF坐标系统中。
  [in] | flags | 事件标志。请参考从Filler::e_EventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  true 表示成功，false 表示失败。 目前此函数尚不支持使用，因此此函数将始终返回false。

## ◆ OnMouseHover()

bool foxit::pdf::interform::Filler::OnMouseHover | ( | const PDFPage & | page,
|  | const PointF & | point,
|  | uint32 | flags
| ) |  |

（保留，尚未支持）当鼠标悬停在某处时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在PDF坐标系统中。
  [in] | flags | 事件标志。请参考从Filler::e_EventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  true 表示成功，false 表示失败。 目前此函数尚不支持使用，因此此函数将始终返回false。

## ◆ OnMouseLeave()

bool foxit::pdf::interform::Filler::OnMouseLeave | ( | const PDFPage & | page,
|  | const PointF & | point,
|  | uint32 | flags
| ) |  |

（保留，尚未支持）当鼠标离开某处时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在PDF坐标系统中。
  [in] | flags | 事件标志。请参考从Filler::e_EventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  true 表示成功，false 表示失败。 目前此函数尚不支持使用，因此此函数将始终返回false。

## ◆ OnMouseMove()

bool foxit::pdf::interform::Filler::OnMouseMove | ( | const PDFPage & | page,
|  | const PointF & | point,
|  | uint32 | flags
| ) |  |

当鼠标移动时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在PDF坐标系统中。
  [in] | flags | 事件标志。请参考从Filler::e_EventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

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

## ◆ OnMouseWheel()

bool foxit::pdf::interform::Filler::OnMouseWheel | ( | const PDFPage & | page,
|  | const PointF & | point,
|  | int32 | delta,
|  | uint32 | flags
| ) |  |

（保留，尚未支持）当鼠标滚轮移动时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在PDF坐标系统中。
  [in] | delta | 指示鼠标滚轮移动的量。正值表示向前移动， 负值表示向后移动。
  [in] | flags | 事件标志。请参考从Filler::e_EventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  true 表示成功，false 表示失败。 目前此函数尚不支持使用，因此此函数将始终返回false。

## ◆ OnPaste()

bool foxit::pdf::interform::Filler::OnPaste | ( |  | ) |

当弹出菜单项"粘贴"按下时调用此函数。

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

## ◆ OnRButtonDoubleClick()

bool foxit::pdf::interform::Filler::OnRButtonDoubleClick | ( | const PDFPage & | page,
|  | const PointF & | point,
|  | uint32 | flags
| ) |  |

（保留，尚未支持）当鼠标右键双击时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在PDF坐标系统中。
  [in] | flags | 事件标志。请参考从Filler::e_EventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  true 表示成功，false 表示失败。 目前此函数尚不支持使用，因此此函数将始终返回false。

## ◆ OnRButtonDown()

bool foxit::pdf::interform::Filler::OnRButtonDown | ( | const PDFPage & | page,
|  | const PointF & | point,
|  | uint32 | flags
| ) |  |

当鼠标右键按下时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在PDF坐标系统中。
  [in] | flags | 事件标志。请参考从Filler::e_EventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  true 表示成功，false 表示失败。 目前此函数尚不支持使用，因此此函数将始终返回false。

## ◆ OnRButtonUp()

bool foxit::pdf::interform::Filler::OnRButtonUp | ( | const PDFPage & | page,
|  | const PointF & | point,
|  | uint32 | flags
| ) |  |

当鼠标右键抬起时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在PDF坐标系统中。
  [in] | flags | 事件标志。请参考从Filler::e_EventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  true 表示成功，false 表示失败。 目前此函数尚不支持使用，因此此函数将始终返回false。

## ◆ OnSelectAll()

bool foxit::pdf::interform::Filler::OnSelectAll | ( |  | ) |

当弹出菜单项"全选"按下时调用此函数。

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

## ◆ OnWheelButtonDoubleClick()

bool foxit::pdf::interform::Filler::OnWheelButtonDoubleClick | ( | const PDFPage & | page,
|  | const PointF & | point,
|  | uint32 | flags
| ) |  |

（保留，尚未支持）当鼠标滚轮按钮双击时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在PDF坐标系统中。
  [in] | flags | 事件标志。请参考从Filler::e_EventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  true 表示成功，false 表示失败。 目前此函数尚不支持使用，因此此函数将始终返回false。

## ◆ OnWheelButtonDown()

bool foxit::pdf::interform::Filler::OnWheelButtonDown | ( | const PDFPage & | page,
|  | const PointF & | point,
|  | uint32 | flags
| ) |  |

（保留，尚未支持）当鼠标滚轮按钮按下时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在PDF坐标系统中。
  [in] | flags | 事件标志。请参考从Filler::e_EventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  true 表示成功，false 表示失败。 目前此函数尚不支持使用，因此此函数将始终返回false。

## ◆ OnWheelButtonUp()

bool foxit::pdf::interform::Filler::OnWheelButtonUp | ( | const PDFPage & | page,
|  | const PointF & | point,
|  | uint32 | flags
| ) |  |

（保留，尚未支持）当鼠标滚轮按钮抬起时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在PDF坐标系统中。
  [in] | flags | 事件标志。请参考从Filler::e_EventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  true 表示成功，false 表示失败。 目前此函数尚不支持使用，因此此函数将始终返回false。

## ◆ operator !=()

bool foxit::pdf::interform::Filler::operator != | ( | const Filler & | other | ) | const

不等操作符。

参数

  [in] | other | 另一个填充器对象。此函数将检查当前对象是否不等于此对象。

返回
  true 表示不相等，false 表示相等。

## ◆ operator=()

Filler& foxit::pdf::interform::Filler::operator= | ( | const Filler & | other | ) |

赋值操作符。

参数

  [in] | other | 另一个填充器对象，其值将被赋给当前对象。

返回
  当前对象本身的引用。

## ◆ operator==()

bool foxit::pdf::interform::Filler::operator== | ( | const Filler & | other | ) | const

相等操作符。

参数

  [in] | other | 另一个填充器对象。此函数将检查当前对象是否等于此对象。

返回
  true 表示相等，false 表示不相等。

## ◆ Render()

void foxit::pdf::interform::Filler::Render | ( | const PDFPage & | page,
|  | const Matrix & | matrix,
|  | const common::Renderer & | renderer
| ) |  |

在页面上绘制当前获得焦点的表单控件。

如果页面上没有获得焦点的表单控件，此函数将不绘制任何内容。 获得焦点的表单控件必须是最顶层的可见元素，因此它应该 始终在页面内容和所有其他注释都已渲染后再渲染。
关于如何渲染表单控件（与控件注释关联），请参考 Renderer类注释中提到的推荐流程。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | matrix | 用于渲染的变换矩阵，通常由PDFPage::GetDisplayMatrix函数返回。
  [in] | renderer | 用于渲染的有效渲染器对象。

返回
  无。

## ◆ SetFocus()

bool foxit::pdf::interform::Filler::SetFocus | ( | const Control & | control | ) |

将焦点设置到表单控件上。

参数

  [in] | control | 表单控件对象。如果这是由默认构造函数构造且未设置任何值， 表示无焦点控件。

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

## ◆ SetHighlightColor()

void foxit::pdf::interform::Filler::SetHighlightColor | ( | ARGB | color | ) |

设置用于高亮显示表单字段的高亮颜色。

如果不调用此函数，Foxit PDF SDK默认会使用一种浅蓝灰色（值0x80C8D2FF）。

参数

  [in] | color | 要为高亮显示表单字段设置的高亮颜色。

返回
  无。

## ◆ ShowOverflowIndicator()

void foxit::pdf::interform::Filler::ShowOverflowIndicator | ( | bool | is_show_overflow_indicator | ) |

决定当文本字段中的文本溢出时是否显示溢出指示器。

如果不调用此函数，Foxit PDF SDK默认不会显示表单字段溢出指示器。

参数

  [in] | is_show_overflow_indicator | true 表示当文本字段中的文本溢出时显示溢出指示器， false 表示在这种情况下不显示溢出指示器。

返回
  无。