Class

PDFOutline

A PDFOutline object is an element in a tree-structured hierarchy that can represent the structure of a PDF document.

Declaration

@interface PDFOutline : NSObject

Overview

An outline is an optional component of a PDF document, useful for viewing the structure of the document and for navigating within it.

Outlines are created by the document’s author. If you represent a PDF document outline using outline objects, the root of the hierarchy is obtained from the PDF document itself. This root outline is not visible and serves merely as a container for the visible outlines.

Topics

Initializing an Outline

- init

Initializes a PDFOutline object.

- initWithDocument:

Initializes an outline with the specified PDF document.

Getting Information About an Outline

document

Returns the document with which the outline is associated.

numberOfChildren

Returns the number of child outline objects in the outline.

parent

Returns the parent outline object of the outline (returns NULL if called on the root outline object).

- childAtIndex:

Returns the child outline object at the specified index.

index

Returns the index of the outline.

Managing Outline Labels

label

Returns the label for the outline.

Managing Actions and Destinations

destination

Returns the destination associated with the outline.

action

Returns the action performed when users click the outline.

Changing an Outline Hierarchy

- insertChild:atIndex:

Inserts the specified outline object at the specified index.

- removeFromParent

Removes the outline object from its parent (does nothing if outline object is the root outline object).

Managing the Disclosure of an Outline Object

isOpen

Returns a Boolean value that indicates whether the outline object is initially disclosed.

Relationships

Inherits From

See Also

Content Model

PDFDocument

An object that represents PDF data or a PDF file and defines methods for writing, searching, and selecting PDF data.

PDFPage

PDFPage, a subclass of NSObject, defines methods used to render PDF pages and work with annotations, text, and selections.

PDFSelection

A PDFSelection object identifies a contiguous or noncontiguous selection of text in a PDF document.