Foxit PDF SDK

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

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

## 静态 Public 属性
static | e_InvalidateFlagAllPages
| XFA 失效标志的枚举。 更多...
static | e_InvalidateFlagCurrentPage
| 使当前页面失效。
static | e_PageViewEventTypeAdded
| 页面视图的事件类型枚举。 更多...
static | e_PageViewEventTypeAllRemoved
| 事件类型：删除所有页面视图。
static | e_PageViewEventTypeRemoved
| 事件类型：在删除页面视图后。
static | e_PrintOptionAsImage
| 如果设置，将页面作为图像打印；否则，作为文本打印。
static | e_PrintOptionCanCancel
| 如果设置，表示打印过程可以被取消。
static | e_PrintOptionPrintAnnot
| 如果设置，打印注释。
static | e_PrintOptionReverseOrder
| 如果设置，以相反顺序打印页面；否则，以正常顺序打印。
static | e_PrintOptionShowDialog
| XFA 打印选项的枚举。 更多...
static | e_PrintOptionShrinkPage
| 如果设置，收缩页面以适应内容区域。
static | e_SubmitInPDF
| 提交数据以 PDF 格式打包，如 PDF 参考中所述。
static | e_SubmitInUrlEncoded
| 提交数据以 URL 编码格式打包，如统一资源定位符 (URL) 中所述。
static | e_SubmitInXDP
| XFA 提交格式的枚举。 更多...
static | e_SubmitInXFD
| 提交数据以 XFD 格式打包，如 XFDF 中所述。
static | e_SubmitInXML
| 提交数据被翻译并打包为 URL 编码格式。
static | e_TextEncodingBig5
| 文本编码：Big5。
static | e_TextEncodingFontSpecific
| 文本编码：字体特定。
static | e_TextEncodingGB18030
| 文本编码：GB18030。
static | e_TextEncodingGB2312
| 文本编码：GB2312。
static | e_TextEncodingGBK
| 文本编码：GBK。
static | e_TextEncodingISO8859NN
| 文本编码：ISO8859NN。
static | e_TextEncodingKSC5601
| 文本编码：KSC5601。
static | e_TextEncodingNone
| XFA 提交的文本编码枚举。 更多...
static | e_TextEncodingShiftJIS
| 文本编码：ShiftJIS。
static | e_TextEncodingUCS2
| 文本编码：UCS-2。
static | e_TextEncodingUTF16
| 文本编码：UTF-16。
static | e_TextEncodingUTF8
| 文本编码：UTF-8。
static | e_WidgetEventTypeAdded
| XFA 小部件事件的类型枚举。 更多...
static | e_WidgetEventTypeBeforeRemoved
| 事件类型：在删除 XFA 小部件之前。

## 详细描述

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

## 成员函数说明

## ◆ DisplayCaret()

FSDK::DocProviderCallback::DisplayCaret | ( | page_index | ,
|  | is_visible | ,
|  | rect |
| ) |  |

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

参数

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

返回
  无。

## ◆ ExportData()

FSDK::DocProviderCallback::ExportData | ( | doc | ,
|  | file_path |
| ) |  |

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

参数

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

返回
  无。

## ◆ GetCurrentPage()

FSDK::DocProviderCallback::GetCurrentPage | ( |  | doc | ) |

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

参数

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

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

参数

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

返回
  无。

## ◆ GetHighlightColor()

FSDK::DocProviderCallback::GetHighlightColor | ( | doc |  | ) |

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

参数

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

返回
  高亮颜色。

## ◆ GetPopupPos()

FSDK::DocProviderCallback::GetPopupPos | ( | page_index | ,
|  | min_popup | ,
|  | max_popup | ,
|  | rect_widget | ,
|  | inout_rect_popupconst |
| ) |  |

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

参数

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

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

## ◆ GotoURL()

FSDK::DocProviderCallback::GotoURL | ( | doc | ,
|  | url |
| ) |  |

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

参数

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

返回
  无。

## ◆ InvalidateRect()

FSDK::DocProviderCallback::InvalidateRect | ( | page_index | ,
|  | rect | ,
|  | flag |
| ) |  |

用于根据标志使矩形区域失效的回调函数。

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

参数

  [in] | page_index | 页面索引。
  [in] | rect | 要使其失效的矩形。
  [in] | flag | 失效标志。请参阅从 FSDK.DocProviderCallback.e_InvalidateFlagAllPages 开始的值，并且该值应为这些值之一。

返回
  无。

## ◆ mportData()

FSDK::DocProviderCallback::mportData | ( | doc | ,
|  | file_path |
| ) |  |

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

参数

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

返回
  无。

## ◆ NotifyWidgetChangeInfo()

FSDK::DocProviderCallback::NotifyWidgetChangeInfo | ( | doc | ,
|  | change_info |
| ) |  |

用于通知 XFA 小部件更改信息的回调函数。

参数

  [in] | doc | 当前 XFA 文档。
  [in] | change_info | XFA 小部件更改信息。

返回
  无。

## ◆ PageViewEvent()

FSDK::DocProviderCallback::PageViewEvent | ( | page_index | ,
|  | page_view_event_type |
| ) |  |

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

参数

  [in] | page_index | 页面索引。
  [in] | page_view_event_type | 页面视图事件类型。请参阅从 FSDK.DocProviderCallback.e_PageViewEventTypeAdded 开始的值，并且该值应为 这些值之一。

返回
  无。

## ◆ PopupMenu()

FSDK::DocProviderCallback::PopupMenu | ( | page_index | ,
|  | rect_popup |
| ) |  |

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

参数

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

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

## ◆ Print()

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.DocProviderCallback.e_PrintOptionShowDialog 开始的值，并且该值应为这些值之一或这些值的组合。

返回
  无。

## ◆ Release()

FSDK::DocProviderCallback::Release | ( |  | ) |

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

返回
  无。

## ◆ SetChangeMark()

current_page_index FSDK::DocProviderCallback::SetChangeMark | ( | doc |  | ) |

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

参数

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

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

参数

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

返回
  标题。

## ◆ SetFocus()

FSDK::DocProviderCallback::SetFocus | ( | xfa_widget | ,
|  | is_relyaout |
| ) |  |

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

参数

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

返回
  无。

## ◆ SubmitData()

FSDK::DocProviderCallback::SubmitData | ( | doc | ,
|  | target | ,
|  | format | ,
|  | text_encoding | ,
|  | content |
| ) |  |

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

参数

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

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

## ◆ WidgetEvent()

FSDK::DocProviderCallback::WidgetEvent | ( | xfa_widget | ,
|  | widget_event_type |
| ) |  |

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

参数

  [in] | xfa_widget | 发送事件的 XFA 小部件。
  [in] | widget_event_type | 小部件事件类型。请参阅从 FSDK.DocProviderCallback.e_WidgetEventTypeAdded 开始的值，并且该值应为 这些值之一。

返回
  无。

## 类成员变量说明

## ◆ e_InvalidateFlagAllPages

FSDK::DocProviderCallback::e_InvalidateFlagAllPages
| static

XFA 失效标志的枚举。

此枚举的值应单独使用。使所有页面失效。

## ◆ e_PageViewEventTypeAdded

FSDK::DocProviderCallback::e_PageViewEventTypeAdded
| static

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

此枚举的值应单独使用。事件类型：在添加页面视图后。

## ◆ e_PrintOptionShowDialog

FSDK::DocProviderCallback::e_PrintOptionShowDialog
| static

XFA 打印选项的枚举。

此枚举的值应单独使用。如果设置，显示打印对话框。

## ◆ e_SubmitInXDP

FSDK::DocProviderCallback::e_SubmitInXDP
| static

XFA 提交格式的枚举。

此枚举的值应单独使用。提交数据以 XDP 格式打包，如 XDP 规范中所述。

## ◆ e_TextEncodingNone

FSDK::DocProviderCallback::e_TextEncodingNone
| static

XFA 提交的文本编码枚举。

此枚举的值应单独使用。无文本编码。

## ◆ e_WidgetEventTypeAdded

FSDK::DocProviderCallback::e_WidgetEventTypeAdded
| static

XFA 小部件事件的类型枚举。

此枚举的值应单独使用。事件类型：在添加 XFA 小部件后。