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, ICloneable, IEnumerable<KeyValuePair<string, PdfItem?>>, IEnumerable

Inheritance

object

PdfItem

PdfObject

PdfDictionary

PdfOutline

Implements

ICloneable

IEnumerable<KeyValuePair<string, PdfItem>>

IEnumerable

Inherited Members

PdfDictionary.Clone()

PdfDictionary.GetEnumerator()

PdfDictionary.ToString()

PdfDictionary.CreateStream(byte[])

PdfDictionary.Elements

PdfDictionary.Stream

PdfObject.Owner

PdfObject.Comment

PdfObject.IsIndirect

PdfObject.Internals

PdfObject.Reference

PdfObject.ReferenceNotNull

object.GetType()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PdfOutline()

Initializes a new instance of the PdfOutline class.

public PdfOutline()

PdfOutline(PdfDictionary)

Initializes a new instance from an existing dictionary. Used for object type transformation.

public PdfOutline(PdfDictionary dict)

Parameters

dict PdfDictionary

PdfOutline(string, PdfPage)

Initializes a new instance of the PdfOutline class.

public PdfOutline(string title, PdfPage destinationPage)

Parameters

title string

The outline text.

destinationPage PdfPage

The destination page.

PdfOutline(string, PdfPage, bool)

Initializes a new instance of the PdfOutline class.

public PdfOutline(string title, PdfPage destinationPage, bool opened)

Parameters

title string

The outline text.

destinationPage PdfPage

The destination page.

opened bool

Specifies whether the node is displayed expanded (opened) or collapsed.

PdfOutline(string, PdfPage, bool, PdfOutlineStyle)

Initializes a new instance of the PdfOutline class.

public PdfOutline(string title, PdfPage destinationPage, bool opened, PdfOutlineStyle style)

Parameters

title string

The outline text.

destinationPage PdfPage

The destination page.

opened bool

Specifies whether the node is displayed expanded (opened) or collapsed.

style PdfOutlineStyle

The font style used to draw the outline text.

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

Initializes a new instance of the PdfOutline class.

public PdfOutline(string title, PdfPage destinationPage, bool opened, PdfOutlineStyle style, XColor textColor)

Parameters

title string

The outline text.

destinationPage PdfPage

The destination page.

opened bool

Specifies whether the node is displayed expanded (opened) or collapsed.

style PdfOutlineStyle

The font style used to draw the outline text.

textColor XColor

The color used to draw the outline text.

Properties

Bottom

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

public double Bottom { get; set; }

Property Value

double

DestinationPage

Gets or sets the destination page.

public PdfPage DestinationPage { get; set; }

Property Value

PdfPage

HasChildren

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

public bool HasChildren { get; }

Property Value

bool

Left

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

public double? Left { get; set; }

Property Value

double?

Opened

Gets or sets whether the outline item is opened (or expanded).

public bool Opened { get; set; }

Property Value

bool

Outlines

Gets the outline collection of this node.

public PdfOutlineCollection Outlines { get; }

Property Value

PdfOutlineCollection

PageDestinationType

Gets or sets the type of the page destination.

public PdfPageDestinationType PageDestinationType { get; set; }

Property Value

PdfPageDestinationType

Parent

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

public PdfOutline Parent { get; }

Property Value

PdfOutline

Right

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

public double Right { get; set; }

Property Value

double

Style

Gets or sets the style of the outline text.

public PdfOutlineStyle Style { get; set; }

Property Value

PdfOutlineStyle

TextColor

Gets or sets the color of the text.

public XColor TextColor { get; set; }

Property Value

XColor

The color of the text.

Title

Gets or sets the title.

public string Title { get; set; }

Property Value

string

Top

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

public double? Top { get; set; }

Property Value

double?

Zoom

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

public double? Zoom { get; set; }

Property Value

double?