Foxit PDF SDK
fsdk.DocProviderCallback类 参考

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 控件事件的回调函数。 更多...
 

详细描述

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

成员函数说明

◆ DisplayCaret()

def fsdk.DocProviderCallback.DisplayCaret (   page_index,
  is_visible,
  rect 
)

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

参数
[in]page_index页面的索引。
[in]is_visible用于决定光标是否可见:true 表示可见, false 表示不可见。
[in]rect矩形。
返回
无。

◆ ExportData()

def fsdk.DocProviderCallback.ExportData (   doc,
  file_path 
)

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

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

◆ GetCurrentPage()

def fsdk.DocProviderCallback.GetCurrentPage (   doc)

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

参数
[in]doc当前 XFA 文档。
返回
当前页面的索引。

◆ GetHighlightColor()

def fsdk.DocProviderCallback.GetHighlightColor (   doc)

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

参数
[in]doc当前 XFA 文档。
返回
高亮颜色。

◆ GetPopupPos()

def fsdk.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 fsdk.DocProviderCallback.GetTitle (   doc)

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

参数
[in]doc当前 XFA 文档。
返回
标题。

◆ GotoURL()

def fsdk.DocProviderCallback.GotoURL (   doc,
  url 
)

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

参数
[in]doc当前 XFA 文档。
[in]urlURL 字符串。
返回
无。

◆ ImportData()

def fsdk.DocProviderCallback.ImportData (   doc,
  file_path 
)

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

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

◆ InvalidateRect()

def fsdk.DocProviderCallback.InvalidateRect (   page_index,
  rect,
  flag 
)

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

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

参数
[in]page_index页面的索引。
[in]rect要无效化的矩形。
[in]flag无效化标志。请参考从 fsdk.DocProviderCallbackE_InvalidateFlagAllPages 开始的值,这将是这些值之一。
返回
无。

◆ NotifyWidgetChangeInfo()

def fsdk.DocProviderCallback.NotifyWidgetChangeInfo (   doc,
  change_info 
)

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

参数
[in]doc当前的XFA文档。
[in]change_infoXFA控件信息改变。
返回
无。

◆ PageViewEvent()

def fsdk.DocProviderCallback.PageViewEvent (   page_index,
  page_view_event_type 
)

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

参数
[in]page_index页面索引。
[in]page_view_event_type页面视图事件类型。请参考从 fsdk.DocProviderCallbackE_PageViewEventTypeAdded 开始的值,这将是 这些值之一。
返回
无。

◆ PopupMenu()

def fsdk.DocProviderCallback.PopupMenu (   page_index,
  rect_popup 
)

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

参数
[in]page_index页面的索引。
[in]rect_popup弹出菜单的矩形位置。
返回
true 表示成功,否则表示失败。

◆ Print()

def fsdk.DocProviderCallback.Print (   doc,
  start_page_index,
  end_page_index,
  options 
)

用于打印的回调函数。

参数
[in]doc当前 XFA 文档。
[in]start_page_index起始页面的索引。
[in]end_page_index结束页面的索引。
[in]options打印选项。请参考从 fsdk.DocProviderCallbackE_PrintOptionShowDialog 开始的值,这将是这些值之一或这些值的组合。
返回
无。

◆ Release()

def fsdk.DocProviderCallback.Release ( )

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

返回
无。

◆ SetChangeMark()

def fsdk.DocProviderCallback.SetChangeMark (   doc)

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

参数
[in]doc当前 XFA 文档。
返回
无。

◆ SetCurrentPage()

def fsdk.DocProviderCallback.SetCurrentPage (   doc,
  current_page_index 
)

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

参数
[in]doc当前 XFA 文档。
[in]current_page_index要设置的索引。
返回
无。

◆ SetFocus()

def fsdk.DocProviderCallback.SetFocus (   xfa_widget,
  is_relayout 
)

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

参数
[in]xfa_widget要设置焦点的 XFA 控件。
[in]is_relayouttrue 表示布局已更改, false 表示布局未更改。
返回
无。

◆ SubmitData()

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

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

参数
[in]doc当前 XFA 文档。
[in]target表示要提交数据的目标的字符串。
[in]format要提交数据的格式。请参考从 fsdk.DocProviderCallbackE_SubmitInXDP 开始的值,这将是这些值之一。
[in]text_encoding要提交数据的文本编码。请参考从 fsdk.DocProviderCallbackE_TextEncodingNone 开始的值,这将是这些值之一。
[in]content要提交数据的内容。
返回
true 表示成功,否则表示失败。

◆ WidgetEvent()

def fsdk.DocProviderCallback.WidgetEvent (   xfa_widget,
  widget_event_type 
)

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

参数
[in]xfa_widget发送事件的 XFA 控件。
[in]widget_event_type控件事件类型。请参考从 fsdk.DocProviderCallbackE_WidgetEventTypeAdded 开始的值, 这将是这些值之一。
返回
无。