Table of Contents

Class PdfOutline

Namespace
iTextSharp.text.pdf
Assembly
iTextSharp.LGPLv2.Core.dll

PdfOutline is an object that represents a PDF outline entry. An outline allows a user to access views of a document by name. This object is described in the 'Portable Document Format Reference Manual version 1.3' section 6.7 (page 104-106) @see PdfDictionary

public class PdfOutline : PdfDictionary
Inheritance
PdfOutline
Inherited Members

Constructors

PdfOutline(PdfOutline, PdfAction, string)

constructors

public PdfOutline(PdfOutline parent, PdfAction action, string title)

Parameters

parent PdfOutline
action PdfAction
title string

PdfOutline(PdfOutline, PdfAction, string, bool)

Constructs a PdfOutline . This is the constructor for an outline entry .

public PdfOutline(PdfOutline parent, PdfAction action, string title, bool open)

Parameters

parent PdfOutline

the parent of this outline item

action PdfAction

the PdfAction for this outline item

title string

the title of this outline item

open bool

true if the children are visible

PdfOutline(PdfOutline, PdfAction, Paragraph) 

public PdfOutline(PdfOutline parent, PdfAction action, Paragraph title)

Parameters

parent PdfOutline
action PdfAction
title Paragraph

PdfOutline(PdfOutline, PdfAction, Paragraph, bool)

Constructs a PdfOutline . This is the constructor for an outline entry .

public PdfOutline(PdfOutline parent, PdfAction action, Paragraph title, bool open)

Parameters

parent PdfOutline

the parent of this outline item

action PdfAction

the PdfAction for this outline item

title Paragraph

the title of this outline item

open bool

true if the children are visible

PdfOutline(PdfOutline, PdfAction, PdfString)

Constructs a PdfOutline . This is the constructor for an outline entry . The open mode is true .

public PdfOutline(PdfOutline parent, PdfAction action, PdfString title)

Parameters

parent PdfOutline

the parent of this outline item

action PdfAction

the PdfAction for this outline item

title PdfString

the title of this outline item

PdfOutline(PdfOutline, PdfAction, PdfString, bool)

Constructs a PdfOutline . This is the constructor for an outline entry .

public PdfOutline(PdfOutline parent, PdfAction action, PdfString title, bool open)

Parameters

parent PdfOutline

the parent of this outline item

action PdfAction

the PdfAction for this outline item

title PdfString

the title of this outline item

open bool

true if the children are visible

PdfOutline(PdfOutline, PdfDestination, string) 

public PdfOutline(PdfOutline parent, PdfDestination destination, string title)

Parameters

parent PdfOutline
destination PdfDestination
title string

PdfOutline(PdfOutline, PdfDestination, string, bool)

Constructs a PdfOutline . This is the constructor for an outline entry .

public PdfOutline(PdfOutline parent, PdfDestination destination, string title, bool open)

Parameters

parent PdfOutline

the parent of this outline item

destination PdfDestination

the destination for this outline item

title string

the title of this outline item

open bool

true if the children are visible

PdfOutline(PdfOutline, PdfDestination, Paragraph) 

public PdfOutline(PdfOutline parent, PdfDestination destination, Paragraph title)

Parameters

parent PdfOutline
destination PdfDestination
title Paragraph

PdfOutline(PdfOutline, PdfDestination, Paragraph, bool)

Constructs a PdfOutline . This is the constructor for an outline entry .

public PdfOutline(PdfOutline parent, PdfDestination destination, Paragraph title, bool open)

Parameters

parent PdfOutline

the parent of this outline item

destination PdfDestination

the destination for this outline item

title Paragraph

the title of this outline item

open bool

true if the children are visible

PdfOutline(PdfOutline, PdfDestination, PdfString) 

public PdfOutline(PdfOutline parent, PdfDestination destination, PdfString title)

Parameters

parent PdfOutline
destination PdfDestination
title PdfString

PdfOutline(PdfOutline, PdfDestination, PdfString, bool)

Constructs a PdfOutline . This is the constructor for an outline entry .

public PdfOutline(PdfOutline parent, PdfDestination destination, PdfString title, bool open)

Parameters

parent PdfOutline

the parent of this outline item

destination PdfDestination

the destination for this outline item

title PdfString

the title of this outline item

open bool

true if the children are visible

Fields

Writer 

protected PdfWriter Writer

Field Value

PdfWriter

kids

membervariables

protected IList<PdfOutline> kids

Field Value

IList<PdfOutline>

Properties

Color

methods

public BaseColor Color { get; set; }

Property Value

BaseColor

IndirectReference

the PdfIndirectReference of this object

public PdfIndirectReference IndirectReference { get; set; }

Property Value

PdfIndirectReference

Kids 

public IList<PdfOutline> Kids { get; set; }

Property Value

IList<PdfOutline>

Level 

public int Level { get; }

Property Value

int

Open

Setter for property open.

public bool Open { get; set; }

Property Value

bool

Parent

value of the Parent-key

public PdfOutline Parent { get; }

Property Value

PdfOutline

PdfDestination

Gets the destination for this outline.

public PdfDestination PdfDestination { get; }

Property Value

PdfDestination

the destination

Style

Holds value of property style.

public int Style { get; set; }

Property Value

int

Tag

Getter for property tag.

public string Tag { get; set; }

Property Value

string

Value of property tag.

Title 

public string Title { get; set; }

Property Value

string

Methods

AddKid(PdfOutline) 

public void AddKid(PdfOutline outline)

Parameters

outline PdfOutline

SetDestinationPage(PdfIndirectReference) 

public bool SetDestinationPage(PdfIndirectReference pageReference)

Parameters

pageReference PdfIndirectReference

Returns

bool

ToPdf(PdfWriter, Stream) 

public override void ToPdf(PdfWriter writer, Stream os)

Parameters

writer PdfWriter
os Stream