Click or drag to resize

PdfOutline 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.

PdfOutline represents a single outline item that is a node in the doubly linked list of outline items represented by PdfOutlineCollection.

Inheritance Hierarchy
SystemObject
  SautinSoft.PdfPdfObject
    SautinSoft.PdfPdfOutline

Namespace: SautinSoft.Pdf
Assembly: SautinSoft.Pdf (in SautinSoft.Pdf.dll) Version: 2024.8.8
Syntax
Copy
public sealed class PdfOutline : PdfObject

The PdfOutline type exposes the following members.

Properties
 NameDescription
Public propertyActions(Optional; PDF 1.1; shall not be present if a Dest entry is present) The action that shall be performed when this item is activated (see 12.6, "Actions").
Public propertyClosed Gets or sets a value indicating whether this PdfOutline is closed.
Public propertyColor(Optional; PDF 1.4)A DeviceRGB color used for the outline entry’s text.
Public propertyDestination(Optional; shall not be present if an A entry is present) The destination that shall be displayed when this item is activated (see 12.3.2, "Destinations").
Public propertyDestinationName(Optional; shall not be present if an A entry is present) The named destination that shall be displayed when this item is activated (see 12.3.2.3, "Named Destinations").
Public propertyMetadata(Optional; PDF 1.4) A metadata stream containing metadata for the component.
(Inherited from PdfObject)
Public propertyNext(Required for all but the last item at each level; shall be an indirect reference) The next item at this outline level.
Public propertyOutlines Gets the PdfOutlines contained directly under this PdfOutline.
Public propertyParent Gets the parent PdfOutline of this PdfOutline in the outline hierarchy.
Public propertyParentCollection Gets the PdfOutlineCollection that the PdfOutline belongs to.
Public propertyPrevious(Required for all but the first item at each level; shall be an indirect reference) The previous item at this outline level.
Public propertyTitle(Required) The text that shall be displayed on the screen for this item.
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodSetDestination

Sets the explicit destination that shall be displayed when this item is activated (see 12.3.2.2, "Explicit Destinations").

parameters represent the following values depending on the viewType parameter:

FitRectangle
Left, Bottom, Right and Top.
LeftTopZoom
Left, Top and Zoom.
FitPageVertical and FitContentVertical
Left.
FitPageHorizontal and FitContentHorizontal
Top.
FitPage and FitContent
None.
Public methodToString Returns a String that represents this PdfOutline instance.
(Overrides ObjectToString)
Top
Extension Methods
 NameDescription
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 MethodGetOrAddDictionary Gets the PdfDictionary that serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Top
See Also