API Reference
PdfOutlineItem
A PDF outline/bookmark entry discovered from the document catalog.
Inheritance
- Object
- PdfOutlineItem
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Property PdfBookmarkEditResult.Outlines
- Property PdfBookmarkPageRange.Outline
- Property PdfDocumentInfo.Outlines
- Method PdfDocumentReader.Outlines
- Method PdfDocumentReader.TryOutlines
- Property PdfLogicalDocument.Outlines
- Property PdfOutlineItem.Children
- Property PdfReadDocument.Outlines
Inherited Methods
Properties
public String Title { get; } #Bookmark text shown by PDF readers.
public Int32 Level { get; } #One-based outline nesting level.
public Nullable<Int32> PageNumber { get; } #One-based target page number when the destination could be resolved.
public Nullable<Double> DestinationTop { get; } #Top coordinate of the destination when present.
public Nullable<Double> DestinationLeft { get; } #Left coordinate of the destination when present.
public Nullable<Double> DestinationBottom { get; } #Bottom coordinate of the destination rectangle when present.
public Nullable<Double> DestinationRight { get; } #Right coordinate of the destination rectangle when present.
public Nullable<PdfOpenActionDestinationMode> DestinationMode { get; } #Viewer destination mode when the outline uses a supported destination array.
public Nullable<Double> DestinationZoom { get; } #Zoom factor of an XYZ destination when present.
public Boolean IsExpanded { get; } #Whether this outline entry is expanded according to its PDF count state.
public IReadOnlyList<PdfOutlineItem> Children { get; } #Nested outline entries.