NewOutline

Outlines

Description

Adds a new outline item to the document. Outline items can be added in a hierarchical structure. In Acrobat Reader, outlines are referred to as bookmarks.

Syntax

Delphi

function TPDFlib.NewOutline(Parent: Integer; Const Title: WideString; DestPage: Integer; DestPosition: Double): Integer;

ActiveX

Function PDFlib::NewOutline(Parent As Long, Title As String, DestPage As Long, DestPosition As Double) As Long

DLL

int DLNewOutline(int InstanceID, int Parent, wchar_t * Title, int DestPage, double DestPosition);

Parameters

Parent0 for a root item, or the ID of the parent item if this is a child item (returned by the NewOutline function). Alternatively, use the GetOutlineID function to get a valid outline ID.
TitleThe title of the outline item.
DestPageThe destination page number that this outline item links to
DestPositionThe vertical position on the destination page to link to

Return values

0The item could not be added
Non-zeroThe ID of the item which was added successfully