大纲#
文档大纲(也称为“书签”)是 Document 的一个属性(参见 Document.outline
)。如果不是 None
,则表示文档的第一个大纲项。其属性反过来定义了该项的特征,并指向“水平”或向下方向的其他大纲项。通过跟随这些“指针”,可以恢复例如传统目录 (TOC) 的所有大纲项的完整树状结构。
方法 / 属性 |
简要说明 |
---|---|
向下方向的下一项 |
|
同一级别的下一项 |
|
页码(基于 0) |
|
标题 |
|
进一步指定大纲目标的字符串 |
|
文档外部目标 |
|
子大纲是展开还是折叠 |
|
指向目标详情对象 |
类 API
- class 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 之外的某个目标,该目标可能是一个互联网资源(uri
以http://
或类似开头)、另一个文件(uri
以file:
或file://
开头)或某些其他服务,例如电子邮件地址(uri
以mailto:
开头)。is_external
为 false:uri
将为None
或指向一个内部位置。对于 PDF 文档,这应为 #nnnn 表示一个基于 1 的 (!) 页码 nnnn,或是一个命名位置。对于其他文档类型,格式有所不同,例如 XPS 文档中的页码 2(基于 1)表示为 “../FixedDoc.fdoc#PG_2_LNK_1”。
- 类型:
str