Foxit PDF SDK

Public 类型 | Public 成员函数 | 所有成员列表
foxit.addon.xfa.DocProviderCallback类 参考

继承自 SystemIDisposable .

## Public 类型
enum | InvalidateFlag { InvalidateFlag.e_InvalidateFlagAllPages = 0, InvalidateFlag.e_InvalidateFlagCurrentPage = 1 }
| XFA 无效化标志的枚举。 更多...
enum | PageViewEventType { PageViewEventType.e_PageViewEventTypeAdded = 0, PageViewEventType.e_PageViewEventTypeRemoved = 1, PageViewEventType.e_PageViewEventTypeAllRemoved = 2 }
| 页面视图事件类型的枚举。 更多...
enum | PrintOption { PrintOption.e_PrintOptionShowDialog = 0x00000001, PrintOption.e_PrintOptionCanCancel = 0x00000002, PrintOption.e_PrintOptionShrinkPage = 0x00000004, PrintOption.e_PrintOptionAsImage = 0x00000008 , PrintOption.e_PrintOptionPrintAnnot = 0x00000020 }
| XFA 打印选项的枚举。 更多...
enum | SubmitFormat { SubmitFormat.e_SubmitInXDP = 0, SubmitFormat.e_SubmitInPDF = 1, SubmitFormat.e_SubmitInUrlEncoded = 2, SubmitFormat.e_SubmitInXFD = 3, SubmitFormat.e_SubmitInXML = 4 }
| XFA 提交格式的枚举。 更多...
enum | TextEncoding { TextEncoding.e_TextEncodingNone = 0, TextEncoding.e_TextEncodingBig5 = 1, TextEncoding.e_TextEncodingFontSpecific = 2, TextEncoding.e_TextEncodingGBK = 3, TextEncoding.e_TextEncodingGB18030 = 4, TextEncoding.e_TextEncodingGB2312 = 5, TextEncoding.e_TextEncodingISO8859NN = 6, TextEncoding.e_TextEncodingKSC5601 = 7, TextEncoding.e_TextEncodingShiftJIS = 8, TextEncoding.e_TextEncodingUCS2 = 9, TextEncoding.e_TextEncodingUTF16 = 10, TextEncoding.e_TextEncodingUTF8 = 11 }
| XFA 提交的文本编码枚举。 更多...
enum | WidgetEventType { WidgetEventType.e_WidgetEventTypeAdded = 0, WidgetEventType.e_WidgetEventTypeBeforeRemoved = 1 }
| XFA 控件事件类型的枚举。 更多...

## Public 成员函数
virtual void | DisplayCaret (int page_index, bool is_visible, RectF rect)
| 用于显示或隐藏光标的回调函数。 更多...
virtual void | ExportData (XFADoc doc, string file_path)
| 用于将数据导出到文件的回调函数。 更多...
virtual int | GetCurrentPage (XFADoc doc)
| 用于获取当前页面索引的回调函数。 更多...
virtual uint | GetHighlightColor (XFADoc doc)
| 用于获取高亮颜色的回调函数。 更多...
virtual bool | GetPopupPos (int page_index, float min_popup, float max_popup, RectF rect_widget, RectF inout_rect_popup)
| 用于获取弹出位置的回调函数。 更多...
virtual string | GetTitle (XFADoc doc)
| 用于获取当前 XFA 文档标题的回调函数。 更多...
virtual void | GotoURL (XFADoc doc, string url)
| 用于转到指定 URL 的回调函数。 更多...
virtual void | ImportData (XFADoc doc, string file_path)
| 用于从文件导入数据的回调函数。 更多...
virtual void | InvalidateRect (int page_index, RectF rect, DocProviderCallback.InvalidateFlag flag)
| 用于根据标志无效化矩形的回调函数。 更多...
virtual void | NotifyWidgetChangeInfo (XFADoc doc, XFAWidgetModifyInfo change_info)
| 用于通知XFA 控件值的变化的回调函数。 更多...
virtual void | PageViewEvent (int page_index, DocProviderCallback.PageViewEventType page_view_event_type)
| 用于执行页面视图事件的回调函数。 更多...
virtual bool | PopupMenu (int page_index, PointF rect_popup)
| 用于弹出上下文菜单的回调函数。 更多...
virtual void | Print (XFADoc doc, int start_page_index, int end_page_index, int options)
| 用于打印的回调函数。 更多...
virtual void | Release ()
| 用于释放当前回调对象本身的回调函数。 更多...
virtual void | SetChangeMark (XFADoc doc)
| 用于为当前 XFA 文档设置更改标记标志的回调函数。 更多...
virtual void | SetCurrentPage (XFADoc doc, int current_page_index)
| 用于设置当前页面索引的回调函数。 更多...
virtual void | SetFocus (XFAWidget xfa_widget, bool is_relayout)
| 用于设置焦点控件的回调函数。 更多...
virtual bool | SubmitData (XFADoc doc, string target, DocProviderCallback.SubmitFormat format, DocProviderCallback.TextEncoding text_encoding, string content)
| 用于提交数据的回调函数。 更多...
virtual void | WidgetEvent (XFAWidget xfa_widget, DocProviderCallback.WidgetEventType widget_event_type)
| 用于执行 XFA 控件事件的回调函数。 更多...

## 详细描述

此类表示作为 XFA 文档提供程序的回调对象。 此类中的所有函数都用作回调函数。纯虚函数应由用户实现。

## 成员枚举类型说明

## ◆ InvalidateFlag

enum foxit.addon.xfa.DocProviderCallback.InvalidateFlag
| strong

XFA 无效化标志的枚举。

此枚举的值应单独使用。

枚举值
e_InvalidateFlagAllPages | 无效化所有页面。
e_InvalidateFlagCurrentPage | 无效化当前页面。

## ◆ PageViewEventType

enum foxit.addon.xfa.DocProviderCallback.PageViewEventType
| strong

页面视图事件类型的枚举。

此枚举的值应单独使用。

枚举值
e_PageViewEventTypeAdded | 事件类型：页面视图添加后。
e_PageViewEventTypeRemoved | 事件类型：页面视图移除后。
e_PageViewEventTypeAllRemoved | 事件类型：所有页面视图被移除。

## ◆ PrintOption

enum foxit.addon.xfa.DocProviderCallback.PrintOption
| strong

XFA 打印选项的枚举。

此枚举的值应单独使用。

枚举值
e_PrintOptionShowDialog | 如果设置，显示打印对话框。
e_PrintOptionCanCancel | 如果设置，表示打印过程可以取消。
e_PrintOptionShrinkPage | 如果设置，缩小页面以适应内容区域。
e_PrintOptionAsImage | 如果设置，以图像方式打印页面；否则，以文本方式打印。
e_PrintOptionPrintAnnot | 如果设置，打印注释。

## ◆ SubmitFormat

enum foxit.addon.xfa.DocProviderCallback.SubmitFormat
| strong

XFA 提交格式的枚举。

此枚举的值应单独使用。

枚举值
e_SubmitInXDP | 提交数据按 XDP 格式打包，如 XDP 规范中所述。
e_SubmitInPDF | 提交数据按 PDF 格式打包，如 PDF 参考中所述。
e_SubmitInUrlEncoded | 提交数据按 URL 编码格式打包，如统一资源定位符 (URL) 中所述。
e_SubmitInXFD | 提交数据按 XFD 格式打包，如 XFDF 中所述。
e_SubmitInXML | 提交数据被翻译并打包为 URL 编码格式。

## ◆ TextEncoding

enum foxit.addon.xfa.DocProviderCallback.TextEncoding
| strong

XFA 提交的文本编码枚举。

此枚举的值应单独使用。

枚举值
e_TextEncodingNone | 无文本编码。
e_TextEncodingBig5 | 文本编码：Big5。
e_TextEncodingFontSpecific | 文本编码：字体特定。
e_TextEncodingGBK | 文本编码：GBK。
e_TextEncodingGB18030 | 文本编码：GB18030。
e_TextEncodingGB2312 | 文本编码：GB2312。
e_TextEncodingISO8859NN | 文本编码：ISO8859NN。
e_TextEncodingKSC5601 | 文本编码：KSC5601。
e_TextEncodingShiftJIS | 文本编码：ShiftJIS。
e_TextEncodingUCS2 | 文本编码：UCS-2。
e_TextEncodingUTF16 | 文本编码：UTF-16。
e_TextEncodingUTF8 | 文本编码：UTF-8。

## ◆ WidgetEventType

enum foxit.addon.xfa.DocProviderCallback.WidgetEventType
| strong

XFA 控件事件类型的枚举。

此枚举的值应单独使用。

枚举值
e_WidgetEventTypeAdded | 事件类型：XFA 控件添加后。
e_WidgetEventTypeBeforeRemoved | 事件类型：XFA 控件移除前。

## 成员函数说明

## ◆ DisplayCaret()

void foxit.addon.xfa.DocProviderCallback.DisplayCaret | ( | int | page_index,
|  | bool | is_visible,
|  | RectF | rect
| ) |  |
| inline virtual

用于显示或隐藏光标的回调函数。

参数

  [in] | page_index | 页面的索引。
  [in] | is_visible | 用于决定光标是否可见：true 表示可见， false 表示不可见。
  [in] | rect | 矩形。

返回
  无。

## ◆ ExportData()

void foxit.addon.xfa.DocProviderCallback.ExportData | ( | XFADoc | doc,
|  | string | file_path
| ) |  |
| inline virtual

用于将数据导出到文件的回调函数。

参数

  [in] | doc | 当前 XFA 文档。
  [in] | file_path | 数据应导出到的文件路径。 如果这是空字符串，用户应指定一个路径作为导出文件路径。 在这种情况下，应用程序可以显示对话框让用户手动选择文件。

返回
  无。

## ◆ GetCurrentPage()

int foxit.addon.xfa.DocProviderCallback.GetCurrentPage | ( | XFADoc | doc | ) |
| inline virtual

用于获取当前页面索引的回调函数。

参数

  [in] | doc | 当前 XFA 文档。

返回
  当前页面的索引。

## ◆ GetHighlightColor()

uint foxit.addon.xfa.DocProviderCallback.GetHighlightColor | ( | XFADoc | doc | ) |
| inline virtual

用于获取高亮颜色的回调函数。

参数

  [in] | doc | 当前 XFA 文档。

返回
  高亮颜色。

## ◆ GetPopupPos()

bool foxit.addon.xfa.DocProviderCallback.GetPopupPos | ( | int | page_index,
|  | float | min_popup,
|  | float | max_popup,
|  | RectF | rect_widget,
|  | RectF | inout_rect_popup
| ) |  |
| inline virtual

用于获取弹出位置的回调函数。

参数

  [in] | page_index | 页面的索引。
  [in] | min_popup | 下拉框的最小高度。
  [in] | max_popup | 下拉框的最大高度。
  [in] | rect_widget | 当前控件的矩形。
  [in,out] | inout_rect_popup | 矩形。当调用此函数时，这用作输入参数， 指定下拉框的宽度。 当此函数返回时，这用作输出参数，接收 下拉框的高度。

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

## ◆ GetTitle()

string foxit.addon.xfa.DocProviderCallback.GetTitle | ( | XFADoc | doc | ) |
| inline virtual

用于获取当前 XFA 文档标题的回调函数。

参数

  [in] | doc | 当前 XFA 文档。

返回
  标题。

## ◆ GotoURL()

void foxit.addon.xfa.DocProviderCallback.GotoURL | ( | XFADoc | doc,
|  | string | url
| ) |  |
| inline virtual

用于转到指定 URL 的回调函数。

参数

  [in] | doc | 当前 XFA 文档。
  [in] | url | URL 字符串。

返回
  无。

## ◆ ImportData()

void foxit.addon.xfa.DocProviderCallback.ImportData | ( | XFADoc | doc,
|  | string | file_path
| ) |  |
| inline virtual

用于从文件导入数据的回调函数。

参数

  [in] | doc | 当前 XFA 文档。
  [in] | file_path | 数据将从中导入的文件路径。 如果这是空字符串，用户应指定一个路径作为导入文件路径。 在这种情况下，应用程序可以显示对话框让用户手动选择文件。

返回
  无。

## ◆ InvalidateRect()

void foxit.addon.xfa.DocProviderCallback.InvalidateRect | ( | int | page_index,
|  | RectF | rect,
|  | DocProviderCallback.InvalidateFlag | flag
| ) |  |
| inline virtual

用于根据标志无效化矩形的回调函数。

此回调函数将在动态 XFA 文档中使用。

参数

  [in] | page_index | 页面的索引。
  [in] | rect | 要无效化的矩形。
  [in] | flag | 无效化标志。请参考从 foxit.addon.xfa.DocProviderCallback.InvalidateFlag.e_InvalidateFlagAllPages 开始的值，这将是这些值之一。

返回
  无。

## ◆ NotifyWidgetChangeInfo()

void foxit.addon.xfa.DocProviderCallback.NotifyWidgetChangeInfo | ( | XFADoc | doc,
|  | XFAWidgetModifyInfo | change_info
| ) |  |
| inline virtual

用于通知XFA 控件值的变化的回调函数。

参数

  [in] | doc | 当前的XFA文档。
  [in] | change_info | XFA控件信息改变。

返回
  无。

## ◆ PageViewEvent()

void foxit.addon.xfa.DocProviderCallback.PageViewEvent | ( | int | page_index,
|  | DocProviderCallback.PageViewEventType | page_view_event_type
| ) |  |
| inline virtual

用于执行页面视图事件的回调函数。

参数

  [in] | page_index | 页面索引。
  [in] | page_view_event_type | 页面视图事件类型。请参考从 foxit.addon.xfa.DocProviderCallback.PageViewEventType.e_PageViewEventTypeAdded 开始的值，这将是 这些值之一。

返回
  无。

## ◆ PopupMenu()

bool foxit.addon.xfa.DocProviderCallback.PopupMenu | ( | int | page_index,
|  | PointF | rect_popup
| ) |  |
| inline virtual

用于弹出上下文菜单的回调函数。

参数

  [in] | page_index | 页面的索引。
  [in] | rect_popup | 弹出菜单的矩形位置。

返回
  true 表示成功，否则表示失败。

## ◆ Print()

void foxit.addon.xfa.DocProviderCallback.Print | ( | XFADoc | doc,
|  | int | start_page_index,
|  | int | end_page_index,
|  | int | options
| ) |  |
| inline virtual

用于打印的回调函数。

参数

  [in] | doc | 当前 XFA 文档。
  [in] | start_page_index | 起始页面的索引。
  [in] | end_page_index | 结束页面的索引。
  [in] | options | 打印选项。请参考从 foxit.addon.xfa.DocProviderCallback.PrintOption.e_PrintOptionShowDialog 开始的值，这将是这些值之一或这些值的组合。

返回
  无。

## ◆ Release()

void foxit.addon.xfa.DocProviderCallback.Release | ( |  | ) |
| inline virtual

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

返回
  无。

## ◆ SetChangeMark()

void foxit.addon.xfa.DocProviderCallback.SetChangeMark | ( | XFADoc | doc | ) |
| inline virtual

用于为当前 XFA 文档设置更改标记标志的回调函数。

参数

  [in] | doc | 当前 XFA 文档。

返回
  无。

## ◆ SetCurrentPage()

void foxit.addon.xfa.DocProviderCallback.SetCurrentPage | ( | XFADoc | doc,
|  | int | current_page_index
| ) |  |
| inline virtual

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

参数

  [in] | doc | 当前 XFA 文档。
  [in] | current_page_index | 要设置的索引。

返回
  无。

## ◆ SetFocus()

void foxit.addon.xfa.DocProviderCallback.SetFocus | ( | XFAWidget | xfa_widget,
|  | bool | is_relayout
| ) |  |
| inline virtual

用于设置焦点控件的回调函数。

参数

  [in] | xfa_widget | 要设置焦点的 XFA 控件。
  [in] | is_relayout | true 表示布局已更改， false 表示布局未更改。

返回
  无。

## ◆ SubmitData()

bool foxit.addon.xfa.DocProviderCallback.SubmitData | ( | XFADoc | doc,
|  | string | target,
|  | DocProviderCallback.SubmitFormat | format,
|  | DocProviderCallback.TextEncoding | text_encoding,
|  | string | content
| ) |  |
| inline virtual

用于提交数据的回调函数。

参数

  [in] | doc | 当前 XFA 文档。
  [in] | target | 表示要提交数据的目标的字符串。
  [in] | format | 要提交数据的格式。请参考从 foxit.addon.xfa.DocProviderCallback.SubmitFormat.e_SubmitInXDP 开始的值，这将是这些值之一。
  [in] | text_encoding | 要提交数据的文本编码。请参考从 foxit.addon.xfa.DocProviderCallback.TextEncoding.e_TextEncodingNone 开始的值，这将是这些值之一。
  [in] | content | 要提交数据的内容。

返回
  true 表示成功，否则表示失败。

## ◆ WidgetEvent()

void foxit.addon.xfa.DocProviderCallback.WidgetEvent | ( | XFAWidget | xfa_widget,
|  | DocProviderCallback.WidgetEventType | widget_event_type
| ) |  |
| inline virtual

用于执行 XFA 控件事件的回调函数。

参数

  [in] | xfa_widget | 发送事件的 XFA 控件。
  [in] | widget_event_type | 控件事件类型。请参考从 foxit.addon.xfa.DocProviderCallback.WidgetEventType.e_WidgetEventTypeAdded 开始的值， 这将是这些值之一。

返回
  无。