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
  GemBox.PdfPdfObject
    GemBox.PdfPdfCollection
      GemBox.PdfPdfCollectionPdfOutline
        GemBox.PdfPdfOutlineCollection

Namespace:  GemBox.Pdf
Assembly:  GemBox.Pdf (in GemBox.Pdf.dll) Version: 13.0.35.1000
Syntax
public sealed class PdfOutlineCollection : PdfCollection<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.
Top
Methods
  NameDescription
Public methodAdd (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(String)
Adds a new PdfOutline with the specified title at the start of the PdfOutlineCollection.
Public methodAddFirst(PdfOutline)
Adds the specified PdfOutline at the start of the PdfOutlineCollection.
Public methodAddLast(String)
Adds a new PdfOutline with the specified title at the end of the PdfOutlineCollection.
Public methodAddLast(PdfOutline)
Adds the specified PdfOutline at the end of the PdfOutlineCollection.
Public methodClear
Removes all elements from the PdfCollection.
(Inherited from PdfCollection.)
Public methodContains (Inherited from PdfCollectionT.)
Public methodCopyTo (Inherited from PdfCollectionT.)
Public methodGetEnumerator
Returns an enumerator that iterates through the PdfOutlineCollection.
Public methodIndexOf (Inherited from PdfCollectionT.)
Public methodInsert (Inherited from PdfCollectionT.)
Public methodRemove (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.
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 MethodGetDictionary
Gets the PdfDictionary that serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions.)
Top
See Also