FSDK::PDFNumberTree类 参考

Public 成员函数
	constructor (document, type)
	带参数的构造函数。 更多...
	GetObj (number)
	获取指定键整数的值（作为PDF对象）。 更多...
	GetType ()
	获取当前数字树的类型。 更多...
	HasNumber (number)
	检查当前数字树中是否存在指定的键整数。 更多...
	IsEmpty ()
	检查当前对象是否为空。 更多...
	RemoveAllObjs ()
	从当前数字树中删除所有键整数及其值（作为PDF对象）。 更多...
	RemoveObj (number)
	从当前数字树中删除一个键整数及其值（作为PDF对象）。 更多...
	SetObj (number, pdf_object)
	设置指定键整数的值（作为PDF对象）。如果键整数不存在，它将被 添加到当前数字树及其值中。 更多...

静态 Public 属性
static	e_PageLabels
	数字树类型的枚举。 更多...

详细描述

数字树是PDF中一种常见的数据结构。数字树与名称树类似，除了 数字树中的键是整数而不是字符串，并且按升序数字顺序排序。 数字树具有以下特征：

• 数字树中的键整数按升序数字顺序排序，并且同一数字树中的每个键整数 都是唯一的；
• 与键整数关联的值可以是任何类型的对象，具体取决于数字树的用途；
• 数字树可以表示任意大的键值对集合，可以高效地查找 而无需从PDF文件读取整个数据结构。

类 FSDK.PDFNumberTree 用于与具有指定类型的现有数字树关联或创建一个数字树。 它提供了在数字树中获取键值对、设置/添加/删除任何键值对的函数。 目前，类 FSDK.PDFNumberTree 可以与PDF文档中定义的以下数字树关联：

• 页面标签数字树（类型为 FSDK.PDFNumberTree.e_PageLabels）， 定义文档的页面标签。此树中的键是页面索引； 相应的值是页面标签字典（请参阅<PDF Reference 1.7> P594 第8.3.1节， "Page Labels"）。每个页面索引表示标签范围中的第一个页面，指定的 页面标签字典适用于该范围。树必须包括页面索引0的值。

成员函数说明

constructor()

FSDK::PDFNumberTree::constructor	(	document	,
		type
	)

带参数的构造函数。

如果PDF文档中存在指定类型的数字树， 此函数仅构造一个PDF数字树对象以与该数字树关联。 如果PDF文档中没有这样的数字树，构造的PDF数字树对象可用于 在PDF文档中创建这样的数字树并向数字树添加项。

参数

[in]	document	有效的PDF文档对象。
[in]	type	数字树的类型。请参考从 FSDK.PDFNumberTree.e_PageLabels 开始的值，这应是这些值之一。

GetObj()

FSDK::PDFNumberTree::GetObj

(

number

)

获取指定键整数的值（作为PDF对象）。

参数

[in]

number

作为键的整数。

返回

FSDK.PDFObject 对象。返回PDF对象的类型取决于当前数字树的用途。 请参考类 FSDK.PDFNumberTree 的注释以获取更多详细信息。 如果未找到，此函数将返回 null。

GetType()

FSDK::PDFNumberTree::GetType

(

)

获取当前数字树的类型。

返回

当前数字树的类型。请参考从 FSDK.PDFNumberTree.e_PageLabels 开始的值， 这将是这些值之一。

HasNumber()

FSDK::PDFNumberTree::HasNumber

(

number

)

检查当前数字树中是否存在指定的键整数。

参数

[in]

number

表示要检查的键的整数。

返回

true表示指定的整数存在于当前数字树中， false表示指定的整数不存在于当前数字树中。

IsEmpty()

FSDK::PDFNumberTree::IsEmpty

(

)

检查当前对象是否为空。

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

返回

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

RemoveAllObjs()

FSDK::PDFNumberTree::RemoveAllObjs

(

)

从当前数字树中删除所有键整数及其值（作为PDF对象）。

返回

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

RemoveObj()

FSDK::PDFNumberTree::RemoveObj

(

number

)

从当前数字树中删除一个键整数及其值（作为PDF对象）。

如果输入的键整数在当前数字树中不存在，此函数将 直接返回 true。

参数

[in]

number

要删除的键整数。

返回

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

SetObj()

FSDK::PDFNumberTree::SetObj	(	number	,
		pdf_object
	)

设置指定键整数的值（作为PDF对象）。如果键整数不存在，它将被 添加到当前数字树及其值中。

参数

[in]	number	作为键的整数。
[in]	pdf_object	要设置为键值的PDF对象。它不应为 null。 此PDF对象的类型应与当前数字树匹配；否则， 输入的PDF对象无效。请参考类 FSDK.PDFNumberTree 的注释 以获取更多详细信息。 此函数成功后，用户不应释放此PDF对象。

返回

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

类成员变量说明

e_PageLabels

FSDK::PDFNumberTree::e_PageLabels

static

数字树类型的枚举。

此枚举的值应单独使用。"页面标签"数字树。