Foxit PDF SDK

构造函数 | 属性 | 所有成员列表
FSPortfolioFolderNode类 参考
类 FSPortfolioFolderNode 继承关系图:

## 构造函数
(FSPortfolioFileNode *) | - addFile:
| 添加一个文件（通过文件路径指定）作为子节点。 更多...
(FSPortfolioFileNode *) | - addFileWithStreamCallback:file_name:
| 添加一个文件（通过 FSFileStreamCallback 指定）作为子节点。 更多...
(FSPortfolioFileNode *) | - addPDFDoc:file_name:
| 添加一个已加载的PDF文档作为子节点。 更多...
(FSPortfolioFolderNode *) | - addSubFolder:
| 添加一个新的子文件夹。 更多...
(FSDateTime *) | - getCreationDateTime
| 获取创建日期时间。 更多...
(FSDateTime *) | - getModifiedDateTime
| 获取最后修改日期时间。 更多...
(NSString *) | - getName
| 获取当前文件夹节点的名称。 更多...
(FSPortfolioNodeArray *) | - getSortedSubNodes
| 获取已根据类 FSPortfolio 中定义的排序顺序和指定字段名称排序的子节点数组。 更多...
(id) | - initWithOther:
| 构造函数，使用父类对象。 更多...
(BOOL) | - isRoot
| 检查当前文件夹节点是否表示根节点。 更多...
(void) | - removeSubNode:
| 移除一个子节点。 更多...
构造函数 继承自 FSPortfolioNode
(FSPortfolioNodeType) | - getNodeType
| 获取节点类型。 更多...
(BOOL) | - isEmpty
| 检查当前对象是否为空。 更多...

## 属性
NSString * | description
| 获取描述。

## 详细描述

作品集文件夹节点用作文件夹，可以包含文件和其他文件夹作为子节点。
类 FSPortfolioFolderNode 派生自类 FSPortfolioNode 。 它提供了访问文件夹节点的功能：向文件夹节点添加文件/文件夹、从文件夹节点移除子节点、 以排序顺序获取所有子节点，以及获取/设置文件夹节点的某些属性。

## 函数文档

## ◆ addFile:()

- (FSPortfolioFileNode *) addFile: |  | (NSString *) | file_path |

添加一个文件（通过文件路径指定）作为子节点。

Foxit PDF SDK将从输入文件路径中检索一些属性（如文件名、修改日期等） 并将它们设置到返回文件节点的文件规范对象中。 用户也可以通过类 FSFileSpec 中的函数为返回的文件节点更新属性。

参数

  [in] | file_path | 现有本地文件的完整路径。

返回
  新添加的文件节点对象。

## ◆ addFileWithStreamCallback:file_name:()

- (FSPortfolioFileNode *) addFileWithStreamCallback: |  | (id<FSFileStreamCallback>) | file_stream
file_name: |  | (NSString *) | file_name

添加一个文件（通过 FSFileStreamCallback 指定）作为子节点。

Foxit PDF SDK无法从输入流回调中检索任何属性。 因此用户应该通过类 FSFileSpec 中的函数为返回的文件节点更新属性。

参数

  [in] | file_stream | 一个由用户实现的 FSFileStreamCallback 对象， 用于读取文件内容。
  [in] | file_name | 流回调指定文件的文件名。此名称将 用于与返回的文件节点对象相关的文件规范中。

返回
  新添加的文件节点对象。

## ◆ addPDFDoc:file_name:()

- (FSPortfolioFileNode *) addPDFDoc: |  | (FSPDFDoc*) | pdf_doc
file_name: |  | (NSString *) | file_name

添加一个已加载的PDF文档作为子节点。

Foxit PDF SDK将尝试从输入PDF文档的元数据中检索属性（如创建日期和修改日期） 并将它们设置到返回文件节点的文件规范对象中。 用户也可以通过类 FSFileSpec 中的函数为返回的文件节点更新属性。

参数

  [in] | pdf_doc | 一个已成功加载的有效PDF文档对象。
  [in] | file_name | 流回调指定文件的文件名。此名称将 用于与返回的文件节点对象相关的文件规范中。

返回
  新添加的文件节点对象。

## ◆ addSubFolder:()

- (FSPortfolioFolderNode *) addSubFolder: |  | (NSString *) | folder_name |

添加一个新的子文件夹。

参数

  [in] | folder_name | 新子文件夹的文件夹名称。

返回
  新添加的文件夹节点对象。

## ◆ getCreationDateTime()

- (FSDateTime *) getCreationDateTime |  |  |

获取创建日期时间。

返回
  创建日期时间。

## ◆ getModifiedDateTime()

- (FSDateTime *) getModifiedDateTime |  |  |

获取最后修改日期时间。

如果子节点的结构发生变化（例如添加文件/文件夹、移除子节点）， Foxit PDF SDK将自动更新当前文件夹节点的最后修改日期时间。

返回
  最后修改日期时间。

## ◆ getName()

- (NSString *) getName |  |  |

获取当前文件夹节点的名称。

返回
  当前文件夹节点的名称。如果当前文件夹节点是根节点， 通常它没有名称，这种情况下将返回空字符串。

## ◆ getSortedSubNodes()

- (FSPortfolioNodeArray *) getSortedSubNodes |  |  |

获取已根据类 FSPortfolio 中定义的排序顺序和指定字段名称排序的子节点数组。

如果要比较的值的类型是字符串，Foxit PDF SDK将比较这些字符串值 而不区分字符是大写还是小写。

返回
  已排序的子节点数组。

## ◆ initWithOther:()

- (id) initWithOther: |  | (FSPortfolioNode*) | other |

构造函数，使用父类对象。

参数

  [in] | other | 父类对象。

重载 FSPortfolioNode .

## ◆ isRoot()

- (BOOL) isRoot |  |  |

检查当前文件夹节点是否表示根节点。

返回
  YES 表示当前文件夹节点是根节点， NO 表示当前文件夹节点不是根节点。

## ◆ removeSubNode:()

- (void) removeSubNode: |  | (FSPortfolioNode*) | sub_node |

移除一个子节点。

参数

  [in] | sub_node | 表示要移除的当前节点子节点的节点对象。

返回
  无。