foxit::pdf::portfolio::PortfolioFolderNode类 参考

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

Public 成员函数
	PortfolioFolderNode (const PortfolioNode &other)
	构造函数，使用父类对象。 更多...
	~PortfolioFolderNode ()
	析构函数。
PortfolioFileNode	AddFile (const wchar_t *file_path)
	添加一个文件（通过文件路径指定）作为子节点。 更多...
PortfolioFileNode	AddFile (foxit::common::file::StreamCallback *file_stream, const wchar_t *file_name)
	添加一个文件（通过 foxit::common::file::StreamCallback 指定）作为子节点。 更多...
PortfolioFileNode	AddPDFDoc (const PDFDoc &pdf_doc, const wchar_t *file_name)
	添加一个已加载的PDF文档作为子节点。 更多...
PortfolioFolderNode	AddSubFolder (const wchar_t *folder_name)
	添加一个新的子文件夹。 更多...
DateTime	GetCreationDateTime () const
	获取创建日期时间。 更多...
WString	GetDescription () const
	获取描述。 更多...
DateTime	GetModifiedDateTime () const
	获取最后修改日期时间。 更多...
WString	GetName () const
	获取当前文件夹节点的名称。 更多...
PortfolioNodeArray	GetSortedSubNodes () const
	获取已根据类 Portfolio 中定义的排序顺序和指定字段名称排序的子节点数组。 更多...
bool	IsRoot () const
	检查当前文件夹节点是否表示根节点。 更多...
void	RemoveSubNode (const PortfolioNode &sub_node)
	移除一个子节点。 更多...
void	SetDescription (const wchar_t *description)
	设置描述。 更多...
Public 成员函数 继承自 foxit::pdf::portfolio::PortfolioNode
	PortfolioNode (const PortfolioNode &other)
	构造函数，使用另一个作品集节点对象。 更多...
	~PortfolioNode ()
	析构函数。
Type	GetNodeType () const
	获取节点类型。 更多...
bool	IsEmpty () const
	检查当前对象是否为空。 更多...
bool	operator != (const PortfolioNode &other) const
	不相等操作符。 更多...
PortfolioNode &	operator= (const PortfolioNode &other)
	赋值操作符。 更多...
bool	operator== (const PortfolioNode &other) const
	相等操作符。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE	Handle () const
	获取当前对象的句柄。 更多...

额外继承的成员函数
Public 类型 继承自 foxit::pdf::portfolio::PortfolioNode
enum	Type { e_TypeUnknown = 0, e_TypeFolder = 1, e_TypeFile = 2 }
	作品集节点类型枚举。 更多...

详细描述

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

构造及析构函数说明

PortfolioFolderNode()

foxit::pdf::portfolio::PortfolioFolderNode::PortfolioFolderNode ( const PortfolioNode &  other )

explicit

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

参数

[in]

other

父类对象。

成员函数说明

AddFile() [1/2]

PortfolioFileNode foxit::pdf::portfolio::PortfolioFolderNode::AddFile

(

const wchar_t *

file_path

)

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

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

参数

[in]

file_path

现有本地文件的完整路径。

返回

新添加的文件节点对象。

AddFile() [2/2]

PortfolioFileNode foxit::pdf::portfolio::PortfolioFolderNode::AddFile	(	foxit::common::file::StreamCallback *	file_stream,
		const wchar_t *	file_name
	)

添加一个文件（通过 foxit::common::file::StreamCallback 指定）作为子节点。

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

参数

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

返回

新添加的文件节点对象。

AddPDFDoc()

PortfolioFileNode foxit::pdf::portfolio::PortfolioFolderNode::AddPDFDoc	(	const PDFDoc &	pdf_doc,
		const wchar_t *	file_name
	)

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

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

参数

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

返回

新添加的文件节点对象。

AddSubFolder()

PortfolioFolderNode foxit::pdf::portfolio::PortfolioFolderNode::AddSubFolder

(

const wchar_t *

folder_name

)

添加一个新的子文件夹。

参数

[in]

folder_name

新子文件夹的文件夹名称。

返回

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

GetCreationDateTime()

DateTime foxit::pdf::portfolio::PortfolioFolderNode::GetCreationDateTime

(

)

const

获取创建日期时间。

返回

创建日期时间。

GetDescription()

WString foxit::pdf::portfolio::PortfolioFolderNode::GetDescription

(

)

const

获取描述。

返回

描述字符串。

GetModifiedDateTime()

DateTime foxit::pdf::portfolio::PortfolioFolderNode::GetModifiedDateTime

(

)

const

获取最后修改日期时间。

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

返回

最后修改日期时间。

GetName()

WString foxit::pdf::portfolio::PortfolioFolderNode::GetName

(

)

const

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

返回

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

GetSortedSubNodes()

PortfolioNodeArray foxit::pdf::portfolio::PortfolioFolderNode::GetSortedSubNodes

(

)

const

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

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

返回

已排序的子节点数组。

IsRoot()

bool foxit::pdf::portfolio::PortfolioFolderNode::IsRoot

(

)

const

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

返回

true 表示当前文件夹节点是根节点， false 表示当前文件夹节点不是根节点。

RemoveSubNode()

void foxit::pdf::portfolio::PortfolioFolderNode::RemoveSubNode

(

const PortfolioNode &

sub_node

)

移除一个子节点。

参数

[in]

sub_node

表示要移除的当前节点子节点的节点对象。

返回

无。

SetDescription()

void foxit::pdf::portfolio::PortfolioFolderNode::SetDescription

(

const wchar_t *

description

)

设置描述。

参数

[in]

description

要设置的描述字符串。可以是空字符串。

返回

无。