大纲#

文档大纲(也称为“书签”)是 Document 的一个属性(参见 Document.outline)。如果不是 None,则表示文档的第一个大纲项。其属性反过来定义了该项的特征,并指向“水平”或向下方向的其他大纲项。通过跟随这些“指针”,可以恢复例如传统目录 (TOC) 的所有大纲项的完整树状结构。

方法 / 属性

简要说明

Outline.down

向下方向的下一项

Outline.next

同一级别的下一项

Outline.page

页码(基于 0)

Outline.title

标题

Outline.uri

进一步指定大纲目标的字符串

Outline.is_external

文档外部目标

Outline.is_open

子大纲是展开还是折叠

Outline.dest

指向目标详情对象

类 API

class Outline#
down#

下一层级中的下一个大纲项。如果该项没有子项,则为 None

类型:

Outline

next#

与此项位于同一层级的下一个大纲项。如果这是该层级中的最后一项,则为 None

类型:

Outline

page#

此书签指向的页码(基于 0)。

类型:

int

title#

项的标题,为字符串或 None

类型:

str

is_open#

指示器,显示是否有子大纲应被展开 (True) 或折叠 (False)。此信息由 PDF 阅读器软件解释。

类型:

bool

is_external#

一个布尔值,指定目标是否在当前文档之外 (True)。

类型:

bool

uri#

一个指定链接目标的字符串。此属性的含义应结合属性 is_external 进行评估

  • is_external 为 true:uri 指向当前 PDF 之外的某个目标,该目标可能是一个互联网资源(urihttp:// 或类似开头)、另一个文件(urifile:file:// 开头)或某些其他服务,例如电子邮件地址(urimailto: 开头)。

  • is_external 为 false:uri 将为 None 或指向一个内部位置。对于 PDF 文档,这应为 #nnnn 表示一个基于 1 的 (!) 页码 nnnn,或是一个命名位置。对于其他文档类型,格式有所不同,例如 XPS 文档中的页码 2(基于 1)表示为 “../FixedDoc.fdoc#PG_2_LNK_1”。

类型:

str

dest#

链接目标详情对象。

类型:

linkDest


本软件按“原样”提供,不提供任何明示或暗示的保证。本软件按许可分发,除非在该许可条款明确授权,否则不得复制、修改或分发。请参阅 artifex.com 上的许可信息,或联系 Artifex Software Inc., 39 Mesa Street, Suite 108A, San Francisco CA 94129, United States 获取更多信息。