类 XFADoc 从已加载的 PDF 文档对象构造，以便更清晰地访问 XFA 内容。 用户必须在使用 XFA 模块之前调用 fsdk.LibraryRegisterXFAAppProviderCallback 。 对于新构造的 XFA 对象，请记住在使用 XFA 类中的其他函数之前调用函数 fsdk.XFADoc.StartLoad 。
要在 XFA 文档中搜索，请使用 XFADoc 对象构造 fsdk.TextSearch 对象。
- 参见
- fsdk.TextSearch
◆ ExportData()
| def fsdk.XFADoc.ExportData |
( |
|
output_file_path, |
|
|
|
export_type |
|
) |
| |
◆ FlattenTo() [1/2]
| def fsdk.XFADoc.FlattenTo |
( |
|
output_file_path | ) |
|
将当前 XFA 文档扁平化到文件。
- 参数
-
| [in] | output_file_path | 扁平化结果将保存到的文件路径。 |
- 返回
- 无。
◆ FlattenTo() [2/2]
| def fsdk.XFADoc.FlattenTo |
( |
|
stream | ) |
|
将当前 XFA 文档扁平化到文件流。
- 参数
-
- 返回
- 无。
◆ GetPage()
| def fsdk.XFADoc.GetPage |
( |
|
page_index | ) |
|
按索引获取 XFA 页面。
- 参数
-
- 返回
- XFA 页面。
◆ GetPageCount()
| def fsdk.XFADoc.GetPageCount |
( |
| ) |
|
◆ GetType()
| def fsdk.XFADoc.GetType |
( |
| ) |
|
◆ GetWidgetByFullName()
| def fsdk.XFADoc.GetWidgetByFullName |
( |
|
full_name | ) |
|
获取与指定全名匹配的 XFA 控件。
某些 XFA 控件可能跨越多个 XFA 页面。在这种情况下，此函数只能用于 获取 XFA 文档中第一个匹配的 XFA 控件。用户也可以使用函数 fsdk.XFAPage.GetWidgetByFullName 来获取 XFA 页面中匹配的 XFA 控件。
- 参数
-
- 返回
- XFA 控件对象。
◆ ImportData() [1/2]
| def fsdk.XFADoc.ImportData |
( |
|
file_path | ) |
|
从 XML 或 XDP 文件导入数据。
- 参数
-
| [in] | file_path | 源文件的路径，其数据将导入到当前 XFA 文档。 它应该是 XML 或 XDP 文件，文件扩展名应该是".xml"或".xdp"。 |
- 返回
- true 表示成功，false 表示失败。
◆ ImportData() [2/2]
| def fsdk.XFADoc.ImportData |
( |
|
file_reader | ) |
|
◆ IsEmpty()
| def fsdk.XFADoc.IsEmpty |
( |
| ) |
|
检查当前对象是否为空。
当前对象为空时，表示当前对象无用。
- 返回
- true 表示当前对象为空，false 表示不为空。
◆ KillFocus()
| def fsdk.XFADoc.KillFocus |
( |
| ) |
|
◆ ProcessEvent()
| def fsdk.XFADoc.ProcessEvent |
( |
|
event_type | ) |
|
为当前 XFA 文档中的所有 XFA 控件处理某种事件。
- 参数
-
- 返回
- 无。
◆ ResetForm()
| def fsdk.XFADoc.ResetForm |
( |
| ) |
|
◆ SetDocProviderCallback()
| def fsdk.XFADoc.SetDocProviderCallback |
( |
|
doc_provider_callback | ) |
|
设置 XFA 文档提供程序回调。
- 参数
-
| [in] | doc_provider_callback | 由用户实现并基于回调类 DocProviderCallback 的 XFA 文档提供程序回调对象。 它不应该为 null。用户应确保此回调对象在相关 PDF 文档释放之前保持有效。 |
- 返回
- 无。
◆ SetFocus()
| def fsdk.XFADoc.SetFocus |
( |
|
xfa_widget | ) |
|
设置 XFA 控件的焦点。
- 参数
-
| [in] | xfa_widget | 将获得焦点的 XFA 控件。 |
- 返回
- 无。
◆ SetPDFPath()
| def fsdk.XFADoc.SetPDFPath |
( |
|
pdf_file_path | ) |
|
设置相关 PDF 文档的路径。
PDF 路径将在函数 fsdk.XFADoc.ExportData 中使用，作为导出数据的一部分。
- 参数
-
| [in] | pdf_file_path | 相关 PDF 文档的文件路径。它可以是绝对路径或 相对路径。不应该是空字符串。 |
- 返回
- 无。
◆ StartLoad()
| def fsdk.XFADoc.StartLoad |
( |
|
pause | ) |
|
开始为当前 XFA 文档加载内容。
加载 XFA 内容可能需要很长时间，因此此函数使用渐进过程来 执行此操作。
相关的 PDF 文档对象已加载，但只加载了 PDF 相关内容。 因此，为了访问 XFA 内容，应调用此函数来加载 XFA 内容。
- 参数
-
| [in] | pause | 暂停对象，决定导入过程是否需要暂停。 这可以是 null，表示在解析过程中不暂停。 如果不是 null，它应该是用户实现的有效暂停对象。 默认值：null。 |
- 返回
- 渐进对象。请通过函数 fsdk.Progressive.GetRateOfProgress 检查当前进度的比率。 如果比率还不是 100，请调用函数 fsdk.Progressive.Continue 继续进度，直到进度完成。
