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: 2024.6.18
Syntax
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 propertyCount Gets the number of elements contained in the PdfCollection.
(Inherited from PdfCollection)
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 propertyItem Gets or sets the element at the specified index.
(Inherited from PdfCollectionT)
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.
Public propertyMetadata(Optional; PDF 1.4) A metadata stream containing metadata for the component.
(Inherited from PdfObject)
Top
Methods
 NameDescription
Public methodAdd Adds an element to the end of the PdfCollectionT.
(Inherited from PdfCollectionT)
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 methodClear Removes all elements from the PdfCollection.
(Inherited from PdfCollection)
Public methodContains Determines whether an element is in the PdfCollectionT.
(Inherited from PdfCollectionT)
Public methodCopyTo Copies the entire PdfCollectionT to a compatible one-dimensional array, starting at the specified index of the target array.
(Inherited from PdfCollectionT)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetEnumerator Returns an enumerator that iterates through the PdfCollectionT.
(Inherited from PdfCollectionT)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodIndexOf Searches for the specified element and returns the zero-based index of the first occurrence within the entire PdfCollectionT.
(Inherited from PdfCollectionT)
Public methodInsert Inserts an element into the PdfCollectionT at the specified index.
(Inherited from PdfCollectionT)
Public methodRemove Removes the first occurrence of a specific element from the PdfCollectionT.
(Inherited from PdfCollectionT)
Public methodRemoveAt Removes the element at the specified index of the PdfCollection.
(Inherited from PdfCollection)
Public methodRemoveFirst Removes the PdfOutline at the start of the PdfOutlineCollection.
Public methodRemoveLast Removes the PdfOutline at the end of the PdfOutlineCollection.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
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