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
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: 2024.8.8

Syntax

Copy

public sealed class PdfOutlineCollection : PdfCollection<PdfOutline>, 
	IList, ICollection, IEnumerable, IList<PdfOutline>, 
	ICollection<PdfOutline>, IEnumerable<PdfOutline>

Public NotInheritable Class PdfOutlineCollection
	Inherits PdfCollection(Of PdfOutline)
	Implements IList, ICollection, IEnumerable, IList(Of PdfOutline), 
	ICollection(Of PdfOutline), IEnumerable(Of PdfOutline)

The PdfOutlineCollection type exposes the following members.

Properties

	Name	Description
	Count	Gets the number of elements contained in the PdfCollection. (Inherited from PdfCollection)
	First	(Required if the item has any descendants; shall be an indirect reference) The first of this item’s immediate children in the outline hierarchy.
	Item	Gets or sets the element at the specified index. (Inherited from PdfCollectionT)
	Last	(Required if the item has any descendants; shall be an indirect reference) The last of this item’s immediate children in the outline hierarchy.
	Metadata	(Optional; PDF 1.4) A metadata stream containing metadata for the component. (Inherited from PdfObject)

Top

Methods

	Name	Description
	Add	Adds an element to the end of the PdfCollectionT. (Inherited from PdfCollectionT)
	AddAfter(PdfOutline, PdfOutline)	Adds the specified new PdfOutline after the specified existing PdfOutline in the PdfOutlineCollection.
	AddAfter(PdfOutline, String)	Adds a new PdfOutline with the specified title after the specified existing PdfOutline in the PdfOutlineCollection.
	AddBefore(PdfOutline, PdfOutline)	Adds the specified new PdfOutline before the specified existing PdfOutline in the PdfOutlineCollection.
	AddBefore(PdfOutline, String)	Adds a new PdfOutline with the specified title before the specified existing PdfOutline in the PdfOutlineCollection.
	AddFirst(PdfOutline)	Adds the specified PdfOutline at the start of the PdfOutlineCollection.
	AddFirst(String)	Adds a new PdfOutline with the specified title at the start of the PdfOutlineCollection.
	AddLast(PdfOutline)	Adds the specified PdfOutline at the end of the PdfOutlineCollection.
	AddLast(String)	Adds a new PdfOutline with the specified title at the end of the PdfOutlineCollection.
	Clear	Removes all elements from the PdfCollection. (Inherited from PdfCollection)
	Contains	Determines whether an element is in the PdfCollectionT. (Inherited from PdfCollectionT)
	CopyTo	Copies the entire PdfCollectionT to a compatible one-dimensional array, starting at the specified index of the target array. (Inherited from PdfCollectionT)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetEnumerator	Returns an enumerator that iterates through the PdfCollectionT. (Inherited from PdfCollectionT)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	IndexOf	Searches for the specified element and returns the zero-based index of the first occurrence within the entire PdfCollectionT. (Inherited from PdfCollectionT)
	Insert	Inserts an element into the PdfCollectionT at the specified index. (Inherited from PdfCollectionT)
	Remove	Removes the first occurrence of a specific element from the PdfCollectionT. (Inherited from PdfCollectionT)
	RemoveAt	Removes the element at the specified index of the PdfCollection. (Inherited from PdfCollection)
	RemoveFirst	Removes the PdfOutline at the start of the PdfOutlineCollection.
	RemoveLast	Removes the PdfOutline at the end of the PdfOutlineCollection.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Extension Methods

	Name	Description
	GetArray	Gets the PdfArray that serves as a backing storage of the specified PdfCollection. (Defined by PdfObjectExtensions)
	GetArray	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)
	GetDictionary	Gets the PdfDictionary that serves as a backing storage of the specified PdfObject. (Defined by PdfObjectExtensions)
	GetOrAddArray	Gets the PdfArray that serves as a backing storage of the specified PdfCollection. (Defined by PdfObjectExtensions)
	GetOrAddDictionary	Gets the PdfDictionary that serves as a backing storage of the specified PdfObject. (Defined by PdfObjectExtensions)

Top

Reference

SautinSoft.Pdf Namespace

Other Resources

PDF Specification ISO 32000-1:2008, section '12.3.3 Document Outline'

Outlines example