foxit::pdf::portfolio::Portfolio类 参考

类 foxit::pdf::portfolio::Portfolio 继承关系图:

Public 类型
enum	InitialViewMode { e_InitialViewUnknownMode = 0, e_InitialViewDetailMode = 1, e_InitialViewTileMode = 2, e_InitialViewHidden = 3 }
	作品集PDF文档初始视图模式的枚举。 更多...

Public 成员函数
	Portfolio (const Portfolio &other)
	构造函数，使用另一个PDF作品集对象。 更多...
	~Portfolio ()
	析构函数。
WString	GetInitialFileSpecKeyName () const
	获取应作为初始文档的附件（作为文件规范）的键名。 更多...
InitialViewMode	GetInitialViewMode () const
	获取初始视图模式。 更多...
PDFDoc	GetPortfolioPDFDoc () const
	获取相关的作品集PDF文档对象。 更多...
PortfolioNode	GetRootNode () const
	获取始终为文件夹节点的根节点。 更多...
SchemaFieldArray	GetSchemaFields () const
	获取架构字段。 更多...
String	GetSortingFieldKeyName () const
	获取用于排序的架构字段的键名。 更多...
bool	IsEmpty () const
	检查当前对象是否为空。 更多...
bool	IsSortedInAscending () const
	检查节点是否应按升序排序。 更多...
bool	operator != (const Portfolio &other) const
	不相等操作符。 更多...
Portfolio &	operator= (const Portfolio &other)
	赋值操作符。 更多...
bool	operator== (const Portfolio &other) const
	相等操作符。 更多...
void	SetInitialFileSpecKeyName (const wchar_t *name)
	设置应作为初始文档的附件（作为文件规范）的键名。 更多...
void	SetInitialViewMode (InitialViewMode mode)
	设置初始视图模式。 更多...
void	SetSchemaFields (const SchemaFieldArray &field_array)
	设置架构字段。 更多...
void	SetSortingFieldKeyName (const char *name)
	设置用于排序的架构字段的键名。 更多...
void	SetSortingOrder (bool use_ascending_order)
	设置布尔值以决定节点是否应按升序排序。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE	Handle () const
	获取当前对象的句柄。 更多...

静态 Public 成员函数
static Portfolio	CreatePortfolio ()
	使用自动创建的新空白PDF文档创建PDF作品集。 更多...
static Portfolio	CreatePortfolio (const foxit::pdf::PDFDoc &portfolio_pdf_doc)
	使用现有的作品集PDF文档创建PDF作品集。 更多...

详细描述

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

成员枚举类型说明

InitialViewMode

enum foxit::pdf::portfolio::Portfolio::InitialViewMode

作品集PDF文档初始视图模式的枚举。

此枚举的值应单独使用。

枚举值
e_InitialViewUnknownMode	未知初始视图模式。
e_InitialViewDetailMode	初始视图模式：详细模式，以多列格式呈现所有信息（由架构字段指定）。 注解 此模式为用户提供最多的信息。
e_InitialViewTileMode	初始视图模式：平铺模式，每个文件和文件夹节点用小图标和 信息子集（由架构字段指定）表示。 注解 此模式为用户提供有关嵌入文件的顶级信息。
e_InitialViewHidden	初始视图模式：隐藏模式。

构造及析构函数说明

Portfolio()

foxit::pdf::portfolio::Portfolio::Portfolio

(

const Portfolio &

other

)

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

参数

[in]

other

另一个书签对象。

成员函数说明

CreatePortfolio() [1/2]

static Portfolio foxit::pdf::portfolio::Portfolio::CreatePortfolio ( )

static

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

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

返回

PDF作品集对象。

CreatePortfolio() [2/2]

static Portfolio foxit::pdf::portfolio::Portfolio::CreatePortfolio ( const foxit::pdf::PDFDoc &  portfolio_pdf_doc )

static

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

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

参数

[in]

portfolio_pdf_doc

作品集PDF文档。

返回

PDF作品集对象。

GetInitialFileSpecKeyName()

WString foxit::pdf::portfolio::Portfolio::GetInitialFileSpecKeyName

(

)

const

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

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

返回

附件（作为文件规范）的键名。如果返回空字符串， 表示相关的作品集PDF文档应作为初始文档。

GetInitialViewMode()

InitialViewMode foxit::pdf::portfolio::Portfolio::GetInitialViewMode

(

)

const

获取初始视图模式。

返回

初始视图模式。请参考从 Portfolio::e_InitialViewUnknownMode 开始的值，将是这些值中的一个。

GetPortfolioPDFDoc()

PDFDoc foxit::pdf::portfolio::Portfolio::GetPortfolioPDFDoc

(

)

const

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

返回

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

GetRootNode()

PortfolioNode foxit::pdf::portfolio::Portfolio::GetRootNode

(

)

const

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

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

返回

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

GetSchemaFields()

SchemaFieldArray foxit::pdf::portfolio::Portfolio::GetSchemaFields

(

)

const

获取架构字段。

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

返回

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

GetSortingFieldKeyName()

String foxit::pdf::portfolio::Portfolio::GetSortingFieldKeyName

(

)

const

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

返回

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

IsEmpty()

bool foxit::pdf::portfolio::Portfolio::IsEmpty

(

)

const

检查当前对象是否为空。

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

返回

true 表示当前对象为空，false 表示不为空。

IsSortedInAscending()

bool foxit::pdf::portfolio::Portfolio::IsSortedInAscending

(

)

const

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

返回

true 表示节点应使用指定字段按升序排序， false 表示节点应使用指定字段按降序排序。

operator !=()

bool foxit::pdf::portfolio::Portfolio::operator !=

(

const Portfolio &

other

)

const

不相等操作符。

参数

[in]

other

另一个PDF作品集对象。此函数将检查当前对象是否不等于此对象。

返回

true 表示不相等，false 表示相等。

operator=()

Portfolio& foxit::pdf::portfolio::Portfolio::operator=

(

const Portfolio &

other

)

赋值操作符。

参数

[in]

other

另一个PDF作品集对象，其值将被赋予当前对象。

返回

当前对象本身的引用。

operator==()

bool foxit::pdf::portfolio::Portfolio::operator==

(

const Portfolio &

other

)

const

相等操作符。

参数

[in]

other

另一个PDF作品集对象。此函数将检查当前对象是否等于此对象。

返回

true 表示相等，false 表示不相等。

SetInitialFileSpecKeyName()

void foxit::pdf::portfolio::Portfolio::SetInitialFileSpecKeyName

(

const wchar_t *

name

)

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

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

参数

[in]

name

附件（作为文件规范）的键名。如果返回空字符串， 表示相关的作品集PDF文档应作为初始文档。

返回

无。

SetInitialViewMode()

void foxit::pdf::portfolio::Portfolio::SetInitialViewMode

(

InitialViewMode

mode

)

设置初始视图模式。

参数

[in]

mode

初始视图模式。请参考从 Portfolio::e_InitialViewDetailMode 开始的值， 应该是这些值中的一个，除了 Portfolio::e_InitialViewUnknownMode。

返回

无。

SetSchemaFields()

void foxit::pdf::portfolio::Portfolio::SetSchemaFields

(

const SchemaFieldArray &

field_array

)

设置架构字段。

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

参数

[in]

field_array

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

返回

无。

SetSortingFieldKeyName()

void foxit::pdf::portfolio::Portfolio::SetSortingFieldKeyName

(

const char *

name

)

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

参数

[in]

name

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

返回

无。

SetSortingOrder()

void foxit::pdf::portfolio::Portfolio::SetSortingOrder

(

bool

use_ascending_order

)

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

参数

[in]

use_ascending_order

决定排序顺序的布尔值： true 表示节点应使用指定字段按升序排序， false 表示节点应使用指定字段按降序排序。

返回

无。