Outline#

Outline (or “bookmark”), is a property of Document. If not null, it stands for the first outline item of the document. Its properties in turn define the characteristics of this item and also point to other outline items in “horizontal” or downward direction. The full tree of all outline items for e.g. a conventional table of contents (TOC) can be recovered by following these “pointers”.

Method / Attribute

Short Description

Outline.Down

Next item downwards

Outline.Next

Next item same level

Outline.Page

Page number (0-based)

Outline.Title

Title

Outline.Uri

String further specifying outline target

Outline.IsExternal

Target outside document

Outline.IsOpen

Whether sub-outlines are open or collapsed

Outline.Dest

Points to destination details object

Class API

class Outline#
Destination()#
Down#

The next outline item on the next level down. Is Null if the item has no children.

Type:

Outline

Next#

The next outline item at the same level as this item. Is Null if this is the last one in its level.

Type:

Outline

Page#

The page number (0-based) this bookmark points to.

Type:

int

Title#

The item’s title as a string or Null.

Type:

string

IsOpen#

Indicator showing whether any sub-outlines should be expanded (true) or be collapsed (false). This information is interpreted by PDF reader software.

Type:

bool

IsExternal#

A bool specifying whether the target is outside (true) of the current document.

Type:

bool

Uri#

A string specifying the link target. The meaning of this property should be evaluated in conjunction with property IsExternal:

  • IsExternal is true: Uri points to some target outside the current PDF, which may be an internet resource (Uri starts with http:// or similar), another file (Uri starts with “file:” or file://) or some other service like an e-mail address (Uri starts with mailto:).

  • IsExternal is false: Uri will be null or point to an internal location. In case of PDF documents, this should either be #nnnn to indicate a 1-based (!) page number nnnn, or a named location. The format varies for other document types, for example “../FixedDoc.fdoc#PG_2_LNK_1” for page number 2 (1-based) in an XPS document.

Type:

string

Dest#

The link destination details object.

Type:

linkDest