Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
FoxitPDFSDKPython3.DocProviderCallback类 参考

继承自 FoxitPDFSDKPython3._object .

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

## 静态 Public 属性
| e_InvalidateFlagAllPages = _fsdk.DocProviderCallback_e_InvalidateFlagAllPages
| 无效化所有页面。
| e_InvalidateFlagCurrentPage = _fsdk.DocProviderCallback_e_InvalidateFlagCurrentPage
| 无效化当前页面。
| e_PageViewEventTypeAdded = _fsdk.DocProviderCallback_e_PageViewEventTypeAdded
| 事件类型：页面视图添加后。
| e_PageViewEventTypeAllRemoved = _fsdk.DocProviderCallback_e_PageViewEventTypeAllRemoved
| 事件类型：所有页面视图被移除。
| e_PageViewEventTypeRemoved = _fsdk.DocProviderCallback_e_PageViewEventTypeRemoved
| 事件类型：页面视图移除后。
| e_PrintOptionAsImage = _fsdk.DocProviderCallback_e_PrintOptionAsImage
| 如果设置，以图像方式打印页面；否则，以文本方式打印。
| e_PrintOptionCanCancel = _fsdk.DocProviderCallback_e_PrintOptionCanCancel
| 如果设置，表示打印过程可以取消。
| e_PrintOptionPrintAnnot = _fsdk.DocProviderCallback_e_PrintOptionPrintAnnot
| 如果设置，打印注释。
| e_PrintOptionShowDialog = _fsdk.DocProviderCallback_e_PrintOptionShowDialog
| 如果设置，显示打印对话框。
| e_PrintOptionShrinkPage = _fsdk.DocProviderCallback_e_PrintOptionShrinkPage
| 如果设置，缩小页面以适应内容区域。
| e_SubmitInPDF = _fsdk.DocProviderCallback_e_SubmitInPDF
| 提交数据按 PDF 格式打包，如 PDF 参考中所述。
| e_SubmitInUrlEncoded = _fsdk.DocProviderCallback_e_SubmitInUrlEncoded
| 提交数据按 URL 编码格式打包，如统一资源定位符 (URL) 中所述。
| e_SubmitInXDP = _fsdk.DocProviderCallback_e_SubmitInXDP
| 提交数据按 XDP 格式打包，如 XDP 规范中所述。
| e_SubmitInXFD = _fsdk.DocProviderCallback_e_SubmitInXFD
| 提交数据按 XFD 格式打包，如 XFDF 中所述。
| e_SubmitInXML = _fsdk.DocProviderCallback_e_SubmitInXML
| 提交数据被翻译并打包为 URL 编码格式。
| e_TextEncodingBig5 = _fsdk.DocProviderCallback_e_TextEncodingBig5
| 文本编码：Big5。
| e_TextEncodingFontSpecific = _fsdk.DocProviderCallback_e_TextEncodingFontSpecific
| 文本编码：字体特定。
| e_TextEncodingGB18030 = _fsdk.DocProviderCallback_e_TextEncodingGB18030
| 文本编码：GB18030。
| e_TextEncodingGB2312 = _fsdk.DocProviderCallback_e_TextEncodingGB2312
| 文本编码：GB2312。
| e_TextEncodingGBK = _fsdk.DocProviderCallback_e_TextEncodingGBK
| 文本编码：GBK。
| e_TextEncodingISO8859NN = _fsdk.DocProviderCallback_e_TextEncodingISO8859NN
| 文本编码：ISO8859NN。
| e_TextEncodingKSC5601 = _fsdk.DocProviderCallback_e_TextEncodingKSC5601
| 文本编码：KSC5601。
| e_TextEncodingNone = _fsdk.DocProviderCallback_e_TextEncodingNone
| 无文本编码。
| e_TextEncodingShiftJIS = _fsdk.DocProviderCallback_e_TextEncodingShiftJIS
| 文本编码：ShiftJIS。
| e_TextEncodingUCS2 = _fsdk.DocProviderCallback_e_TextEncodingUCS2
| 文本编码：UCS-2。
| e_TextEncodingUTF16 = _fsdk.DocProviderCallback_e_TextEncodingUTF16
| 文本编码：UTF-16。
| e_TextEncodingUTF8 = _fsdk.DocProviderCallback_e_TextEncodingUTF8
| 文本编码：UTF-8。
| e_WidgetEventTypeAdded = _fsdk.DocProviderCallback_e_WidgetEventTypeAdded
| 事件类型：XFA 控件添加后。
| e_WidgetEventTypeBeforeRemoved = _fsdk.DocProviderCallback_e_WidgetEventTypeBeforeRemoved
| 事件类型：XFA 控件移除前。

## 详细描述

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

## 成员函数说明

## ◆ DisplayCaret()

def FoxitPDFSDKPython3.DocProviderCallback.DisplayCaret | ( |  | page_index,
|  |  | is_visible,
|  |  | rect
| ) |  |

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

参数

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

返回
  无。

## ◆ ExportData()

def FoxitPDFSDKPython3.DocProviderCallback.ExportData | ( |  | doc,
|  |  | file_path
| ) |  |

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

参数

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

返回
  无。

## ◆ GetCurrentPage()

def FoxitPDFSDKPython3.DocProviderCallback.GetCurrentPage | ( |  | doc | ) |

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

参数

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

返回
  当前页面的索引。

## ◆ GetHighlightColor()

def FoxitPDFSDKPython3.DocProviderCallback.GetHighlightColor | ( |  | doc | ) |

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

参数

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

返回
  高亮颜色。

## ◆ GetPopupPos()

def FoxitPDFSDKPython3.DocProviderCallback.GetPopupPos | ( |  | page_index,
|  |  | min_popup,
|  |  | max_popup,
|  |  | rect_widget,
|  |  | inout_rect_popup
| ) |  |

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

参数

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

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

## ◆ GetTitle()

def FoxitPDFSDKPython3.DocProviderCallback.GetTitle | ( |  | doc | ) |

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

参数

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

返回
  标题。

## ◆ GotoURL()

def FoxitPDFSDKPython3.DocProviderCallback.GotoURL | ( |  | doc,
|  |  | url
| ) |  |

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

参数

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

返回
  无。

## ◆ ImportData()

def FoxitPDFSDKPython3.DocProviderCallback.ImportData | ( |  | doc,
|  |  | file_path
| ) |  |

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

参数

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

返回
  无。

## ◆ InvalidateRect()

def FoxitPDFSDKPython3.DocProviderCallback.InvalidateRect | ( |  | page_index,
|  |  | rect,
|  |  | flag
| ) |  |

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

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

参数

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

返回
  无。

## ◆ NotifyWidgetChangeInfo()

def FoxitPDFSDKPython3.DocProviderCallback.NotifyWidgetChangeInfo | ( |  | doc,
|  |  | change_info
| ) |  |

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

参数

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

返回
  无。

## ◆ PageViewEvent()

def FoxitPDFSDKPython3.DocProviderCallback.PageViewEvent | ( |  | page_index,
|  |  | page_view_event_type
| ) |  |

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

参数

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

返回
  无。

## ◆ PopupMenu()

def FoxitPDFSDKPython3.DocProviderCallback.PopupMenu | ( |  | page_index,
|  |  | rect_popup
| ) |  |

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

参数

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

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

## ◆ Print()

def FoxitPDFSDKPython3.DocProviderCallback.Print | ( |  | doc,
|  |  | start_page_index,
|  |  | end_page_index,
|  |  | options
| ) |  |

用于打印的回调函数。

参数

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

返回
  无。

## ◆ Release()

def FoxitPDFSDKPython3.DocProviderCallback.Release | ( |  | ) |

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

返回
  无。

## ◆ SetChangeMark()

def FoxitPDFSDKPython3.DocProviderCallback.SetChangeMark | ( |  | doc | ) |

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

参数

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

返回
  无。

## ◆ SetCurrentPage()

def FoxitPDFSDKPython3.DocProviderCallback.SetCurrentPage | ( |  | doc,
|  |  | current_page_index
| ) |  |

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

参数

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

返回
  无。

## ◆ SetFocus()

def FoxitPDFSDKPython3.DocProviderCallback.SetFocus | ( |  | xfa_widget,
|  |  | is_relayout
| ) |  |

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

参数

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

返回
  无。

## ◆ SubmitData()

def FoxitPDFSDKPython3.DocProviderCallback.SubmitData | ( |  | doc,
|  |  | target,
|  |  | format,
|  |  | text_encoding,
|  |  | content
| ) |  |

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

参数

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

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

## ◆ WidgetEvent()

def FoxitPDFSDKPython3.DocProviderCallback.WidgetEvent | ( |  | xfa_widget,
|  |  | widget_event_type
| ) |  |

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

参数

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

返回
  无。