FSDK::LayerTree类 参考

Public 成员函数
	constructor (document)
	从 PDF 文档构造的构造函数。 更多...
	GetDict ()
	获取当前对象的字典。 更多...
	GetOCGs ()
	从当前对象获取 "OCGs" PDF 数组。 更多...
	GetOCGsByPageIndex (page_index)
	获取在指定页面上找到的 OCG 对象数组。 更多...
	GetRootNode ()
	获取根图层节点。 更多...
	IsEmpty ()
	检查当前对象是否为空。 更多...
	SetBaseState (state)
	设置默认配置中所有图层的基本状态。 更多...

静态 Public 属性
static	e_StateOFF
	状态为关闭。
static	e_StateON
	PDF 图层基本状态的枚举。 更多...
static	e_StateUnchanged
	状态为未更改。
static	e_StateUndefined
	状态为未定义。

详细描述

PDF 图层节点存储在 PDF 图层树中。如果用户想要检索图层节点,用户必须先从 PDF 文档构造 图层树对象,然后调用函数 FSDK.LayerTree.GetRootNode 获取整个图层树的根图层节点。 然后,用户可以从根图层节点枚举图层树中的所有节点。

参见

FSDK.LayerNode

成员函数说明

constructor()

FSDK::LayerTree::constructor (   document )

inline

从 PDF 文档构造的构造函数。

构造的图层树对象可以与 PDF 文档中已存在的图层树关联。 如果 PDF 文档中没有图层树(可以通过函数 FSDK.PDFDoc.HasLayer 判断), 构造的图层树对象将构建图层相关的字典。

参数

[in]

document

一个有效的 PDF 文档对象。

GetDict()

FSDK::LayerTree::GetDict ( )

inline

获取当前对象的字典。

注解

有关详细信息,请参阅 <PDF Reference 1.7> 第 375 页中的 "Optional Content Properties Dictionary"。

返回

当前对象的字典。如果有任何错误,此函数将返回 null。

GetOCGs()

FSDK::LayerTree::GetOCGs ( )

inline

从当前对象获取 "OCGs" PDF 数组。

注解

有关详细信息,请参阅 <PDF Reference 1.7> 第 375 页中的 "Optional Content Properties Dictionary"。

返回

"OCGs" PDF 数组。 如果没有 "OCGs" 条目或发生任何错误,此函数将返回 null。

GetOCGsByPageIndex()

FSDK::LayerTree::GetOCGsByPageIndex (   page_index )

inline

获取在指定页面上找到的 OCG 对象数组。

参数

[in]

page_index

要检索的子页面的索引。有效范围:从 0 到 (count-1)。 count 由函数 FSDK.PDFDoc.GetPageCount 返回。

返回

图层节点数组对象。

GetRootNode()

FSDK::LayerTree::GetRootNode ( )

inline

获取根图层节点。

获取根图层节点后,用户可以通过 LayerNode 类的函数枚举当前图层树中的所有图层节点。

返回

根图层节点。

IsEmpty()

FSDK::LayerTree::IsEmpty ( )

inline

检查当前对象是否为空。

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

返回

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

SetBaseState()

FSDK::LayerTree::SetBaseState (   state )

inline

设置默认配置中所有图层的基本状态。

如果用户希望新状态对渲染结果产生影响,请在此函数成功后构造一个新的图层上下文对象, 然后使用新的 LayerContext 进行渲染。

参数

[in]

state

图层使用状态。请参考从 FSDK.LayerTree.e_StateON 开始的值, 这应该是这些值之一,但不包括 FSDK.LayerTree.e_StateUndefined。

返回

true 表示成功,而 false 表示失败。

类成员变量说明

e_StateON

FSDK::LayerTree::e_StateON

static

PDF 图层基本状态的枚举。

此枚举的值应单独使用。

状态为打开。