Foxit PDF SDK
foxit.pdf.interform.FillerAssistCallback类 参考

继承自 SystemIDisposable .

Public 类型

enum  PopupMenuItem {
  PopupMenuItem.e_PopupMenuItemNone = 0, PopupMenuItem.e_PopupMenuItemCut = 1, PopupMenuItem.e_PopupMenuItemCopy = 2, PopupMenuItem.e_PopupMenuItemPaste = 3,
  PopupMenuItem.e_PopupMenuItemDelete = 4, PopupMenuItem.e_PopupMenuItemSelectAll = 5
}
 弹出菜单项的枚举。 更多...
 

Public 成员函数

virtual bool AppendPopupMenuItem (global::System.IntPtr h_popup_menu, FillerAssistCallback.PopupMenuItem popup_menu_item, string default_string)
 当需要向弹出菜单追加弹出菜单项时触发的回调函数。 更多...
 
virtual global::System.IntPtr CreatePopupMenu ()
 当需要创建弹出菜单时触发的回调函数。 更多...
 
virtual void DestroyPopupMenu (global::System.IntPtr h_popup_menu)
 当需要销毁弹出菜单时触发的回调函数。 更多...
 
virtual bool EnablePopupMenuItem (global::System.IntPtr h_popup_menu, FillerAssistCallback.PopupMenuItem popup_menu_item, bool is_enabled)
 当需要启用弹出菜单中指定弹出菜单项时触发的回调函数。 更多...
 
virtual void FocusGotOnControl (Control control, string value)
 当焦点设置到表单控件时触发的回调函数。 更多...
 
virtual void FocusLostFromControl (Control control, string value)
 当焦点从表单控件丢失时触发的回调函数。 更多...
 
virtual string GetClipboardText ()
 当需要获取剪贴板上的文本时触发的回调函数。 更多...
 
virtual int GetVersion ()
 获取派生实现的版本,用于兼容性原因。 更多...
 
virtual bool KillTimer (int timer_id)
 用于通过计时器标识符销毁计时器事件的回调函数。 更多...
 
virtual void Refresh (PDFPage page, RectF rect)
 用于刷新指定页面上指定区域的回调函数。 更多...
 
virtual void Release ()
 用于释放当前回调对象本身的回调函数。 更多...
 
virtual void ReportInvalidValue (string form_field_name, string invalid_value)
 当用户输入无效值时触发的回调函数。 更多...
 
virtual void SetClipboardText (string text)
 当需要设置剪贴板文本时触发的回调函数。 更多...
 
virtual bool SetTimerCallback (int elapse, TimerCallback timer, out int out_timer_id)
 用于设置系统计时器的回调函数。 更多...
 
virtual bool ShowPopupMenu (global::System.IntPtr h_popup_menu, PointF point)
 当需要显示弹出菜单时触发的回调函数。 更多...
 

详细描述

此类表示一个回调对象来协助表单填充器。 此类中的所有纯虚函数都用作回调函数,应由用户实现。

成员枚举类型说明

◆ PopupMenuItem

弹出菜单项的枚举。

此枚举的值应单独使用。

枚举值
e_PopupMenuItemNone 

无弹出菜单项。

e_PopupMenuItemCut 

弹出菜单项:"剪切"。

e_PopupMenuItemCopy 

弹出菜单项:"复制"。

e_PopupMenuItemPaste 

弹出菜单项:"粘贴"。

e_PopupMenuItemDelete 

弹出菜单项:"删除"。

e_PopupMenuItemSelectAll 

弹出菜单项:"全选"。

成员函数说明

◆ AppendPopupMenuItem()

bool foxit.pdf.interform.FillerAssistCallback.AppendPopupMenuItem ( global::System.IntPtr  h_popup_menu,
FillerAssistCallback.PopupMenuItem  popup_menu_item,
string  default_string 
)
inlinevirtual

当需要向弹出菜单追加弹出菜单项时触发的回调函数。

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

参数
[in]h_popup_menu弹出菜单句柄。
[in]popup_menu_item指定确切弹出菜单项的值。请参考从 foxit.pdf.interform.FillerAssistCallback.PopupMenuItem.e_PopupMenuItemNone 开始的值, 这将是这些值中的一个。
[in]default_string指定弹出菜单项的默认字符串。
返回
true 表示成功,false 表示失败。

◆ CreatePopupMenu()

global.System.IntPtr foxit.pdf.interform.FillerAssistCallback.CreatePopupMenu ( )
inlinevirtual

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

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

返回
弹出菜单句柄。

◆ DestroyPopupMenu()

void foxit.pdf.interform.FillerAssistCallback.DestroyPopupMenu ( global::System.IntPtr  h_popup_menu)
inlinevirtual

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

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

参数
[in]h_popup_menu弹出菜单句柄。
返回
无。

◆ EnablePopupMenuItem()

bool foxit.pdf.interform.FillerAssistCallback.EnablePopupMenuItem ( global::System.IntPtr  h_popup_menu,
FillerAssistCallback.PopupMenuItem  popup_menu_item,
bool  is_enabled 
)
inlinevirtual

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

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

参数
[in]h_popup_menu弹出菜单句柄。
[in]popup_menu_item指定确切弹出菜单项的值。请参考从 foxit.pdf.interform.FillerAssistCallback.PopupMenuItem.e_PopupMenuItemNone 开始的值, 这将是这些值中的一个。
[in]is_enabled决定是启用指定弹出菜单项还是禁用它的布尔值。
返回
true 表示成功,false 表示失败。

◆ FocusGotOnControl()

void foxit.pdf.interform.FillerAssistCallback.FocusGotOnControl ( Control  control,
string  value 
)
inlinevirtual

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

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

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

◆ FocusLostFromControl()

void foxit.pdf.interform.FillerAssistCallback.FocusLostFromControl ( Control  control,
string  value 
)
inlinevirtual

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

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

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

◆ GetClipboardText()

string foxit.pdf.interform.FillerAssistCallback.GetClipboardText ( )
inlinevirtual

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

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

返回
剪贴板上的文本。

◆ GetVersion()

int foxit.pdf.interform.FillerAssistCallback.GetVersion ( )
inlinevirtual

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

返回
派生实现的版本。

◆ KillTimer()

bool foxit.pdf.interform.FillerAssistCallback.KillTimer ( int  timer_id)
inlinevirtual

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

参数
[in]timer_id先前调用回调函数FillerAssistCallback.SetTimerCallback 返回的计时器标识符。
返回
true 表示成功,false 表示失败。

◆ Refresh()

void foxit.pdf.interform.FillerAssistCallback.Refresh ( PDFPage  page,
RectF  rect 
)
inlinevirtual

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

参数
[in]pagePDF页面对象。
[in]rect指定页面上要重绘区域的矩形。 null 表示刷新整个页面。
返回
无。

◆ Release()

void foxit.pdf.interform.FillerAssistCallback.Release ( )
inlinevirtual

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

返回
无。

◆ ReportInvalidValue()

void foxit.pdf.interform.FillerAssistCallback.ReportInvalidValue ( string  form_field_name,
string  invalid_value 
)
inlinevirtual

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

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

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

◆ SetClipboardText()

void foxit.pdf.interform.FillerAssistCallback.SetClipboardText ( string  text)
inlinevirtual

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

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

参数
[in]text需要设置到剪贴板的文本。
返回
无。

◆ SetTimerCallback()

bool foxit.pdf.interform.FillerAssistCallback.SetTimerCallback ( int  elapse,
TimerCallback  timer,
out int  out_timer_id 
)
inlinevirtual

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

调用此回调函数来安装系统计时器。当指定超时值时, 每次发生超时时,系统都会向计时器回调函数传递消息。

参数
[in]elapse指定超时值,以毫秒为单位。
[in]timer作为计时器的TimerCallback 对象。
[out]out_timer_id输出参数,如果函数成功完成,则接收新计时器的计时器标识符。 此值将传递给回调函数FillerAssistCallback.KillTimer 以销毁计时器。如果函数成功则为非零;否则,此值应为零。
返回
true 表示成功,false 表示失败。

◆ ShowPopupMenu()

bool foxit.pdf.interform.FillerAssistCallback.ShowPopupMenu ( global::System.IntPtr  h_popup_menu,
PointF  point 
)
inlinevirtual

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

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

参数
[in]h_popup_menu弹出菜单句柄。
[in]point用于定位显示弹出菜单位置的左上角点,在中。
返回
true 表示成功,false 表示失败。