Public 成员函数
	GetNumberTree ()
	获取页面标签数字树。更多...

	GetPageLabelPrefix (page_index)
	获取指定页面索引的页面标签(作为编号格式)中的标签前缀字符串。更多...

	GetPageLabelStart (page_index)
	获取指定页面索引的页面标签(作为编号格式)中第一个页面标签的数字部分的值。更多...

	GetPageLabelStyle (page_index)
	获取指定页面索引的页面标签(作为编号格式)中数字部分使用的编号样式。更多...

	GetPageLabelTitle (page_index)
	获取由页面索引指定的页面的完整页面标签标题。更多...

	HasPageLabel (page_index)
	检查是否使用指定页面索引定义了页面标签(作为编号格式)。更多...

	IsEmpty ()
	检查当前对象是否为空。更多...

	RemoveAll ()
	移除所有页面标签。更多...

	RemovePageLabel (page_index)
	移除使用指定页面索引定义的页面标签(作为编号格式)。更多...

	SetPageLabel (page_index, label_style, first_label_number, prefix_string)
	设置使用页面索引定义的页面标签(作为编号格式),该页面索引是范围的起始页面索引。更多...

静态 Public 属性
static	e_None: number static e_DecimalNums: number static e_UpperRomanNums: number static e_LowerRomanNums: number static e_UpperLetters: number static e_LowerLetters: number constructor(document)
	页面标签样式的枚举。更多...

详细描述

PDF 文档中的每一页都由一个整数页面索引标识,该索引表示该页面在文档中的相对位置。此外,文档可以选择定义页面标签(PDF 1.3) 以在屏幕上或打印时直观地标识每一页。页面标签标题和页面索引不需要一致: 索引是固定的,从第一页的 0 开始连续贯穿文档, 但标签标题可以以适合特定文档的任何方式指定。例如,如果文档以 12 页用罗马数字编号的前言开始, 其余文档用阿拉伯数字编号,则第一页将具有页面索引 0 和页面标签标题 i,第十二页将具有索引 11 和标签标题 xii, 第十三页将具有索引 12 和标签标题 1。
出于页面标签的目的,文档可以划分为标签范围,每个标签范围是一系列使用相同编号系统的连续页面。范围内的页面按升序顺序编号。页面的标签(作为编号格式)由基于其在标签范围内位置的数字部分组成, 可选地前面加上表示范围本身的标签前缀。例如,附录中的页面可能用标签前缀字符串 A- 的十进制数字部分标记; 生成的页面标签将是 A-1、A-2 等。请参阅<PDF Reference 1.7>中的第 8.3.1 节"页面标签"以获取更多详细信息。
此类可用于直接获取页面标签完整标题、获取页面标签(作为编号格式)的信息、设置或添加新页面标签等。

成员函数说明

◆ GetNumberTree()

FSDK::PageLabels::GetNumberTree ( )

获取页面标签数字树。

返回: 页面标签数字树。

◆ GetPageLabelPrefix()

FSDK::PageLabels::GetPageLabelPrefix ( page_index )

获取指定页面索引的页面标签(作为编号格式)中的标签前缀字符串。

此函数仅在输入页面索引具有页面标签时有用 – 这意味着页面索引是页面标签范围的起始页面索引。函数 FSDK.PageLabels.HasPageLabel 可用于检查页面索引是否具有页面标签。如果输入页面索引没有页面标签,此函数将返回空字符串。

参数

[in] page_index 作为页面标签范围起始页面索引的页面索引。有效范围: 从 0 到 (count-1)。count 是相关 PDF 文档的页面计数,可由函数 FSDK.PDFDoc.GetPageCount 检索。

返回: 标签前缀字符串。空字符串表示未使用前缀字符串或输入页面索引没有页面标签。函数 FSDK.PageLabels.HasPageLabel 可用于检查输入页面索引是否具有页面标签。

◆ GetPageLabelStart()

FSDK::PageLabels::GetPageLabelStart ( page_index )

获取指定页面索引的页面标签(作为编号格式)中第一个页面标签的数字部分的值。

后续页面从此值开始顺序编号,直到出现下一个页面标签范围。此值必须大于或等于 1。
此函数仅在输入页面索引具有页面标签时有用 – 这意味着页面索引是页面标签范围的起始页面索引。函数 FSDK.PageLabels.HasPageLabel 可用于检查页面索引是否具有页面标签。如果输入页面索引没有页面标签,此函数将返回 -1。

参数

[in] page_index 作为页面标签范围起始页面索引的页面索引。有效范围: 从 0 到 (count-1)。count 是相关 PDF 文档的页面计数,可由函数 FSDK.PDFDoc.GetPageCount 检索。

返回: 指定标签范围中第一个页面标签的数字部分的值, 将大于或等于 1。 -1 表示未定义第一个标签号或输入页面索引没有页面标签。函数 FSDK.PageLabels.HasPageLabel 可用于检查输入页面索引是否具有页面标签。

◆ GetPageLabelStyle()

FSDK::PageLabels::GetPageLabelStyle ( page_index )

获取指定页面索引的页面标签(作为编号格式)中数字部分使用的编号样式。

此函数仅在输入页面索引具有页面标签时有用 – 这意味着页面索引是页面标签范围的起始页面索引。函数 FSDK.PageLabels.HasPageLabel 可用于检查页面索引是否具有页面标签。如果输入页面索引没有页面标签,此函数将返回 -1。

参数

[in] page_index 作为页面标签范围起始页面索引的页面索引。有效范围: 从 0 到 (count-1)。count 是相关 PDF 文档的页面计数,可由函数 FSDK.PDFDoc.GetPageCount 检索。

返回: 编号样式。请参阅从 FSDK.PageLabels.e_None 开始的值, 这将是这些值之一。
-1 表示输入页面索引没有页面标签。

◆ GetPageLabelTitle()

FSDK::PageLabels::GetPageLabelTitle ( page_index )

获取由页面索引指定的页面的完整页面标签标题。

此函数可以帮助直接获取指定页面索引的完整页面标签标题, 用户无需关心此页面属于哪个页面标签范围。
只有当相关 PDF 文档没有任何页面标签范围信息时, 此函数才会为每个有效页面索引返回空字符串。

参数

[in] page_index 页面索引。有效范围: 从 0 到 (count-1)。count 是相关 PDF 文档的页面计数,可由函数 FSDK.PDFDoc.GetPageCount 检索。

返回: 页面标签完整标题字符串。

◆ HasPageLabel()

FSDK::PageLabels::HasPageLabel ( page_index )

检查是否使用指定页面索引定义了页面标签(作为编号格式)。

对于每个页面标签范围,页面标签(作为编号格式)使用其起始页面索引定义。

参数

[in] page_index 页面索引。有效范围: 从 0 到 (count-1)。count 是相关 PDF 文档的页面计数,可由函数 FSDK.PDFDoc.GetPageCount 检索。

返回: true 表示存在使用输入页面索引定义的页面标签, 而 false 表示没有使用输入页面索引定义的页面标签。

◆ IsEmpty()

FSDK::PageLabels::IsEmpty ( )

检查当前对象是否为空。

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

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

◆ RemoveAll()

FSDK::PageLabels::RemoveAll ( )

移除所有页面标签。

返回: 无。

◆ RemovePageLabel()

FSDK::PageLabels::RemovePageLabel ( page_index )

移除使用指定页面索引定义的页面标签(作为编号格式)。

移除指定页面标签后,相关标签范围将合并到前一个页面标签范围序列。
如<PDF reference 1.7>中第 8.3.1 节"页面标签"所要求,需要使用页面索引 0 定义的页面标签。因此建议用户不要单独移除页面索引 0 的页面标签。

参数

[in] page_index 作为页面标签范围起始页面索引的页面索引。有效范围: 从 0 到 (count-1)。count 是相关 PDF 文档的页面计数,可由函数 FSDK.PDFDoc.GetPageCount 检索。如<PDF reference 1.7>中第 8.3.1 节"页面标签"所要求, 不建议单独移除使用页面索引 0 定义的页面标签,

返回: 无。

◆ SetPageLabel()

FSDK::PageLabels::SetPageLabel	(	page_index	,
		label_style	,
		first_label_number	,
		prefix_string
	)

设置使用页面索引定义的页面标签(作为编号格式),该页面索引是范围的起始页面索引。

如果相关 PDF 文档中没有任何页面标签范围,此函数将将输入页面索引设置为新页面标签范围的起始页面,并将输入值用作此新范围的页面标签(作为编号格式)。指定页面之后的页面将处于相同的标签范围中, 直到出现下一个页面标签范围。特别是,在这种情况下,如果输入页面索引不是 0, 此函数还将为索引 0 添加新页面标签,默认情况下没有标签样式、没有前缀、第一个标签号 = 1 – 这是<PDF reference 1.7>中第 8.3.1 节"页面标签"所要求的。
如果输入页面索引没有页面标签,此函数将将输入页面索引设置为新页面标签范围的起始页面,并将输入值用作此新范围的页面标签(作为编号格式)。指定页面之后的页面将处于相同的标签范围中, 直到出现下一个页面标签范围。
如果输入页面索引存在页面标签,此函数将用输入值替换旧页面标签(作为编号格式)。

参数

[in]	page_index	作为页面标签范围起始页面索引的页面索引。有效范围: 从 0 到 (count-1)。count 是相关 PDF 文档的页面计数,可由函数 FSDK.PDFDoc.GetPageCount 检索。
[in]	label_style	页面标签范围中数字部分使用的编号样式。请参阅从 FSDK.PageLabels.e_None 开始的值, 应为这些值之一。
[in]	first_label_number	页面标签范围中第一个页面标签的数字部分的值。应大于或等于 1。如果输入值无效,Foxit PDF SDK 将默认使用 1。
[in]	prefix_string	标签范围中页面标签的标签前缀字符串。可以是空字符串,这意味着不使用前缀字符串。默认值: 空字符串。

返回: 无。

类成员变量说明

◆ e_None

FSDK::PageLabels::e_None

static

页面标签样式的枚举。

此枚举的值应单独使用。页面标签样式: 无编号样式。

这意味着页面标签仅由标签前缀组成,没有数字部分。

Public 成员函数

静态 Public 属性

详细描述

成员函数说明

◆ GetNumberTree()

◆ GetPageLabelPrefix()

◆ GetPageLabelStart()

◆ GetPageLabelStyle()

◆ GetPageLabelTitle()

◆ HasPageLabel()

◆ IsEmpty()

◆ RemoveAll()

◆ RemovePageLabel()

◆ SetPageLabel()

类成员变量说明

◆ e_None