Foxit PDF SDK
FSFDFDoc类 参考
类 FSFDFDoc 继承关系图:
FSBase

构造函数

(FSPDFDictionary *) - getCatalog
 获取目录字典。
更多...
 
(FSPDFDictionary *) - getFDFDict
 从目录字典获取"FDF"条目的字典。
更多...
 
(NSString *) - getPDFPath
 获取相关PDF文档的路径。
更多...
 
(FSFDFDocType) - getType
 获取当前文档对象的类型。
更多...
 
(id) - initWithBuffer:
 构造函数,从内存缓冲区。
更多...
 
(id) - initWithFile_read:
 构造函数,使用文件读取回调对象。
更多...
 
(id) - initWithOther:
 构造函数,使用另一个FDF文档对象。
更多...
 
(id) - initWithPath:
 构造函数,从现有的FDF或XFDF文件路径。
更多...
 
(id) - initWithType:
 构造函数。
更多...
 
(BOOL) - isEmpty
 检查当前对象是否为空。
更多...
 
(BOOL) - saveAs:
 将当前文档另存为另一个FDF或XFDF文件。
更多...
 
(BOOL) - saveAsWithWriterCallback:
 将当前文档另存为另一个FDF或XFDF文件。
更多...
 
(BOOL) - setPDFPath:
 设置相关PDF文档的路径。
更多...
 

详细描述

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

参见
FSPDFDoc

函数文档

◆ getCatalog()

- (FSPDFDictionary *) getCatalog

获取目录字典。

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

◆ getFDFDict()

- (FSPDFDictionary *) getFDFDict

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

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

◆ getPDFPath()

- (NSString *) getPDFPath

获取相关PDF文档的路径。

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

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

◆ getType()

- (FSFDFDocType) getType

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

返回
FDF文档类型。将是以下值之一:
FSFDFDocFDF , FSFDFDocXFDF 。

◆ initWithBuffer:()

- (id) initWithBuffer: (NSData *)  buffer

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

参数
[in]buffer内存缓冲区。FDF或XFDF文件数据应完全加载到此内存缓冲区中。 不应为nil。

◆ initWithFile_read:()

- (id) initWithFile_read: (id<FSFileReaderCallback>)  file_read

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

参数
[in]file_read指向用户实现的 FSFileReaderCallback 对象的指针, 用于加载FDF或XFDF文档。不应为nil。

◆ initWithOther:()

- (id) initWithOther: (FSFDFDoc*)  other

构造函数,使用另一个FDF文档对象。

参数
[in]other另一个FDF文档对象。

◆ initWithPath:()

- (id) initWithPath: (NSString *)  path

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

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

◆ initWithType:()

- (id) initWithType: (FSFDFDocType)  type

构造函数。

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

参数
[in]typeFDF文档类型。应为以下值之一:
FSFDFDocFDF , FSFDFDocXFDF

◆ isEmpty()

- (BOOL) isEmpty

检查当前对象是否为空。

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

返回
YES表示当前对象为空,NO表示不为空。

◆ saveAs:()

- (BOOL) saveAs: (NSString *)  file_path

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

参数
[in]file_path新保存的FDF或XFDF文件的完整路径。不应为空字符串。
返回
YES表示成功,NO表示失败。
注解
此函数不支持将当前FDF对象直接保存回用于构造当前FDF对象的FDF或XFDF文件。 为此,建议用户按照以下步骤操作:
假设当前FDF对象是从名为"org.fdf"的FDF文件构造的。
  1. 使用当前函数将当前FDF对象保存到临时文件。此处,此临时文件命名为"temp.tmp"。
  2. 确保当前FDF对象已析构。
  3. 删除"org.fdf"并将"temp.tmp"重命名为"org.fdf"。

◆ saveAsWithWriterCallback:()

- (BOOL) saveAsWithWriterCallback: (id<FSFileWriterCallback>)  file

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

参数
[in]file用户实现的 FSFileWriterCallback 对象,用于保存FDF或XFDF文件。
返回
YES表示成功,NO表示失败。
注解
此函数不支持将当前FDF对象直接保存回用于构造当前FDF对象的FDF或XFDF文件。 为此,建议用户按照以下步骤操作:
假设当前FDF对象是从名为"org.fdf"的FDF文件构造的。
  1. 使用当前函数将当前FDF对象保存到临时文件。此处,此临时文件命名为"temp.tmp"。
  2. 确保当前FDF对象已析构。
  3. 删除"org.fdf"并将"temp.tmp"重命名为"org.fdf"。

◆ setPDFPath:()

- (BOOL) setPDFPath: (NSString *)  pdf_path

设置相关PDF文档的路径。

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