fsdk.Portfolio类 参考

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

详细描述

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

成员函数说明

GetInitialFileSpecKeyName()

def fsdk.Portfolio.GetInitialFileSpecKeyName

(

)

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

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

返回

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

GetInitialViewMode()

def fsdk.Portfolio.GetInitialViewMode

(

)

获取初始视图模式。

返回

初始视图模式。请参考从 fsdk.PortfolioE_InitialViewUnknownMode 开始的值，将是这些值中的一个。

GetPortfolioPDFDoc()

def fsdk.Portfolio.GetPortfolioPDFDoc

(

)

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

返回

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

GetRootNode()

def fsdk.Portfolio.GetRootNode

(

)

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

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

返回

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

GetSchemaFields()

def fsdk.Portfolio.GetSchemaFields

(

)

获取架构字段。

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

返回

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

GetSortingFieldKeyName()

def fsdk.Portfolio.GetSortingFieldKeyName

(

)

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

返回

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

IsEmpty()

def fsdk.Portfolio.IsEmpty

(

)

检查当前对象是否为空。

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

返回

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

IsSortedInAscending()

def fsdk.Portfolio.IsSortedInAscending

(

)

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

返回

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

SetInitialFileSpecKeyName()

def fsdk.Portfolio.SetInitialFileSpecKeyName

(

name

)

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

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

参数

[in]

name

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

返回

无。

SetInitialViewMode()

def fsdk.Portfolio.SetInitialViewMode

(

mode

)

设置初始视图模式。

参数

[in]

mode

初始视图模式。请参考从 fsdk.PortfolioE_InitialViewDetailMode 开始的值， 应该是这些值中的一个，除了 fsdk.PortfolioE_InitialViewUnknownMode 。

返回

无。

SetSchemaFields()

def fsdk.Portfolio.SetSchemaFields

(

field_array

)

设置架构字段。

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

参数

[in]

field_array

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

返回

无。

SetSortingFieldKeyName()

def fsdk.Portfolio.SetSortingFieldKeyName

(

name

)

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

参数

[in]

name

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

返回

无。

SetSortingOrder()

def fsdk.Portfolio.SetSortingOrder

(

use_ascending_order

)

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

参数

[in]

use_ascending_order

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

返回

无。