Table of Contents

Class PdfOutline

Namespace
PdfSharp.Pdf
Assembly
PdfSharp.dll

Represents an outline item in the outlines tree. An 'outline' is also known as a 'bookmark'.

public sealed class PdfOutline : PdfDictionary
Inheritance
object
PdfOutline
Inherited Members
Extension Methods

Constructors

PdfOutline()

Initializes a new instance of the PdfOutline class.

PdfOutline(string, PdfPage)

Initializes a new instance of the PdfOutline class.

PdfOutline(string, PdfPage, bool)

Initializes a new instance of the PdfOutline class.

PdfOutline(string, PdfPage, bool, PdfOutlineStyle)

Initializes a new instance of the PdfOutline class.

PdfOutline(string, PdfPage, bool, PdfOutlineStyle, XColor)

Initializes a new instance of the PdfOutline class.

Properties

Bottom

Gets or sets the bottom position of the page positioned on the bottom side of the window. Applies only if PageDestinationType is FitR.

DestinationPage

Gets or sets the destination page. Can be null if destination page is not given directly.

HasChildren

Gets a value indicating whether this outline object has child items.

Left

Gets or sets the left position of the page positioned on the left side of the window. Applies only if PageDestinationType is Xyz, FitV, FitR, or FitBV.

Opened

Gets or sets whether the outline item is opened (or expanded). An item read from a file is open when its /Count is positive; saving writes /Count for every item with children, negative while it is closed.

Outlines

Gets the outline collection of this node.

PageDestinationType

Gets or sets the type of the page destination.

Parent

Gets the parent of this outline item. The root item has no parent and returns null.

Right

Gets or sets the right position of the page positioned on the right side of the window. Applies only if PageDestinationType is FitR.

Style

Gets or sets the style of the outline text.

TextColor

Gets or sets the color of the text.

Title

Gets or sets the title.

Top

Gets or sets the top position of the page positioned on the top side of the window. Applies only if PageDestinationType is Xyz, FitH, FitR, ob FitBH.

Zoom

Gets or sets the zoom faction of the page. Applies only if PageDestinationType is Xyz.