Foxit PDF SDK
Public 成员函数 | 所有成员列表
fsdk.FDFDoc类 参考

Public 成员函数

def GetCatalog ()
 获取目录字典。 更多...
 
def GetFDFDict ()
 从目录字典获取"FDF"条目的字典。 更多...
 
def GetPDFPath ()
 获取相关PDF文档的路径。 更多...
 
def GetType ()
 获取当前文档对象的类型。 更多...
 
def IsEmpty ()
 检查当前对象是否为空。 更多...
 
def SaveAs (file_path)
 将当前文档另存为另一个FDF或XFDF文件。 更多...
 
def SaveAs (file)
 将当前文档另存为另一个FDF或XFDF文件。 更多...
 
def SetPDFPath (pdf_path)
 设置相关PDF文档的路径。 更多...
 

详细描述

FDF（表单数据格式）是一种文件格式，用于交互式表单数据。FDF可用于 向服务器提交表单数据、接收响应并将其合并到交互式表单中。 它还可用于将表单数据导出到独立文件中，这些文件可以存储、电子传输， 并导入回相应的PDF交互式表单。除此之外，FDF还可用于 定义一个容器，用于存放与其应用的PDF文档分离的注释。
XFDF（XML表单数据格式）是基于XML的FDF版本。它具有与FDF相似的功能。
总之，FDF和XFDF包含PDF文档的子集，用于描述交互式表单和注释。
类 FDFDoc 可用于表示FDF或XFDF。FDF文档对象可以通过 文件路径、内存缓冲区、用户自定义实现的 fsdk.FileReaderCallback 对象和 输入文件流从现有文件构造。FDF文档对象也可以构造为新的FDF或XFDF文档。 此类还提供从FDF或XFDF文件获取或设置某些信息的函数， 并将当前FDF/XFDF保存为另一个文件。
要导入或导出表单字段或注释，请参考函数 fsdk.PDFDoc.ImportFromFDF 、 fsdk.PDFDoc.ExportToFDF 和 fsdk.PDFDoc.ExportAnnotToFDF 。

参见
fsdk.PDFDoc

成员函数说明

◆ GetCatalog()

def fsdk.FDFDoc.GetCatalog ( )

获取目录字典。

返回
目录字典。如果当前对象表示XFDF文档， 此函数将返回null。

◆ GetFDFDict()

def fsdk.FDFDoc.GetFDFDict ( )

从目录字典获取"FDF"条目的字典。

返回
目录字典中"FDF"条目的字典。 如果当前对象表示XFDF文档，此函数将返回null。

◆ GetPDFPath()

def fsdk.FDFDoc.GetPDFPath ( )

获取相关PDF文档的路径。

路径可以是绝对路径或相对路径。

返回
相关PDF文档的文件路径。空字符串表示未找到此类信息。

◆ GetType()

def fsdk.FDFDoc.GetType ( )

获取当前文档对象的类型。

返回
FDF文档类型。将是以下值之一：
fsdk.FDFDocE_FDF , fsdk.FDFDocE_XFDF 。

◆ IsEmpty()

def fsdk.FDFDoc.IsEmpty ( )

检查当前对象是否为空。

当前对象为空时，意味着当前对象无用。

返回
true表示当前对象为空，false表示不为空。

◆ SaveAs() [1/2]

def fsdk.FDFDoc.SaveAs (   file_path)

将当前文档另存为另一个FDF或XFDF文件。

参数
[in]file_path新保存的FDF或XFDF文件的完整路径。不应为空字符串。
返回
true表示成功，false表示失败。
注解
此函数不支持将当前FDF对象直接保存回用于构造当前FDF对象的FDF或XFDF文件。 为此，建议用户按照以下步骤操作：
假设当前FDF对象是从名为"org.fdf"的FDF文件构造的。

  1. 使用当前函数将当前FDF对象保存到临时文件。此处，此临时文件命名为"temp.tmp"。

  2. 确保当前FDF对象已析构。

  3. 删除"org.fdf"并将"temp.tmp"重命名为"org.fdf"。

◆ SaveAs() [2/2]

def fsdk.FDFDoc.SaveAs (   file)

将当前文档另存为另一个FDF或XFDF文件。

参数
[in]file用户实现的 fsdk.FileWriterCallback 对象，用于保存FDF或XFDF文件。
返回
true表示成功，false表示失败。
注解
此函数不支持将当前FDF对象直接保存回用于构造当前FDF对象的FDF或XFDF文件。 为此，建议用户按照以下步骤操作：
假设当前FDF对象是从名为"org.fdf"的FDF文件构造的。

  1. 使用当前函数将当前FDF对象保存到临时文件。此处，此临时文件命名为"temp.tmp"。

  2. 确保当前FDF对象已析构。

  3. 删除"org.fdf"并将"temp.tmp"重命名为"org.fdf"。

◆ SetPDFPath()

def fsdk.FDFDoc.SetPDFPath (   pdf_path)

设置相关PDF文档的路径。

参数
[in]pdf_path相关PDF文档的路径。可以是绝对路径或相对路径。 不应为空字符串。
返回
true表示成功，false表示失败。