PdfOutlineItem Object
Overview
PdfOutlineItem represents an individual outline item (bookmark) in the document's outline hierarchy. This object is obtainable via the PdfOutline collection. For more information on outlines, see Section 10.2 - Outlines.
Member List
Properties
Children As PdfOutline (Read-only)
Returns an instance of the PdfOutline collection representing this item's children.
Index As Long (Read-only)
Returns this item's 1-based index in the document's Outline collection.
Level As Long (Read-only)
Returns this item's level (depth) in the hierarchy. Top-level items' depth is 0, their direct children's depth is 1, etc.
Title As String (Read/Write)
Returns or specifies this item's text string (title).
Methods
Sub SetAction(Action As PdfAction)
Associates an action specified by Action with this bookmark. This method cannot be called if a destination is already associated with this item.
Sub SetDest(Dest As PdfDest)
Associates a destination specified by Dest with this bookmark. This method cannot be called if an action is already associated with this item.
Sub SetParams(Param As Variant)
Sets various appearance parameters for this outline item.
Param is a PdfParam object or parameter string specifying the following parameters:
- Bold (optional) - if set to True, the item's text appears in bold. False by default.
- Italic (optional) - if set to True, the item's text appears in italic. False by default.
- Expanded (optional) - if set to False, the item will initially appear collapsed (closed). True by default.
- Color (optional) - specifies the item's color by name or hex number. Black by default.
- R, G, B (optional): an alternative way to specify the item's color
