Foxit PDF SDK

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

## Public 成员函数
| GetInitialFileSpecKeyName ()
| 获取应为初始文档的附件(作为文件规范)的键名。 更多...
| GetInitialViewMode ()
| 获取初始视图模式。 更多...
| GetPortfolioPDFDoc ()
| 获取相关的组合 PDF 文档对象。 更多...
| GetRootNode ()
| 获取根节点,它始终是文件夹节点。 更多...
| GetSchemaFields ()
| 获取架构字段。 更多...
| GetSortingFieldKeyName ()
| 获取用于排序的架构字段的键名。 更多...
| IsEmpty ()
| 检查当前对象是否为空。 更多...
| IsSortedInAscending ()
| 检查节点是否应按升序排序。 更多...
| SetInitialFileSpecKeyName (name)
| 设置应为初始文档的附件(作为文件规范)的键名。 更多...
| SetInitialViewMode (mode)
| 设置初始视图模式。 更多...
| SetSchemaFields (field_array)
| 设置架构字段。 更多...
| SetSortingFieldKeyName (name)
| 设置用于排序的架构字段的键名。 更多...
| SetSortingOrder (use_ascending_order)
| 设置布尔值以决定节点是否应按升序排序。 更多...

## 静态 Public 成员函数
static | CreatePortfolio ()
| 使用自动创建的新空白 PDF 文档创建 PDF 组合。 更多...
static | CreatePortfolio (portfolio_pdf_doc)
| 使用现有组合 PDF 文档创建 PDF 组合。 更多...

## 静态 Public 属性
static | e_InitialViewDetailMode
| 初始视图模式: 详细信息模式,以多列格式呈现所有信息(由架构字段指定)。 更多...
static | e_InitialViewHidden
| 初始视图模式: 隐藏模式。
static | e_InitialViewTileMode
| 初始视图模式: 平铺模式,每个文件和文件夹节点由小图标和 信息子集(由架构字段指定)表示。 更多...
static | e_InitialViewUnknownMode
| 组合 PDF 文档的初始视图模式枚举。 更多...

## 详细描述

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

## 成员函数说明

## ◆ CreatePortfolio() [1/2]

static FSDK::Portfolio::CreatePortfolio | ( |  | ) |
| static

使用自动创建的新空白 PDF 文档创建 PDF 组合。

此函数将自动创建新的空白 PDF 文档作为组合 PDF 文档。 函数 FSDK.Portfolio.GetPortfolioPDFDoc 可用于检索相关的 PDF 文档对象。 函数 FSDK.Portfolio.GetSchemaFields 可用于检索默认架构字段。

返回
  PDF 组合对象。

## ◆ CreatePortfolio() [2/2]

static FSDK::Portfolio::CreatePortfolio | ( | portfolio_pdf_doc |  | ) |
| static

使用现有组合 PDF 文档创建 PDF 组合。

此函数仅用于创建与现有组合 PDF 文档关联的 PDF 组合对象, 以便访问组合信息。

参数

  [in] | portfolio_pdf_doc | 组合 PDF 文档。

返回
  PDF 组合对象。

## ◆ GetInitialFileSpecKeyName()

FSDK::Portfolio::GetInitialFileSpecKeyName | ( |  | ) |

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

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

返回
  附件(作为文件规范)的键名。如果返回空字符串, 这意味着相关的组合 PDF 文档应为初始文档。

## ◆ GetInitialViewMode()

FSDK::Portfolio::GetInitialViewMode | ( |  | ) |

获取初始视图模式。

返回
  初始视图模式。请参阅从 FSDK.Portfolio.e_InitialViewUnknownMode 开始的值,这将是这些值之一。

## ◆ GetPortfolioPDFDoc()

FSDK::Portfolio::GetPortfolioPDFDoc | ( |  | ) |

获取相关的组合 PDF 文档对象。

返回
  相关的组合 PDF 文档对象。

## ◆ GetRootNode()

FSDK::Portfolio::GetRootNode | ( |  | ) |

获取根节点,它始终是文件夹节点。

PDF 组合将文件组织成分层结构 – 一个树,具有单个根文件夹(也称为根节点) 作为所有其他文件夹和文件的共同祖先。

返回
  表示根节点的组合节点对象。

## ◆ GetSchemaFields()

FSDK::Portfolio::GetSchemaFields | ( |  | ) |

获取架构字段。

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

返回
  架构字段。这些字段的顺序由它们在返回数组中的索引顺序决定。

## ◆ GetSortingFieldKeyName()

FSDK::Portfolio::GetSortingFieldKeyName | ( |  | ) |

获取用于排序的架构字段的键名。

返回
  用于排序的架构字段的键名。

## ◆ IsEmpty()

FSDK::Portfolio::IsEmpty | ( |  | ) |

检查当前对象是否为空。

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

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

## ◆ IsSortedInAscending()

FSDK::Portfolio::IsSortedInAscending | ( |  | ) |

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

返回
  true 表示节点应按指定字段的升序排序, 而 false 表示节点应按指定字段的降序排序。

## ◆ SetInitialFileSpecKeyName()

FSDK::Portfolio::SetInitialFileSpecKeyName | ( | name |  | ) |

设置应为初始文档的附件(作为文件规范)的键名。

函数 FSDK.PortfolioFileNode.GetKeyName 可用于获取与文件节点关联的文件规范的键名。 或使用类 FSDK.Attachments 检索文件规范的键名。

参数

  [in] | name | 附件(作为文件规范)的键名。如果返回空字符串, 这意味着相关的组合 PDF 文档应为初始文档。

返回
  无。

## ◆ SetInitialViewMode()

FSDK::Portfolio::SetInitialViewMode | ( | mode |  | ) |

设置初始视图模式。

参数

  [in] | mode | 初始视图模式。请参阅从 FSDK.Portfolio.e_InitialViewDetailMode 开始的值, 应为这些值之一,除了 FSDK.Portfolio.e_InitialViewUnknownMode。

返回
  无。

## ◆ SetSchemaFields()

FSDK::Portfolio::SetSchemaFields | ( | field_array |  | ) |

设置架构字段。

架构字段用于决定在应用程序中显示文件节点或文件夹节点的哪些属性。
当此函数成功时,所有旧架构字段将被移除,并使用输入的字段。

参数

  [in] | field_array | 新架构字段数组。这些字段的顺序由它们在此数组中的索引顺序决定。

返回
  无。

## ◆ SetSortingFieldKeyName()

FSDK::Portfolio::SetSortingFieldKeyName | ( | name |  | ) |

设置用于排序的架构字段的键名。

参数

  [in] | name | 用于排序的架构字段的键名。

返回
  无。

## ◆ SetSortingOrder()

FSDK::Portfolio::SetSortingOrder | ( | use_ascending_order |  | ) |

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

参数

  [in] | use_ascending_order | 决定排序顺序的布尔值: true 表示节点应按指定字段的升序排序, 而 false 表示节点应按指定字段的降序排序。

返回
  无。

## 类成员变量说明

## ◆ e_InitialViewDetailMode

FSDK::Portfolio::e_InitialViewDetailMode
| static

初始视图模式: 详细信息模式,以多列格式呈现所有信息(由架构字段指定)。

注解
  此模式向用户提供最多的信息。

## ◆ e_InitialViewTileMode

FSDK::Portfolio::e_InitialViewTileMode
| static

初始视图模式: 平铺模式,每个文件和文件夹节点由小图标和 信息子集(由架构字段指定)表示。

注解
  此模式向用户提供有关嵌入文件的顶级信息。

## ◆ e_InitialViewUnknownMode

FSDK::Portfolio::e_InitialViewUnknownMode
| static

组合 PDF 文档的初始视图模式枚举。

此枚举的值应单独使用。

未知初始视图模式。