Click or drag to resize

PdfOutlineCollection Class

A PDF document may contain a document outline that the conforming reader may display on the screen, allowing the user to navigate interactively from one part of the document to another. The outline consists of a tree-structured hierarchy of outline items (sometimes called bookmarks), which serve as a visual table of contents to display the document’s structure to the user.

PdfOutlineCollection represents a collection of outline items.

Note  Note
This collection is implemented as doubly linked list and therefore methods that use random access (index) are an O(n) operations, where n is Count.
Inheritance Hierarchy
SystemObject
  SautinSoft.PdfPdfObject
    SautinSoft.PdfPdfCollection
      SautinSoft.PdfPdfCollectionPdfOutline
        SautinSoft.PdfPdfOutlineCollection

Namespace: SautinSoft.Pdf
Assembly: SautinSoft.Pdf (in SautinSoft.Pdf.dll) Version: 2025.10.22
Syntax
Copy
public sealed class PdfOutlineCollection : PdfCollection<PdfOutline>, 
	IList, ICollection, IEnumerable, IList<PdfOutline>, 
	ICollection<PdfOutline>, IEnumerable<PdfOutline>

The PdfOutlineCollection type exposes the following members.

Properties
 NameDescription
Public propertyFirst(Required if the item has any descendants; shall be an indirect reference) The first of this item’s immediate children in the outline hierarchy.
Public propertyLast(Required if the item has any descendants; shall be an indirect reference) The last of this item’s immediate children in the outline hierarchy.
Top
Methods
 NameDescription
Public methodAddAfter(PdfOutline, PdfOutline) Adds the specified new PdfOutline after the specified existing PdfOutline in the PdfOutlineCollection.
Public methodAddAfter(PdfOutline, String) Adds a new PdfOutline with the specified title after the specified existing PdfOutline in the PdfOutlineCollection.
Public methodAddBefore(PdfOutline, PdfOutline) Adds the specified new PdfOutline before the specified existing PdfOutline in the PdfOutlineCollection.
Public methodAddBefore(PdfOutline, String) Adds a new PdfOutline with the specified title before the specified existing PdfOutline in the PdfOutlineCollection.
Public methodAddFirst(PdfOutline) Adds the specified PdfOutline at the start of the PdfOutlineCollection.
Public methodAddFirst(String) Adds a new PdfOutline with the specified title at the start of the PdfOutlineCollection.
Public methodAddLast(PdfOutline) Adds the specified PdfOutline at the end of the PdfOutlineCollection.
Public methodAddLast(String) Adds a new PdfOutline with the specified title at the end of the PdfOutlineCollection.
Public methodRemoveFirst Removes the PdfOutline at the start of the PdfOutlineCollection.
Public methodRemoveLast Removes the PdfOutline at the end of the PdfOutlineCollection.
Top
Extension Methods
 NameDescription
Public Extension MethodGetArray Gets the PdfArray that serves as a backing storage of the specified PdfCollection.
(Defined by PdfObjectExtensions)
Public Extension MethodGetArray Gets the PdfArray that serves as a backing storage of the specified PdfObject or if no PdfArray serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Public Extension MethodGetDictionary Gets the PdfDictionary that serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Public Extension MethodGetOrAddArray Gets the PdfArray that serves as a backing storage of the specified PdfCollection.
(Defined by PdfObjectExtensions)
Public Extension MethodGetOrAddDictionary Gets the PdfDictionary that serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Top
See Also