Foxit PDF SDK

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

## Public 成员函数
| constructor (file_read)
| 使用文件读取回调对象构造。 更多...
| constructor (type)
| 构造函数。 更多...
| constructor (path)
| 从现有 FDF 或 XFDF 文件路径构造的构造函数。 更多...
| constructor (buffer, length)
| 从内存缓冲区构造的构造函数。 更多...
| GetCatalog ()
| 获取目录字典。 更多...
| GetFDFDict ()
| 从目录字典获取"FDF"条目的字典。 更多...
| GetPDFPath ()
| 获取相关 PDF 文档的路径。 更多...
| GetType ()
| 获取当前文档对象的类型。 更多...
| IsEmpty ()
| 检查当前对象是否为空。 更多...
| SaveAs (file_path)
| 将当前文档另存为另一个 FDF 或 XFDF 文件。 更多...
| SaveAs (file)
| 将当前文档另存为另一个 FDF 或 XFDF 文件。 更多...
| SetPDFPath (pdf_path)
| 设置相关 PDF 文档的路径。 更多...

## 静态 Public 属性
static | e_FDF
| FDF 文档类型的枚举。 更多...
static | e_XFDF
| FDF 文档类型：XFDF。

## 详细描述

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

参见
  FSDK.PDFDoc

## 成员函数说明

## ◆ constructor() [1/4]

FSDK::FDFDoc::constructor | ( | file_read |  | ) |

使用文件读取回调对象构造。

参数

  [in] | file_read | 指向由用户实现的 FSDK.FileReaderCallback 对象的指针，用于 加载 FDF 或 XFDF 文档。它不应为 null。

## ◆ constructor() [2/4]

FSDK::FDFDoc::constructor | ( | type |  | ) |

构造函数。

此构造函数用于构造一个新的 FDF 文档对象（不包含任何数据）。

参数

  [in] | type | FDF 文档类型。它应该是以下值之一： FSDK.FDFDoc.e_FDF、FSDK.FDFDoc.e_XFDF

## ◆ constructor() [3/4]

FSDK::FDFDoc::constructor | ( | path |  | ) |

从现有 FDF 或 XFDF 文件路径构造的构造函数。

参数

  [in] | path | 现有 FDF/XFDF 文件的完整路径。它不应为空字符串。

## ◆ constructor() [4/4]

FSDK::FDFDoc::constructor | ( | buffer | ,
|  | length |
| ) |  |

从内存缓冲区构造的构造函数。

参数

  [in] | buffer | 内存缓冲区。FDF 或 XFDF 文件数据应完全加载到此内存缓冲区中。 它不应为 null。
  [in] | length | 内存缓冲区的大小。它应大于 0。

## ◆ GetCatalog()

FSDK::FDFDoc::GetCatalog | ( |  | ) |

获取目录字典。

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

## ◆ GetFDFDict()

FSDK::FDFDoc::GetFDFDict | ( |  | ) |

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

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

## ◆ GetPDFPath()

FSDK::FDFDoc::GetPDFPath | ( |  | ) |

获取相关 PDF 文档的路径。

路径可以是绝对路径，也可以是相对路径。

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

## ◆ GetType()

FSDK::FDFDoc::GetType | ( |  | ) |

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

返回
  FDF 文档类型。它将是以下值之一：
  FSDK.FDFDoc.e_FDF、FSDK.FDFDoc.e_XFDF。

## ◆ IsEmpty()

FSDK::FDFDoc::IsEmpty | ( |  | ) |

检查当前对象是否为空。

当当前对象为空时，表示当前对象无用。

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

## ◆ SaveAs() [1/2]

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]

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()

FSDK::FDFDoc::SetPDFPath | ( | pdf_path |  | ) |

设置相关 PDF 文档的路径。

参数

  [in] | pdf_path | 相关 PDF 文档的路径。它可以是绝对路径或相对路径。 它不应为空字符串。

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

## 类成员变量说明

## ◆ e_FDF

FSDK::FDFDoc::e_FDF
| static

FDF 文档类型的枚举。

此枚举的值应单独使用。FDF 文档类型：FDF。