FSDK::PortfolioFolderNode类 参考

Public 成员函数
	AddFile (file_path)
	添加文件(由文件路径指定)作为子节点。 更多...
	AddFile (file_stream, file_name)
	添加文件(使用 FSDK.StreamCallback 指定)作为子节点。 更多...
	AddPDFDoc (pdf_doc, file_name)
	添加已加载的 PDF 文档作为子节点。 更多...
	AddSubFolder (folder_name)
	添加新子文件夹。 更多...
	GetCreationDateTime ()
	获取创建日期时间。 更多...
	GetDescription ()
	获取描述。 更多...
	GetModifiedDateTime ()
	获取最后修改日期时间。 更多...
	GetName ()
	获取当前文件夹节点的名称。 更多...
	GetSortedSubNodes ()
	获取子节点数组,已根据类 FSDK.Portfolio 中定义的排序顺序和指定字段名称进行排序。 更多...
	IsRoot ()
	检查当前文件夹节点是否表示根节点。 更多...
	RemoveSubNode (sub_node)
	移除子节点。 更多...
	SetDescription (description)
	设置描述。 更多...

详细描述

组合文件夹节点用作文件夹,可以包含文件和其他文件夹作为子节点。
类 FSDK.PortfolioFolderNode 派生自类 FSDK.PortfolioNode。 它提供访问文件夹节点的函数: 向文件夹节点添加文件/文件夹、从文件夹节点移除子节点、 按排序顺序获取所有子节点,以及获取/设置文件夹节点的某些属性。

成员函数说明

AddFile() [1/2]

FSDK::PortfolioFolderNode::AddFile

(

file_path

)

添加文件(由文件路径指定)作为子节点。

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

参数

[in]

file_path

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

返回

新添加的文件节点对象。

AddFile() [2/2]

FSDK::PortfolioFolderNode::AddFile	(	file_stream	,
		file_name
	)

添加文件(使用 FSDK.StreamCallback 指定)作为子节点。

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

参数

[in]	file_stream	由用户实现的 FSDK.StreamCallback 对象, 用于读取文件内容。
[in]	file_name	流回调指定的文件的文件名。此名称将 用于与返回的文件节点对象相关的文件规范。

返回

新添加的文件节点对象。

AddPDFDoc()

FSDK::PortfolioFolderNode::AddPDFDoc	(	pdf_doc	,
		file_name
	)

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

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

参数

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

返回

新添加的文件节点对象。

AddSubFolder()

FSDK::PortfolioFolderNode::AddSubFolder

(

folder_name

)

添加新子文件夹。

参数

[in]

folder_name

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

返回

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

GetCreationDateTime()

FSDK::PortfolioFolderNode::GetCreationDateTime

(

)

获取创建日期时间。

返回

创建日期时间。

GetDescription()

FSDK::PortfolioFolderNode::GetDescription

(

)

获取描述。

返回

描述字符串。

GetModifiedDateTime()

FSDK::PortfolioFolderNode::GetModifiedDateTime

(

)

获取最后修改日期时间。

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

返回

最后修改日期时间。

GetName()

FSDK::PortfolioFolderNode::GetName

(

)

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

返回

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

GetSortedSubNodes()

FSDK::PortfolioFolderNode::GetSortedSubNodes

(

)

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

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

返回

已排序子节点的数组。

IsRoot()

FSDK::PortfolioFolderNode::IsRoot

(

)

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

返回

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

RemoveSubNode()

FSDK::PortfolioFolderNode::RemoveSubNode

(

sub_node

)

移除子节点。

参数

[in]

sub_node

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

返回

无。

SetDescription()

FSDK::PortfolioFolderNode::SetDescription

(

description

)

设置描述。

参数

[in]

description

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

返回

无。