Foxit PDF SDK

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

## 构造函数
(FSPDFDoc *) | - getPortfolioPDFDoc
| 获取相关的作品集PDF文档对象。 更多...
(FSPortfolioNode *) | - getRootNode
| 获取始终为文件夹节点的根节点。 更多...
(id) | - initWithOther:
| 构造函数，使用另一个PDF作品集对象。 更多...
(BOOL) | - isEmpty
| 检查当前对象是否为空。 更多...
(BOOL) | - isSortedInAscending
| 检查节点是否应按升序排序。 更多...
(void) | - setSortingOrder:
| 设置布尔值以决定节点是否应按升序排序。 更多...

## 类方法
(FSPortfolio *) | + createPortfolio
| 使用自动创建的新空白PDF文档创建PDF作品集。 更多...
(FSPortfolio *) | + createPortfolioWithPDFDoc:
| 使用现有的作品集PDF文档创建PDF作品集。 更多...

## 属性
NSString * | initialFileSpecKeyName
| 获取应作为初始文档的附件（作为文件规范）的键名。 更多...
FSPortfolioInitialViewMode | initialViewMode
| 获取初始视图模式。
FSSchemaFieldArray * | schemaFields
| 获取架构字段。 更多...
NSString * | sortingFieldKeyName
| 获取用于排序的架构字段的键名。

## 详细描述

PDF作品集是不同格式文件的组合。PDF作品集本身是一个PDF文档， 然后可以将不同格式的文件嵌入到这种类型的PDF文档中。
类 FSPortfolio 可用于创建新的空白PDF作品集或访问现有的作品集PDF文档， 然后获取/设置作品集属性并访问根节点以枚举所有节点或添加/删除节点。

## 函数文档

## ◆ createPortfolio()

+ (FSPortfolio *) createPortfolio |  |  |

使用自动创建的新空白PDF文档创建PDF作品集。

此函数将自动创建一个新的空白PDF文档作为作品集PDF文档。 函数 FSPortfolio::getPortfolioPDFDoc 可用于检索相关的PDF文档对象。 函数 FSPortfolio::schemaFields 可用于检索默认架构字段。

返回
  PDF作品集对象。

## ◆ createPortfolioWithPDFDoc:()

+ (FSPortfolio *) createPortfolioWithPDFDoc: |  | (FSPDFDoc*) | portfolio_pdf_doc |

使用现有的作品集PDF文档创建PDF作品集。

此函数只是创建一个PDF作品集对象以与 现有的作品集PDF文档关联，以便访问作品集信息。

参数

  [in] | portfolio_pdf_doc | 作品集PDF文档。

返回
  PDF作品集对象。

## ◆ getPortfolioPDFDoc()

- (FSPDFDoc *) getPortfolioPDFDoc |  |  |

获取相关的作品集PDF文档对象。

返回
  相关的作品集PDF文档对象。

## ◆ getRootNode()

- (FSPortfolioNode *) getRootNode |  |  |

获取始终为文件夹节点的根节点。

PDF作品集将文件组织成层次结构——一个具有单个根文件夹（也称为根节点）的树， 作为所有其他文件夹和文件的共同祖先。

返回
  表示根节点的作品集节点对象。

## ◆ initWithOther:()

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

构造函数，使用另一个PDF作品集对象。

参数

  [in] | other | 另一个书签对象。

## ◆ isEmpty()

- (BOOL) isEmpty |  |  |

检查当前对象是否为空。

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

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

## ◆ isSortedInAscending()

- (BOOL) isSortedInAscending |  |  |

检查节点是否应按升序排序。

返回
  YES 表示节点应使用指定字段按升序排序， NO 表示节点应使用指定字段按降序排序。

## ◆ setSortingOrder:()

- (void) setSortingOrder: |  | (BOOL) | use_ascending_order |

设置布尔值以决定节点是否应按升序排序。

参数

  [in] | use_ascending_order | 决定排序顺序的布尔值： YES 表示节点应使用指定字段按升序排序， NO 表示节点应使用指定字段按降序排序。

返回
  无。

## 属性说明

## ◆ initialFileSpecKeyName

- (NSString *) initialFileSpecKeyName
| read write nonatomic weak

获取应作为初始文档的附件（作为文件规范）的键名。

类 FSAttachments 可用于通过键名检索文件规范对象。

## ◆ schemaFields

- (FSSchemaFieldArray *) schemaFields
| read write nonatomic weak

获取架构字段。

架构字段用于决定在应用程序中显示文件节点或文件夹节点的哪些属性。