Outline (アウトライン)#

アウトライン*（または「ブックマーク」）は、*Document のプロパティです。それが 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 です。

Type:: Outline (アウトライン)

next#

このアイテムと同じレベルの次のアウトライン項目です。このアイテムがそのレベルで最後の場合、None です。

Type:: Outline (アウトライン)

page#

このブックマークが指すページ番号（0から始まる）です。

Type:: int

title#

アイテムのタイトル、または None の文字列です。

Type:: str

is_open#

サブアウトラインが展開されるべきか（True）折りたたまれるべきか（False）を示すインジケーターです。この情報はPDFリーダーソフトウェアによって解釈されます。

Type:: bool

is_external#

対象が現在のドキュメントの外部（True）かどうかを示すブール値です。

Type:: bool

uri#

リンクの対象を指定する文字列。このプロパティの意味は、プロパティ is_external と一緒に評価されるべきです。

is_external がtrueの場合： uri は、現在のPDFの外部のターゲットを指します。これは、インターネットリソース（ uri が "http://" などで始まる）、別のファイル（uri が "file:" または "file://" で始まる）、または電子メールアドレスなどのその他のサービス（ uri が "mailto:" で始まる）である可能性があります。
is_external がfalseの場合：uri は None になるか、または内部の位置を指します。PDFドキュメントの場合、これは1から始まるページ番号 nnnn を示すために #nnnn であるか、名前付きの場所を示します。他のドキュメントタイプの場合、形式は異なります。たとえば、XPSドキュメントのページ番号2（1から始まる）の場合は "../FixedDoc.fdoc#PG_2_LNK_1" です。

Type:: str

dest#

リンクの宛先詳細オブジェクトです。

Type:: linkDest

Do you have any feedback on this page?

This software is provided AS-IS with no warranty, either express or implied. This software is distributed under license and may not be copied, modified or distributed except as expressly authorized under the terms of that license. Refer to licensing information at artifex.com or contact Artifex Software Inc., 39 Mesa Street, Suite 108A, San Francisco CA 94129, United States for further information.