foxit.addon.xfa.XFADoc类 参考
类 foxit.addon.xfa.XFADoc 继承关系图:
Public 成员函数 | |
| XFADoc (PDFDoc document, DocProviderCallback xfa_doc_provider_handler) | |
| 构造函数。 更多... | |
| XFADoc (PDFDoc document) | |
| 构造函数。 更多... | |
| XFADoc (XFADoc other) | |
| 构造函数，使用另一个 XFA 文档对象。 更多... | |
| bool | ExportData (string output_file_path, XFADoc.ExportDataType export_type) |
| 将数据导出到文件。 更多... | |
| bool | ExportData (FileWriterCallback stream, XFADoc.ExportDataType export_type) |
| 将数据导出到 foxit.common.fxcrt.FileWriterCallback 对象。 更多... | |
| void | FlattenTo (string output_file_path) |
| 将当前 XFA 文档扁平化到文件。 更多... | |
| void | FlattenTo (StreamCallback stream) |
| 将当前 XFA 文档扁平化到文件流。 更多... | |
| XFAPage | GetPage (int page_index) |
| 按索引获取 XFA 页面。 更多... | |
| int | GetPageCount () |
| 获取 XFA 页面数量。 更多... | |
| XFADoc.Type | GetType () |
| 获取 XFA 文档类型。 更多... | |
| XFAWidget | GetWidgetByFullName (string full_name) |
| 获取与指定全名匹配的 XFA 控件。 更多... | |
| bool | ImportData (string file_path) |
| 从 XML 或 XDP 文件导入数据。 更多... | |
| bool | ImportData (FileReaderCallback file_reader) |
| 从 foxit.common.fxcrt.FileReaderCallback 对象导入数据。 更多... | |
| bool | IsEmpty () |
| 检查当前对象是否为空。 更多... | |
| void | KillFocus () |
| 取消 XFA 控件的焦点。 更多... | |
| void | ProcessEvent (XFADoc.EventType event_type) |
| 为当前 XFA 文档中的所有 XFA 控件处理某种事件。 更多... | |
| void | ResetForm () |
| 重置表单。 更多... | |
| void | SetDocProviderCallback (DocProviderCallback doc_provider_callback) |
| 设置 XFA 文档提供程序回调。 更多... | |
| void | SetFocus (XFAWidget xfa_widget) |
| 设置 XFA 控件的焦点。 更多... | |
| void | SetPDFPath (string pdf_file_path) |
| 设置相关 PDF 文档的路径。 更多... | |
| Progressive | StartLoad (PauseCallback pause) |
| 开始为当前 XFA 文档加载内容。 更多... | |
详细描述
类 XFADoc 从已加载的 PDF 文档对象构造，以便更清晰地访问 XFA 内容。 用户必须在使用 XFA 模块之前调用 common.Library.RegisterXFAAppProviderCallback 。 对于新构造的 XFA 对象，请记住在使用 XFA 类中的其他函数之前调用函数 XFADoc.StartLoad 。
要在 XFA 文档中搜索，请使用 XFADoc 对象构造 foxit.pdf.TextSearch 对象。
成员枚举类型说明
◆ EventType
|
strong |
XFA 事件类型的枚举。
此枚举的值应单独使用。
◆ ExportDataType
|
strong |
◆ Type
|
strong |
构造及析构函数说明
◆ XFADoc() [1/3]
|
inline |
构造函数。
- 参数
-
[in] document 有效的 PDF 文档。它应该已经成功加载。 [in] xfa_doc_provider_handler 由用户实现的 XFA 文档提供程序回调对象， 基于回调类 DocProviderCallback 。它不应该为 null。用户应确保此回调对象在 相关 PDF 文档释放之前保持有效。
- 注解
- 如果在函数 common.Library.Initialize 中使用的许可信息中未定义模块"XFA"， 这意味着用户无权使用 XFA 相关函数，此构造函数将抛出异常 foxit.common.ErrorCode.e_ErrNoXFAModuleRight 。
◆ XFADoc() [2/3]
|
inline |
构造函数。
当通过此构造函数成功构造 XFADoc 时，用户必须通过函数 XFADoc.SetDocProviderCallback 设置 XFA 文档提供程序回调。
- 参数
-
[in] document A valid PDF document. It should has been loaded successfully.
- 注解
- 如果在函数 common.Library.Initialize 中使用的许可信息中未定义模块"XFA"， 这意味着用户无权使用 XFA 相关函数，此构造函数将抛出异常 foxit.common.ErrorCode.e_ErrNoXFAModuleRight 。
◆ XFADoc() [3/3]
|
inline |
构造函数，使用另一个 XFA 文档对象。
- 参数
-
[in] other 另一个 XFA 文档对象。
成员函数说明
◆ ExportData() [1/2]
|
inline |
将数据导出到文件。
- 参数
-
[in] output_file_path 数据将导出到的文件路径。 [in] export_type 导出类型。请参考从 foxit.addon.xfa.XFADoc.ExportDataType.e_ExportDataTypeXML 开始的值，这应该是这些值之一。
- 返回
- true 表示成功，false 表示失败。
◆ ExportData() [2/2]
|
inline |
将数据导出到 foxit.common.fxcrt.FileWriterCallback 对象。
- 参数
-
[in] stream 由用户实现的 foxit::common::file::WriterCallback 对象，用于保存导出的数据。 [in] export_type 导出类型。请参考从 foxit.addon.xfa.XFADoc.ExportDataType.e_ExportDataTypeXML 开始的值，这应该是这些值之一。
- 返回
- true 表示成功，false 表示失败。
◆ FlattenTo() [1/2]
|
inline |
将当前 XFA 文档扁平化到文件。
- 参数
-
[in] output_file_path 扁平化结果将保存到的文件路径。
- 返回
- 无。
◆ FlattenTo() [2/2]
|
inline |
◆ GetPage()
|
inline |
按索引获取 XFA 页面。
- 参数
-
[in] page_index 页面索引。有效范围：从 0 到 (count-1)。 count 由函数 XFADoc.GetPageCount 返回。
- 返回
- XFA 页面。
◆ GetPageCount()
|
inline |
获取 XFA 页面数量。
- 返回
- 页面数量。
◆ GetType()
|
inline |
获取 XFA 文档类型。
- 返回
- XFA 文档的类型。请参考从 foxit.addon.xfa.XFADoc.Type.e_Dynamic 开始的值， 这将是这些值之一。
◆ GetWidgetByFullName()
|
inline |
获取与指定全名匹配的 XFA 控件。
某些 XFA 控件可能跨越多个 XFA 页面。在这种情况下，此函数只能用于 获取 XFA 文档中第一个匹配的 XFA 控件。用户也可以使用函数 XFAPage.GetWidgetByFullName 来获取 XFA 页面中匹配的 XFA 控件。
- 参数
-
[in] full_name XFA 控件的全名。它不应该是空字符串。 XFA 控件的全名可以通过函数 XFAWidget.GetName 使用类型 foxit.addon.xfa.XFAWidget.WidgetNameType.e_WidgetNameTypeFullName 在之前的过程中检索。
- 返回
- XFA 控件对象。
◆ ImportData() [1/2]
|
inline |
从 XML 或 XDP 文件导入数据。
- 参数
-
[in] file_path 源文件的路径，其数据将导入到当前 XFA 文档。 它应该是 XML 或 XDP 文件，文件扩展名应该是".xml"或".xdp"。
- 返回
- true 表示成功，false 表示失败。
◆ ImportData() [2/2]
|
inline |
从 foxit.common.fxcrt.FileReaderCallback 对象导入数据。
- 参数
-
[in] file_reader foxit.common.fxcrt.FileReaderCallback 对象，其数据将导入到当前 XFA 文档。 它应该是 XML 或 XDP 文件。
- 返回
- true 表示成功，false 表示失败。
◆ IsEmpty()
|
inline |
检查当前对象是否为空。
当前对象为空时，表示当前对象无用。
- 返回
- true 表示当前对象为空，false 表示不为空。
◆ KillFocus()
|
inline |
取消 XFA 控件的焦点。
- 返回
- 无。
◆ ProcessEvent()
|
inline |
为当前 XFA 文档中的所有 XFA 控件处理某种事件。
- 参数
-
[in] event_type 事件类型。请参考从 foxit.addon.xfa.XFADoc.EventType.e_EventTypePostPrint 开始的值，这应该是这些值之一，除了 foxit.addon.xfa.XFADoc.EventType.e_EventTypeUnknown 。
- 返回
- 无。
◆ ResetForm()
|
inline |
重置表单。
- 返回
- 无。
◆ SetDocProviderCallback()
|
inline |
设置 XFA 文档提供程序回调。
- 参数
-
[in] doc_provider_callback 由用户实现并基于回调类 DocProviderCallback 的 XFA 文档提供程序回调对象。 它不应该为 null。用户应确保此回调对象在相关 PDF 文档释放之前保持有效。
- 返回
- 无。
◆ SetFocus()
|
inline |
设置 XFA 控件的焦点。
- 参数
-
[in] xfa_widget 将获得焦点的 XFA 控件。
- 返回
- 无。
◆ SetPDFPath()
|
inline |
设置相关 PDF 文档的路径。
PDF 路径将在函数 XFADoc.ExportData 中使用，作为导出数据的一部分。
- 参数
-
[in] pdf_file_path 相关 PDF 文档的文件路径。它可以是绝对路径或 相对路径。不应该是空字符串。
- 返回
- 无。
◆ StartLoad()
|
inline |
开始为当前 XFA 文档加载内容。
加载 XFA 内容可能需要很长时间，因此此函数使用渐进过程来 执行此操作。
相关的 PDF 文档对象已加载，但只加载了 PDF 相关内容。 因此，为了访问 XFA 内容，应调用此函数来加载 XFA 内容。
- 参数
-
[in] pause 暂停对象，决定导入过程是否需要暂停。 这可以是 null，表示在解析过程中不暂停。 如果不是 null，它应该是用户实现的有效暂停对象。 默认值：null。
- 返回
- 渐进对象。请通过函数 common.Progressive.GetRateOfProgress 检查当前进度的比率。 如果比率还不是 100，请调用函数 common.Progressive.Continue 继续进度，直到进度完成。
